typegpu 0.11.9 → 0.12.0

package/data/alignmentOf.js

@@ -1,88 +1,103 @@
-import { isDecorated, isWgslArray, isWgslStruct } from "./wgslTypes.js";
 import { safeStringify } from "../shared/stringify.js";
-import { getCustomAlignment, isDisarray, isLooseDecorated, isUnstruct } from "./dataTypes.js";
+import { getCustomAlignment, isDisarray, isLooseDecorated, isUnstruct, } from "./dataTypes.js";
 import { packedFormats } from "./vertexFormatData.js";
-
-//#region src/data/alignmentOf.ts
+import { isDecorated, isWgslArray, isWgslStruct } from "./wgslTypes.js";
 const knownAlignmentMap = {
-	f32: 4,
-	f16: 2,
-	i32: 4,
-	u32: 4,
-	bool: 4,
-	u16: 2,
-	vec2f: 8,
-	vec2h: 4,
-	vec2i: 8,
-	vec2u: 8,
-	"vec2<bool>": 8,
-	vec3f: 16,
-	vec3h: 8,
-	vec3i: 16,
-	vec3u: 16,
-	"vec3<bool>": 16,
-	vec4f: 16,
-	vec4h: 8,
-	vec4i: 16,
-	vec4u: 16,
-	"vec4<bool>": 16,
-	mat2x2f: 8,
-	mat3x3f: 16,
-	mat4x4f: 16,
-	atomic: 4
+    f32: 4,
+    f16: 2,
+    i32: 4,
+    u32: 4,
+    bool: 4,
+    u16: 2,
+    vec2f: 8,
+    vec2h: 4,
+    vec2i: 8,
+    vec2u: 8,
+    'vec2<bool>': 8,
+    vec3f: 16,
+    vec3h: 8,
+    vec3i: 16,
+    vec3u: 16,
+    'vec3<bool>': 16,
+    vec4f: 16,
+    vec4h: 8,
+    vec4i: 16,
+    vec4u: 16,
+    'vec4<bool>': 16,
+    mat2x2f: 8,
+    mat3x3f: 16,
+    mat4x4f: 16,
+    atomic: 4,
 };
 function computeAlignment(data) {
-	const dataType = data?.type;
-	const knownAlignment = knownAlignmentMap[dataType];
-	if (knownAlignment !== void 0) return knownAlignment;
-	if (isWgslStruct(data)) return Object.values(data.propTypes).map(alignmentOf).reduce((a, b) => a > b ? a : b);
-	if (isWgslArray(data)) return alignmentOf(data.elementType);
-	if (isUnstruct(data)) {
-		const firstProp = Object.values(data.propTypes)[0];
-		return firstProp ? getCustomAlignment(firstProp) ?? 1 : 1;
-	}
-	if (isDisarray(data)) return getCustomAlignment(data.elementType) ?? 1;
-	if (isDecorated(data) || isLooseDecorated(data)) return getCustomAlignment(data) ?? alignmentOf(data.inner);
-	if (packedFormats.has(dataType)) return 1;
-	throw new Error(`Cannot determine alignment of data: ${safeStringify(data)}`);
+    const dataType = data?.type;
+    const knownAlignment = knownAlignmentMap[dataType];
+    if (knownAlignment !== undefined) {
+        return knownAlignment;
+    }
+    if (isWgslStruct(data)) {
+        return Object.values(data.propTypes)
+            .map(alignmentOf)
+            .reduce((a, b) => (a > b ? a : b));
+    }
+    if (isWgslArray(data)) {
+        return alignmentOf(data.elementType);
+    }
+    if (isUnstruct(data)) {
+        // A loose struct is aligned to its first property.
+        const firstProp = Object.values(data.propTypes)[0];
+        return firstProp ? (getCustomAlignment(firstProp) ?? 1) : 1;
+    }
+    if (isDisarray(data)) {
+        return getCustomAlignment(data.elementType) ?? 1;
+    }
+    if (isDecorated(data) || isLooseDecorated(data)) {
+        return getCustomAlignment(data) ?? alignmentOf(data.inner);
+    }
+    if (packedFormats.has(dataType)) {
+        return 1;
+    }
+    throw new Error(`Cannot determine alignment of data: ${safeStringify(data)}`);
 }
 function computeCustomAlignment(data) {
-	if (isUnstruct(data)) {
-		const firstProp = Object.values(data.propTypes)[0];
-		return firstProp ? customAlignmentOf(firstProp) : 1;
-	}
-	if (isDisarray(data)) return customAlignmentOf(data.elementType);
-	if (isLooseDecorated(data)) return getCustomAlignment(data) ?? customAlignmentOf(data.inner);
-	return getCustomAlignment(data) ?? 1;
+    if (isUnstruct(data)) {
+        // A loose struct is aligned to its first property.
+        const firstProp = Object.values(data.propTypes)[0];
+        return firstProp ? customAlignmentOf(firstProp) : 1;
+    }
+    if (isDisarray(data)) {
+        return customAlignmentOf(data.elementType);
+    }
+    if (isLooseDecorated(data)) {
+        return getCustomAlignment(data) ?? customAlignmentOf(data.inner);
+    }
+    return getCustomAlignment(data) ?? 1;
 }
 /**
-* Since alignments can be inferred from data types, they are not stored on them.
-* Instead, this weak map acts as an extended property of those data types.
-*/
-const cachedAlignments = /* @__PURE__ */ new WeakMap();
-const cachedCustomAlignments = /* @__PURE__ */ new WeakMap();
-function alignmentOf(data) {
-	let alignment = cachedAlignments.get(data);
-	if (alignment === void 0) {
-		alignment = computeAlignment(data);
-		cachedAlignments.set(data, alignment);
-	}
-	return alignment;
+ * Since alignments can be inferred from data types, they are not stored on them.
+ * Instead, this weak map acts as an extended property of those data types.
+ */
+const cachedAlignments = new WeakMap();
+const cachedCustomAlignments = new WeakMap();
+export function alignmentOf(data) {
+    let alignment = cachedAlignments.get(data);
+    if (alignment === undefined) {
+        alignment = computeAlignment(data);
+        cachedAlignments.set(data, alignment);
+    }
+    return alignment;
 }
-function customAlignmentOf(data) {
-	let alignment = cachedCustomAlignments.get(data);
-	if (alignment === void 0) {
-		alignment = computeCustomAlignment(data);
-		cachedCustomAlignments.set(data, alignment);
-	}
-	return alignment;
+export function customAlignmentOf(data) {
+    let alignment = cachedCustomAlignments.get(data);
+    if (alignment === undefined) {
+        alignment = computeCustomAlignment(data);
+        cachedCustomAlignments.set(data, alignment);
+    }
+    return alignment;
 }
 /**
-* Returns the alignment (in bytes) of data represented by the `schema`.
-*/
-function PUBLIC_alignmentOf(schema) {
-	return alignmentOf(schema);
+ * Returns the alignment (in bytes) of data represented by the `schema`.
+ */
+export function PUBLIC_alignmentOf(schema) {
+    return alignmentOf(schema);
 }
-
-//#endregion
-export { PUBLIC_alignmentOf, alignmentOf, customAlignmentOf };

package/data/array.d.ts

@@ -1,10 +1,8 @@
-import { AnyWgslData, WgslArray } from "./wgslTypes.js";
-import { TgpuComptime } from "../core/function/comptime.js";
-
-//#region src/data/array.d.ts
+import { type TgpuComptime } from '../core/function/comptime.ts';
+import type { AnyWgslData, WgslArray } from './wgslTypes.ts';
 interface WgslArrayConstructor {
-  <TElement extends AnyWgslData>(elementType: TElement): (elementCount: number) => WgslArray<TElement>;
-  <TElement extends AnyWgslData>(elementType: TElement, elementCount: number): WgslArray<TElement>;
+    <TElement extends AnyWgslData>(elementType: TElement): (elementCount: number) => WgslArray<TElement>;
+    <TElement extends AnyWgslData>(elementType: TElement, elementCount: number): WgslArray<TElement>;
 }
 /**
  * Creates an array schema that can be used to construct gpu buffers.
@@ -22,6 +20,5 @@ interface WgslArrayConstructor {
  * @param elementType The type of elements in the array.
  * @param elementCount The number of elements in the array.
  */
-declare const arrayOf: TgpuComptime<WgslArrayConstructor>;
-//#endregion
-export { arrayOf };
+export declare const arrayOf: TgpuComptime<WgslArrayConstructor>;
+export {};

package/data/array.js

@@ -1,48 +1,56 @@
+import { comptime } from "../core/function/comptime.js";
 import { $internal } from "../shared/symbols.js";
 import { schemaCallWrapper } from "./schemaCallWrapper.js";
 import { sizeOf } from "./sizeOf.js";
-import { comptime } from "../core/function/comptime.js";
-
-//#region src/data/array.ts
 /**
-* Creates an array schema that can be used to construct gpu buffers.
-* Describes arrays with fixed-size length, storing elements of the same type.
-*
-* @example
-* const LENGTH = 3;
-* const array = d.arrayOf(d.u32, LENGTH);
-*
-* If `elementCount` is not specified, a partially applied function is returned.
-* @example
-* const array = d.arrayOf(d.vec3f);
-* //    ^? (n: number) => WgslArray<d.Vec3f>
-*
-* @param elementType The type of elements in the array.
-* @param elementCount The number of elements in the array.
-*/
-const arrayOf = comptime(((elementType, elementCount) => {
-	if (elementCount === void 0) return comptime((count) => cpu_arrayOf(elementType, count));
-	return cpu_arrayOf(elementType, elementCount);
-})).$name("arrayOf");
+ * Creates an array schema that can be used to construct gpu buffers.
+ * Describes arrays with fixed-size length, storing elements of the same type.
+ *
+ * @example
+ * const LENGTH = 3;
+ * const array = d.arrayOf(d.u32, LENGTH);
+ *
+ * If `elementCount` is not specified, a partially applied function is returned.
+ * @example
+ * const array = d.arrayOf(d.vec3f);
+ * //    ^? (n: number) => WgslArray<d.Vec3f>
+ *
+ * @param elementType The type of elements in the array.
+ * @param elementCount The number of elements in the array.
+ */
+export const arrayOf = comptime(((elementType, elementCount) => {
+    if (elementCount === undefined) {
+        return comptime((count) => cpu_arrayOf(elementType, count));
+    }
+    return cpu_arrayOf(elementType, elementCount);
+})).$name('arrayOf');
+// --------------
+// Implementation
+// --------------
 function cpu_arrayOf(elementType, elementCount) {
-	const arraySchema = (elements) => {
-		if (elements && elements.length !== elementCount) throw new Error(`Array schema of ${elementCount} elements of type ${elementType.type} called with ${elements.length} argument(s).`);
-		return Array.from({ length: elementCount }, (_, i) => schemaCallWrapper(elementType, elements?.[i]));
-	};
-	Object.setPrototypeOf(arraySchema, WgslArrayImpl);
-	if (Number.isNaN(sizeOf(elementType))) throw new Error("Cannot nest runtime sized arrays.");
-	arraySchema.elementType = elementType;
-	if (!Number.isInteger(elementCount) || elementCount < 0) throw new Error(`Cannot create array schema with invalid element count: ${elementCount}.`);
-	arraySchema.elementCount = elementCount;
-	return arraySchema;
+    // In the schema call, create and return a deep copy
+    // by wrapping all the values in `elementType` schema calls.
+    const arraySchema = (elements) => {
+        if (elements && elements.length !== elementCount) {
+            throw new Error(`Array schema of ${elementCount} elements of type ${elementType.type} called with ${elements.length} argument(s).`);
+        }
+        return Array.from({ length: elementCount }, (_, i) => schemaCallWrapper(elementType, elements?.[i]));
+    };
+    Object.setPrototypeOf(arraySchema, WgslArrayImpl);
+    if (Number.isNaN(sizeOf(elementType))) {
+        throw new Error('Cannot nest runtime sized arrays.');
+    }
+    arraySchema.elementType = elementType;
+    if (!Number.isInteger(elementCount) || elementCount < 0) {
+        throw new Error(`Cannot create array schema with invalid element count: ${elementCount}.`);
+    }
+    arraySchema.elementCount = elementCount;
+    return arraySchema;
 }
 const WgslArrayImpl = {
-	[$internal]: true,
-	type: "array",
-	toString() {
-		return `arrayOf(${String(this.elementType)}, ${this.elementCount})`;
-	}
+    [$internal]: true,
+    type: 'array',
+    toString() {
+        return `arrayOf(${String(this.elementType)}, ${this.elementCount})`;
+    },
 };
-
-//#endregion
-export { arrayOf };

package/data/atomic.d.ts

@@ -1,7 +1,4 @@
-import { Atomic, I32, U32 } from "./wgslTypes.js";
-
-//#region src/data/atomic.d.ts
-
+import type { Atomic, I32, U32 } from './wgslTypes.ts';
 /**
  * Marks a concrete integer scalar type schema (u32 or i32) as a WGSL atomic.
  *
@@ -11,6 +8,4 @@ import { Atomic, I32, U32 } from "./wgslTypes.js";
  *
  * @param data Underlying type schema.
  */
-declare function atomic<TSchema extends U32 | I32>(data: TSchema): Atomic<TSchema>;
-//#endregion
-export { atomic };
+export declare function atomic<TSchema extends U32 | I32>(data: TSchema): Atomic<TSchema>;

package/data/atomic.js

@@ -1,26 +1,29 @@
 import { $internal } from "../shared/symbols.js";
-
-//#region src/data/atomic.ts
+import { $gpuRepr, $memIdent, $repr, $validStorageSchema, $validUniformSchema, $validVertexSchema, } from "../shared/symbols.js";
+// ----------
+// Public API
+// ----------
 /**
-* Marks a concrete integer scalar type schema (u32 or i32) as a WGSL atomic.
-*
-* @example
-* const atomicU32 = d.atomic(d.u32);
-* const atomicI32 = d.atomic(d.i32);
-*
-* @param data Underlying type schema.
-*/
-function atomic(data) {
-	return new AtomicImpl(data);
+ * Marks a concrete integer scalar type schema (u32 or i32) as a WGSL atomic.
+ *
+ * @example
+ * const atomicU32 = d.atomic(d.u32);
+ * const atomicI32 = d.atomic(d.i32);
+ *
+ * @param data Underlying type schema.
+ */
+export function atomic(data) {
+    return new AtomicImpl(data);
+}
+// --------------
+// Implementation
+// --------------
+class AtomicImpl {
+    [$internal] = {};
+    type = 'atomic';
+    inner;
+    // ---
+    constructor(inner) {
+        this.inner = inner;
+    }
 }
-var AtomicImpl = class {
-	[$internal] = {};
-	type = "atomic";
-	inner;
-	constructor(inner) {
-		this.inner = inner;
-	}
-};
-
-//#endregion
-export { atomic };

package/data/attributes.d.ts

@@ -1,12 +1,10 @@
-import { Align, AnyWgslData, BaseData, Builtin, Decorated, FlatInterpolatableData, FlatInterpolationType, Interpolate, Invariant, IsWgslData, Location, PerspectiveOrLinearInterpolatableData, PerspectiveOrLinearInterpolationType, Size, Vec4f } from "./wgslTypes.js";
-import { AnyData, AnyLooseData, IsLooseData, LooseDecorated, Undecorate } from "./dataTypes.js";
-
-//#region src/data/attributes.d.ts
-declare const builtinNames: readonly ["vertex_index", "instance_index", "clip_distances", "position", "front_facing", "frag_depth", "primitive_index", "sample_index", "sample_mask", "fragment", "local_invocation_id", "local_invocation_index", "global_invocation_id", "global_invocation_index", "workgroup_id", "workgroup_index", "num_workgroups", "subgroup_invocation_id", "subgroup_size", "subgroup_id", "num_subgroups"];
-type BuiltinName = (typeof builtinNames)[number];
-type AnyAttribute<AllowedBuiltins extends Builtin<BuiltinName> = Builtin<BuiltinName>> = Align<number> | Size<number> | Location | Interpolate | Invariant | AllowedBuiltins;
-type ExtractAttributes<T> = T extends {
-  readonly attribs: unknown[];
+import { type AnyData, type AnyLooseData, type IsLooseData, type LooseDecorated, type Undecorate } from './dataTypes.ts';
+import { type Align, type AnyWgslData, type BaseData, type Builtin, type Decorated, type FlatInterpolatableData, type FlatInterpolationType, type Interpolate, type Invariant, type IsWgslData, type Location, type PerspectiveOrLinearInterpolatableData, type PerspectiveOrLinearInterpolationType, type Size, type Vec4f } from './wgslTypes.ts';
+export declare const builtinNames: readonly ["vertex_index", "instance_index", "clip_distances", "position", "front_facing", "frag_depth", "primitive_index", "sample_index", "sample_mask", "fragment", "local_invocation_id", "local_invocation_index", "global_invocation_id", "global_invocation_index", "workgroup_id", "workgroup_index", "num_workgroups", "subgroup_invocation_id", "subgroup_size", "subgroup_id", "num_subgroups"];
+export type BuiltinName = (typeof builtinNames)[number];
+export type AnyAttribute<AllowedBuiltins extends Builtin<BuiltinName> = Builtin<BuiltinName>> = Align<number> | Size<number> | Location | Interpolate | Invariant | AllowedBuiltins;
+export type ExtractAttributes<T> = T extends {
+    readonly attribs: unknown[];
 } ? T['attribs'] : [];
 /**
  * Decorates a data-type `TData` with an attribute `TAttrib`.
@@ -22,9 +20,10 @@ type ExtractAttributes<T> = T extends {
  *   - else
  *     - Wrap `TData` with `Decorated` and a single attribute `[TAttrib]`
  */
-type Decorate<TData extends BaseData, TAttrib extends AnyAttribute> = IsWgslData<TData> extends true ? Decorated<Undecorate<TData>, [TAttrib, ...ExtractAttributes<TData>]> : IsLooseData<TData> extends true ? LooseDecorated<Undecorate<TData>, [TAttrib, ...ExtractAttributes<TData>]> : never;
-type IsBuiltin<T> = ExtractAttributes<T>[number] extends [] ? false : ExtractAttributes<T>[number] extends Builtin<BuiltinName> ? true : false;
-type HasCustomLocation<T> = ExtractAttributes<T>[number] extends [] ? false : ExtractAttributes<T>[number] extends Location ? true : false;
+export type Decorate<TData extends BaseData, TAttrib extends AnyAttribute> = IsWgslData<TData> extends true ? Decorated<Undecorate<TData>, [TAttrib, ...ExtractAttributes<TData>]> : IsLooseData<TData> extends true ? LooseDecorated<Undecorate<TData>, [TAttrib, ...ExtractAttributes<TData>]> : never;
+export type IsBuiltin<T> = ExtractAttributes<T>[number] extends [] ? false : ExtractAttributes<T>[number] extends Builtin<BuiltinName> ? true : false;
+export type HasCustomLocation<T> = ExtractAttributes<T>[number] extends [] ? false : ExtractAttributes<T>[number] extends Location ? true : false;
+export declare function attribute(data: BaseData, attrib: AnyAttribute): Decorated | LooseDecorated;
 /**
  * Gives the wrapped data-type a custom byte alignment. Useful in order to
  * fulfill uniform alignment requirements.
@@ -39,7 +38,7 @@ type HasCustomLocation<T> = ExtractAttributes<T>[number] extends [] ? false : Ex
  * @param alignment The multiple of bytes this data should align itself to.
  * @param data The data-type to align.
  */
-declare function align<TAlign extends number, TData extends AnyData>(alignment: TAlign, data: TData): Decorate<TData, Align<TAlign>>;
+export declare function align<TAlign extends number, TData extends AnyData>(alignment: TAlign, data: TData): Decorate<TData, Align<TAlign>>;
 /**
  * Adds padding bytes after the wrapped data-type, until the whole value takes up `size` bytes.
  *
@@ -52,7 +51,7 @@ declare function align<TAlign extends number, TData extends AnyData>(alignment:
  * @param size The amount of bytes that should be reserved for this data-type.
  * @param data The data-type to wrap.
  */
-declare function size<TSize extends number, TData extends AnyData>(size: TSize, data: TData): Decorate<TData, Size<TSize>>;
+export declare function size<TSize extends number, TData extends AnyData>(size: TSize, data: TData): Decorate<TData, Size<TSize>>;
 /**
  * Assigns an explicit numeric location to a struct member or a parameter that has this type.
  *
@@ -66,7 +65,7 @@ declare function size<TSize extends number, TData extends AnyData>(size: TSize,
  * @param location The explicit numeric location.
  * @param data The data-type to wrap.
  */
-declare function location<TLocation extends number, TData extends BaseData>(location: TLocation, data: TData): Decorate<TData, Location<TLocation>>;
+export declare function location<TLocation extends number, TData extends BaseData>(location: TLocation, data: TData): Decorate<TData, Location<TLocation>>;
 /**
  * Specifies how user-defined vertex shader output (fragment shader input)
  * must be interpolated.
@@ -82,7 +81,7 @@ declare function location<TLocation extends number, TData extends BaseData>(loca
  * @param interpolationType How data should be interpolated.
  * @param data The data-type to wrap.
  */
-declare function interpolate<TInterpolation extends PerspectiveOrLinearInterpolationType, TData extends PerspectiveOrLinearInterpolatableData>(interpolationType: TInterpolation, data: TData): Decorate<TData, Interpolate<TInterpolation>>;
+export declare function interpolate<TInterpolation extends PerspectiveOrLinearInterpolationType, TData extends PerspectiveOrLinearInterpolatableData>(interpolationType: TInterpolation, data: TData): Decorate<TData, Interpolate<TInterpolation>>;
 /**
  * Specifies how user-defined vertex shader output (fragment shader input)
  * must be interpolated.
@@ -100,7 +99,7 @@ declare function interpolate<TInterpolation extends PerspectiveOrLinearInterpola
  * @param interpolationType How data should be interpolated.
  * @param data The data-type to wrap.
  */
-declare function interpolate<TInterpolation extends FlatInterpolationType, TData extends FlatInterpolatableData>(interpolationType: TInterpolation, data: TData): Decorate<TData, Interpolate<TInterpolation>>;
+export declare function interpolate<TInterpolation extends FlatInterpolationType, TData extends FlatInterpolatableData>(interpolationType: TInterpolation, data: TData): Decorate<TData, Interpolate<TInterpolation>>;
 /**
  * Marks a position built-in output value as invariant in vertex shaders.
  * If the data and control flow match for two position outputs in different
@@ -115,7 +114,6 @@ declare function interpolate<TInterpolation extends FlatInterpolationType, TData
  *
  * @param data The position built-in data-type to mark as invariant.
  */
-declare function invariant(data: Decorated<Vec4f, [Builtin<'position'>]>): Decorated<Vec4f, [Builtin<'position'>, Invariant]>;
-declare function isBuiltin(value: unknown): value is Decorated<AnyWgslData, AnyAttribute[]> | LooseDecorated<AnyLooseData, AnyAttribute[]>;
-//#endregion
-export { AnyAttribute, Decorate, HasCustomLocation, IsBuiltin, align, interpolate, invariant, isBuiltin, location, size };
+export declare function invariant(data: Decorated<Vec4f, [Builtin<'position'>]>): Decorated<Vec4f, [Builtin<'position'>, Invariant]>;
+export declare function isBuiltin(value: unknown): value is Decorated<AnyWgslData, AnyAttribute[]> | LooseDecorated<AnyLooseData, AnyAttribute[]>;
+export declare function getAttributesString<T extends BaseData>(field: T): string;