typegpu 0.11.8 → 0.12.0

package/data/snippet.js

@@ -1,99 +1,88 @@
+import { undecorate } from "./dataTypes.js";
 import { DEV } from "../shared/env.js";
 import { isNumericSchema } from "./wgslTypes.js";
-import { undecorate } from "./dataTypes.js";
-
-//#region src/data/snippet.ts
 /**
-* What happens to a snippet's origin when it's deep copied in JS, and left as is in WGSL?
-* e.g. `vec3f(vec3f(0, 1, 2))`
-*/
-function fallthroughCopyOrigin(origin) {
-	if (origin === "runtime" || origin === "constant") return origin;
-	return "runtime";
+ * What happens to a snippet's origin when it's deep copied in JS, and left as is in WGSL?
+ * e.g. `vec3f(vec3f(0, 1, 2))`
+ */
+export function fallthroughCopyOrigin(origin) {
+    if (origin === 'runtime' || // runtime values stay runtime
+        origin === 'constant' // constant values stay constant
+    ) {
+        // The origin is kept as-is
+        return origin;
+    }
+    // All other origins become runtime
+    return 'runtime';
 }
 /**
-* Whether a snippet aliases a value that lives outside the current expression.
-*
-* @example
-* ```ts
-* function foo(a: number) {
-*   const color = d.vec3f(1, 2, 3);
-*   return color * a;
-* }
-*
-* // References:
-* // -  color
-* // -  a
-* //
-* // Not references:
-* // - d.vec3f(1, 2, 3)
-* // - color * a
-* ```
-*/
-function isAlias(snippet) {
-	return !(snippet.origin === "runtime" || snippet.origin === "constant");
+ * Whether a snippet aliases a value that lives outside the current expression.
+ *
+ * @example
+ * ```ts
+ * function foo(a: number) {
+ *   const color = d.vec3f(1, 2, 3);
+ *   return color * a;
+ * }
+ *
+ * // References:
+ * // -  color
+ * // -  a
+ * //
+ * // Not references:
+ * // - d.vec3f(1, 2, 3)
+ * // - color * a
+ * ```
+ */
+export function isAlias(snippet) {
+    return !(snippet.origin === 'runtime' || snippet.origin === 'constant');
 }
-const originToPtrParams = {
-	uniform: {
-		space: "uniform",
-		access: "read"
-	},
-	readonly: {
-		space: "storage",
-		access: "read"
-	},
-	mutable: {
-		space: "storage",
-		access: "read-write"
-	},
-	workgroup: {
-		space: "workgroup",
-		access: "read-write"
-	},
-	private: {
-		space: "private",
-		access: "read-write"
-	},
-	function: {
-		space: "function",
-		access: "read-write"
-	},
-	"local-def": {
-		space: "function",
-		access: "read-write"
-	}
-};
-var SnippetImpl = class {
-	value;
-	dataType;
-	origin;
-	possibleSideEffects;
-	constructor(value, dataType, origin, possibleSideEffects) {
-		this.value = value;
-		this.dataType = dataType;
-		this.origin = origin;
-		this.possibleSideEffects = possibleSideEffects;
-	}
+export const originToPtrParams = {
+    uniform: { space: 'uniform', access: 'read' },
+    readonly: { space: 'storage', access: 'read' },
+    mutable: { space: 'storage', access: 'read-write' },
+    workgroup: { space: 'workgroup', access: 'read-write' },
+    private: { space: 'private', access: 'read-write' },
+    function: { space: 'function', access: 'read-write' },
+    // Local declarations are also in the `function` address space
+    'local-def': { space: 'function', access: 'read-write' },
 };
-function isSnippet(value) {
-	return value instanceof SnippetImpl;
+class SnippetImpl {
+    value;
+    dataType;
+    origin;
+    possibleSideEffects;
+    constructor(value, dataType, origin, possibleSideEffects) {
+        this.value = value;
+        this.dataType = dataType;
+        this.origin = origin;
+        this.possibleSideEffects = possibleSideEffects;
+    }
+}
+export function isSnippet(value) {
+    return value instanceof SnippetImpl;
+}
+export function isSnippetNumeric(snippet) {
+    return isNumericSchema(snippet.dataType);
 }
-function isSnippetNumeric(snippet) {
-	return isNumericSchema(snippet.dataType);
+export function snip(value, dataType, origin, possibleSideEffects = true) {
+    if (DEV && isSnippet(value)) {
+        // An early error, but not worth checking every time in production
+        throw new Error('Cannot nest snippets');
+    }
+    return new SnippetImpl(value, 
+    // We don't care about attributes in snippet land, so we discard that information.
+    undecorate(dataType), origin, possibleSideEffects);
 }
-function snip(value, dataType, origin, possibleSideEffects = true) {
-	if (DEV && isSnippet(value)) throw new Error("Cannot nest snippets");
-	return new SnippetImpl(value, undecorate(dataType), origin, possibleSideEffects);
+export function withDataType(dataType, snippet) {
+    return new SnippetImpl(snippet.value, dataType, snippet.origin, snippet.possibleSideEffects);
 }
-function withDataType(dataType, snippet) {
-	return new SnippetImpl(snippet.value, dataType, snippet.origin, snippet.possibleSideEffects);
+export function withValue(value, snippet) {
+    return new SnippetImpl(value, snippet.dataType, snippet.origin, snippet.possibleSideEffects);
 }
-function withSideEffects(possibleSideEffects, snippet) {
-	return new SnippetImpl(snippet.value, snippet.dataType, snippet.origin, possibleSideEffects);
+export function withSideEffects(possibleSideEffects, snippet) {
+    return new SnippetImpl(snippet.value, snippet.dataType, snippet.origin, possibleSideEffects);
 }
-function noSideEffects(snippet) {
-	return withSideEffects(false, snippet);
+export function noSideEffects(snippet) {
+    return withSideEffects(/* possibleSideEffects */ false, snippet);
 }
-
-//#endregion
-export { fallthroughCopyOrigin, isAlias, isSnippet, isSnippetNumeric, noSideEffects, originToPtrParams, snip, withDataType };

package/data/struct.d.ts

@@ -1,7 +1,4 @@
-import { AnyWgslData, WgslStruct } from "./wgslTypes.js";
-
-//#region src/data/struct.d.ts
-
+import type { AnyWgslData, BaseData, WgslStruct } from './wgslTypes.ts';
 /**
  * Creates a struct schema that can be used to construct GPU buffers.
  * Ensures proper alignment and padding of properties (as opposed to a `d.unstruct` schema).
@@ -13,6 +10,6 @@ import { AnyWgslData, WgslStruct } from "./wgslTypes.js";
  * @param props Record with `string` keys and `TgpuData` values,
  * each entry describing one struct member.
  */
-declare function struct<TProps extends Record<string, AnyWgslData>>(props: TProps): WgslStruct<TProps>;
-//#endregion
-export { struct };
+export declare function struct<TProps extends Record<string, AnyWgslData>>(props: TProps): WgslStruct<TProps>;
+export declare function abstruct<TProps extends Record<string, AnyWgslData>>(props: TProps): WgslStruct<TProps>;
+export declare function INTERNAL_createStruct<TProps extends Record<string, BaseData>>(props: TProps, isAbstruct: boolean): WgslStruct<TProps>;

package/data/struct.js

@@ -1,47 +1,59 @@
-import { $internal } from "../shared/symbols.js";
+import { validateProp } from "../nameUtils.js";
 import { getName, setName } from "../shared/meta.js";
+import { $internal } from "../shared/symbols.js";
 import { schemaCallWrapper } from "./schemaCallWrapper.js";
-import { validateProp } from "../nameUtils.js";
-
-//#region src/data/struct.ts
+// ----------
+// Public API
+// ----------
 /**
-* Creates a struct schema that can be used to construct GPU buffers.
-* Ensures proper alignment and padding of properties (as opposed to a `d.unstruct` schema).
-* The order of members matches the passed in properties object.
-*
-* @example
-* const CircleStruct = d.struct({ radius: d.f32, pos: d.vec3f });
-*
-* @param props Record with `string` keys and `TgpuData` values,
-* each entry describing one struct member.
-*/
-function struct(props) {
-	return INTERNAL_createStruct(props, false);
+ * Creates a struct schema that can be used to construct GPU buffers.
+ * Ensures proper alignment and padding of properties (as opposed to a `d.unstruct` schema).
+ * The order of members matches the passed in properties object.
+ *
+ * @example
+ * const CircleStruct = d.struct({ radius: d.f32, pos: d.vec3f });
+ *
+ * @param props Record with `string` keys and `TgpuData` values,
+ * each entry describing one struct member.
+ */
+export function struct(props) {
+    return INTERNAL_createStruct(props, false);
 }
-function abstruct(props) {
-	return INTERNAL_createStruct(props, true);
+export function abstruct(props) {
+    return INTERNAL_createStruct(props, true);
 }
-function INTERNAL_createStruct(props, isAbstruct) {
-	Object.keys(props).forEach((key) => {
-		const result = /* @__PURE__ */ validateProp(key);
-		if (!result.success) throw new Error(`Invalid property key '${key}'${result.error ? `: ${result.error}` : ""}`);
-	});
-	const structSchema = (instanceProps) => Object.fromEntries(Object.entries(props).map(([key, schema]) => [key, schemaCallWrapper(schema, instanceProps?.[key])]));
-	Object.setPrototypeOf(structSchema, WgslStructImpl);
-	structSchema.propTypes = props;
-	Object.defineProperty(structSchema, $internal, { value: { isAbstruct } });
-	return structSchema;
+// --------------
+// Implementation
+// --------------
+export function INTERNAL_createStruct(props, isAbstruct) {
+    Object.keys(props).forEach((key) => {
+        const result = validateProp(key);
+        if (!result.success) {
+            throw new Error(`Invalid property key '${key}'${result.error ? `: ${result.error}` : ''}`);
+        }
+    });
+    // In the schema call, create and return a deep copy
+    // by wrapping all the values in corresponding schema calls.
+    const structSchema = (instanceProps) => Object.fromEntries(Object.entries(props).map(([key, schema]) => [
+        key,
+        schemaCallWrapper(schema, instanceProps?.[key]),
+    ]));
+    Object.setPrototypeOf(structSchema, WgslStructImpl);
+    structSchema.propTypes = props;
+    Object.defineProperty(structSchema, $internal, {
+        value: {
+            isAbstruct,
+        },
+    });
+    return structSchema;
 }
 const WgslStructImpl = {
-	type: "struct",
-	$name(label) {
-		setName(this, label);
-		return this;
-	},
-	toString() {
-		return `struct:${getName(this) ?? "<unnamed>"}`;
-	}
+    type: 'struct',
+    $name(label) {
+        setName(this, label);
+        return this;
+    },
+    toString() {
+        return `struct:${getName(this) ?? '<unnamed>'}`;
+    },
 };
-
-//#endregion
-export { INTERNAL_createStruct, abstruct, struct };