typegpu 0.3.0 → 0.3.2

package/data/index.d.cts

@@ -1,329 +1,2 @@
-import { J as BaseWgslData, W as WgslStruct, K as TgpuNamable, M as ExoticRecord, e as AnyWgslData, P as Prettify, N as WgslArray, E as Exotic, A as AnyData, Q as Disarray, R as Unstruct, X as m2x2f, Y as m3x3f, Z as m4x4f, _ as Mat2x2f, $ as v2f, a0 as Mat3x3f, a1 as v3f, a2 as Mat4x4f, a3 as v4f, a4 as U32, a5 as I32, a6 as Atomic, a7 as Align, a8 as Size, a9 as Location, aa as Builtin, ab as Decorated, ac as LooseDecorated, ad as AnyLooseData, ae as WgslTypeLiteral, af as LooseTypeLiteral, ag as Vec4f, ah as F32, ai as Vec3u, I as Infer$1 } from '../wgslTypes-BsqIvRBG.cjs';
-export { ax as Bool, ay as F16, b4 as FormatToWGSLType, bM as PackedData, b5 as TgpuVertexFormatData, az as Vec2f, aA as Vec2h, aB as Vec2i, aC as Vec2u, aD as Vec3f, aE as Vec3h, aF as Vec3i, aG as Vec4h, aH as Vec4i, aI as Vec4u, aj as bool, al as f16, ak as f32, bv as float16, bw as float16x2, bx as float16x4, by as float32, bz as float32x2, bA as float32x3, bB as float32x4, am as i32, at as isAlignAttrib, ar as isAtomic, au as isBuiltinAttrib, b2 as isData, as as isDecorated, a$ as isDisarray, av as isLocationAttrib, b3 as isLooseData, b1 as isLooseDecorated, aw as isSizeAttrib, b0 as isUnstruct, ap as isWgslArray, ao as isWgslData, aq as isWgslStruct, b6 as packedFormats, bm as sint16, bn as sint16x2, bo as sint16x4, bG as sint32, bH as sint32x2, bI as sint32x3, bJ as sint32x4, ba as sint8, bb as sint8x2, bc as sint8x4, bs as snorm16, bt as snorm16x2, bu as snorm16x4, bg as snorm8, bh as snorm8x2, bi as snorm8x4, an as u32, bj as uint16, bk as uint16x2, bl as uint16x4, bC as uint32, bD as uint32x2, bE as uint32x3, bF as uint32x4, b7 as uint8, b8 as uint8x2, b9 as uint8x4, bK as unorm10_10_10_2, bp as unorm16, bq as unorm16x2, br as unorm16x4, bd as unorm8, be as unorm8x2, bf as unorm8x4, bL as unorm8x4_bgra, aJ as v2i, aK as v2u, aL as v3i, aM as v3u, aN as v4i, aO as v4u, aP as vec2f, aQ as vec2h, aR as vec2i, aS as vec2u, aT as vec3f, aU as vec3h, aV as vec3i, aW as vec3u, aX as vec4f, aY as vec4h, aZ as vec4i, a_ as vec4u } from '../wgslTypes-BsqIvRBG.cjs';
-import 'tinyest';
-
-/**
- * Struct schema constructed via `d.struct` function.
- *
- * Responsible for handling reading and writing struct values
- * between binary and JS representation. Takes into account
- * the `byteAlignment` requirement of its members.
- */
-interface TgpuStruct<TProps extends Record<string, BaseWgslData>> extends WgslStruct<TProps>, TgpuNamable {
-    readonly '~exotic': WgslStruct<ExoticRecord<TProps>>;
-}
-/**
- * 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.
- */
-declare const struct: <TProps extends Record<string, AnyWgslData>>(props: TProps) => TgpuStruct<Prettify<ExoticRecord<TProps>>>;
-
-/**
- * Array schema constructed via `d.arrayOf` function.
- *
- * Responsible for handling reading and writing array values
- * between binary and JS representation. Takes into account
- * the `byteAlignment` requirement of its elementType.
- */
-interface TgpuArray<TElement extends AnyWgslData> extends WgslArray<TElement> {
-    readonly '~exotic': WgslArray<Exotic<TElement>>;
-}
-/**
- * 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);
- *
- * @param elementType The type of elements in the array.
- * @param elementCount The number of elements in the array.
- */
-declare const arrayOf: <TElement extends AnyWgslData>(elementType: TElement, elementCount: number) => TgpuArray<Exotic<TElement>>;
-
-/**
- * Creates an array schema that can be used to construct vertex buffers.
- * Describes arrays with fixed-size length, storing elements of the same type.
- *
- * Elements in the schema are not aligned in respect to their `byteAlignment`,
- * unless they are explicitly decorated with the custom align attribute
- * via `d.align` function.
- *
- * @example
- * const disarray = d.disarrayOf(d.vec3f, 3); // packed array of vec3f
- *
- * @example
- * const disarray = d.disarrayOf(d.align(16, d.vec3f), 3);
- *
- * @param elementType The type of elements in the array.
- * @param count The number of elements in the array.
- */
-declare const disarrayOf: <TElement extends AnyData>(elementType: TElement, count: number) => Disarray<Exotic<TElement>>;
-
-/**
- * Creates a loose struct schema that can be used to construct vertex buffers.
- * Describes structs with members of both loose and non-loose types.
- *
- * The order of members matches the passed in properties object.
- * Members are not aligned in respect to their `byteAlignment`,
- * unless they are explicitly decorated with the custom align attribute
- * via `d.align` function.
- *
- * @example
- * const CircleStruct = d.unstruct({ radius: d.f32, pos: d.vec3f }); // packed struct with no padding
- *
- * @example
- * const CircleStruct = d.unstruct({ radius: d.f32, pos: d.align(16, d.vec3f) });
- *
- * @param properties Record with `string` keys and `TgpuData` or `TgpuLooseData` values,
- * each entry describing one struct member.
- */
-declare const unstruct: <TProps extends Record<string, BaseWgslData>>(properties: TProps) => Unstruct<ExoticRecord<TProps>>;
-
-/**
- * Type of the `d.mat2x2f` object/function: matrix data type schema/constructor
- */
-type NativeMat2x2f = Mat2x2f & {
-    '~exotic': Mat2x2f;
-} & ((...elements: number[]) => m2x2f) & ((...columns: v2f[]) => m2x2f) & (() => m2x2f);
-/**
- *
- * Schema representing mat2x2f - a matrix with 2 rows and 2 columns, with elements of type f32.
- * Also a constructor function for this matrix type.
- *
- * @example
- * const zero2x2 = mat2x2f(); // filled with zeros
- *
- * @example
- * const mat = mat2x2f(0, 1, 2, 3);
- * mat[0] // vec2f(0, 1)
- * mat[1] // vec2f(2, 3)
- *
- * @example
- * const mat = mat2x2f(
- *  vec2f(0, 1), // column 0
- *  vec2f(1, 2), // column 1
- * );
- *
- * @example
- * const buffer = root.createBuffer(d.mat2x2f, d.mat2x2f(0, 1, 2, 3)); // buffer holding a d.mat2x2f value, with an initial value of ((0, 1), (2, 3))
- */
-declare const mat2x2f: NativeMat2x2f;
-/**
- * Type of the `d.mat3x3f` object/function: matrix data type schema/constructor
- */
-type NativeMat3x3f = Mat3x3f & {
-    '~exotic': Mat3x3f;
-} & ((...elements: number[]) => m3x3f) & ((...columns: v3f[]) => m3x3f) & (() => m3x3f);
-/**
- *
- * Schema representing mat3x3f - a matrix with 3 rows and 3 columns, with elements of type f32.
- * Also a constructor function for this matrix type.
- *
- * @example
- * const zero3x3 = mat3x3f(); // filled with zeros
- *
- * @example
- * const mat = mat3x3f(0, 1, 2, 3, 4, 5, 6, 7, 8);
- * mat[0] // vec3f(0, 1, 2)
- * mat[1] // vec3f(3, 4, 5)
- * mat[2] // vec3f(6, 7, 8)
- *
- * @example
- * const mat = mat3x3f(
- *  vec3f(0, 1, 2), // column 0
- *  vec3f(2, 3, 4), // column 1
- *  vec3f(5, 6, 7), // column 2
- * );
- *
- * @example
- * const buffer = root.createBuffer(d.mat3x3f, d.mat3x3f()); // buffer holding a d.mat3x3f value, with an initial value of mat3x3f filled with zeros
- */
-declare const mat3x3f: NativeMat3x3f;
-/**
- * Type of the `d.mat4x4f` object/function: matrix data type schema/constructor
- */
-type NativeMat4x4f = Mat4x4f & {
-    '~exotic': Mat4x4f;
-} & ((...elements: number[]) => m4x4f) & ((...columns: v4f[]) => m4x4f) & (() => m4x4f);
-/**
- *
- * Schema representing mat4x4f - a matrix with 4 rows and 4 columns, with elements of type f32.
- * Also a constructor function for this matrix type.
- *
- * @example
- * const zero4x4 = mat4x4f(); // filled with zeros
- *
- * @example
- * const mat = mat3x3f(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15);
- * mat[0] // vec4f(0, 1, 2, 3)
- * mat[1] // vec4f(4, 5, 6, 7)
- * mat[2] // vec4f(8, 9, 10, 11)
- * mat[3] // vec4f(12, 13, 14, 15)
- *
- * @example
- * const mat = mat3x3f(
- *  vec4f(0, 1, 2, 3),     // column 0
- *  vec4f(4, 5, 6, 7),     // column 1
- *  vec4f(8, 9, 10, 11),   // column 2
- *  vec4f(12, 13, 14, 15), // column 3
- * );
- *
- * @example
- * const buffer = root.createBuffer(d.mat4x4f, d.mat4x4f()); // buffer holding a d.mat4x4f value, with an initial value of mat4x4f filled with zeros
- */
-declare const mat4x4f: NativeMat4x4f;
-declare function matToArray(mat: m2x2f | m3x3f | m4x4f): number[];
-
-/**
- * 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.
- */
-declare function atomic<TSchema extends U32 | I32>(data: TSchema): Atomic<Exotic<TSchema>>;
-
-declare const builtinNames: readonly ["vertex_index", "instance_index", "position", "clip_distances", "front_facing", "frag_depth", "sample_index", "sample_mask", "fragment", "local_invocation_id", "local_invocation_index", "global_invocation_id", "workgroup_id", "num_workgroups"];
-type BuiltinName = (typeof builtinNames)[number];
-type AnyAttribute = Align<number> | Size<number> | Location<number> | Builtin<BuiltinName>;
-type ExtractAttributes<T> = T extends {
-    readonly attribs: unknown[];
-} ? T['attribs'] : [];
-type Undecorate<T> = T extends {
-    readonly inner: infer TInner;
-} ? TInner : T;
-/**
- * Decorates a data-type `TData` with an attribute `TAttrib`.
- *
- * - if `TData` is loose
- *   - if `TData` is already `LooseDecorated`
- *     - Prepend `TAttrib` to the existing attribute tuple.
- *   - else
- *     - Wrap `TData` with `LooseDecorated` and a single attribute `[TAttrib]`
- * - else
- *   - if `TData` is already `Decorated`
- *     - Prepend `TAttrib` to the existing attribute tuple.
- *   - else
- *     - Wrap `TData` with `Decorated` and a single attribute `[TAttrib]`
- */
-type Decorate<TData extends BaseWgslData, TAttrib extends AnyAttribute> = TData['type'] extends WgslTypeLiteral ? Decorated<Undecorate<TData>, [TAttrib, ...ExtractAttributes<TData>]> : TData['type'] extends LooseTypeLiteral ? 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<number> ? true : false;
-/**
- * Gives the wrapped data-type a custom byte alignment. Useful in order to
- * fulfill uniform alignment requirements.
- *
- * @example
- * const Data = d.struct({
- *   a: u32, // takes up 4 bytes
- *   // 12 bytes of padding, because `b` is custom aligned to multiples of 16 bytes
- *   b: d.align(16, u32),
- * });
- *
- * @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<Exotic<TData>, Align<TAlign>>;
-/**
- * Adds padding bytes after the wrapped data-type, until the whole value takes up `size` bytes.
- *
- * @example
- * const Data = d.struct({
- *   a: d.size(16, u32), // takes up 16 bytes, instead of 4
- *   b: u32, // starts at byte 16, because `a` has a custom size
- * });
- *
- * @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<Exotic<TData>, Size<TSize>>;
-/**
- * Assigns an explicit numeric location to a struct member or a parameter that has this type.
- *
- * @example
- * const Data = d.ioStruct({
- *   a: d.u32, // has implicit location 0
- *   b: d.location(5, d.u32),
- *   c: d.u32, // has implicit location 6
- * });
- *
- * @param location The explicit numeric location.
- * @param data The data-type to wrap.
- */
-declare function location<TLocation extends number, TData extends AnyData>(location: TLocation, data: TData): Decorate<Exotic<TData>, Location<TLocation>>;
-declare function isBuiltin<T extends Decorated<AnyWgslData, AnyAttribute[]> | LooseDecorated<AnyLooseData, AnyAttribute[]>>(value: T | unknown): value is T;
-
-/**
- * Returns the size (in bytes) of data represented by the `schema`.
- */
-declare function PUBLIC_sizeOf(schema: AnyData): number;
-
-/**
- * Returns the alignment (in bytes) of data represented by the `schema`.
- */
-declare function PUBLIC_alignmentOf(schema: AnyData): number;
-
-type BuiltinVertexIndex = Decorated<U32, [Builtin<'vertex_index'>]>;
-type BuiltinInstanceIndex = Decorated<U32, [Builtin<'instance_index'>]>;
-type BuiltinPosition = Decorated<Vec4f, [Builtin<'position'>]>;
-type BuiltinClipDistances = Decorated<WgslArray<U32>, [
-    Builtin<'clip_distances'>
-]>;
-type BuiltinFrontFacing = Decorated<F32, [Builtin<'front_facing'>]>;
-type BuiltinFragDepth = Decorated<F32, [Builtin<'frag_depth'>]>;
-type BuiltinSampleIndex = Decorated<U32, [Builtin<'sample_index'>]>;
-type BuiltinSampleMask = Decorated<U32, [Builtin<'sample_mask'>]>;
-type BuiltinFragment = Decorated<Vec4f, [Builtin<'fragment'>]>;
-type BuiltinLocalInvocationId = Decorated<Vec3u, [
-    Builtin<'local_invocation_id'>
-]>;
-type BuiltinLocalInvocationIndex = Decorated<U32, [
-    Builtin<'local_invocation_index'>
-]>;
-type BuiltinGlobalInvocationId = Decorated<Vec3u, [
-    Builtin<'global_invocation_id'>
-]>;
-type BuiltinWorkgroupId = Decorated<Vec3u, [Builtin<'workgroup_id'>]>;
-type BuiltinNumWorkgroups = Decorated<Vec3u, [
-    Builtin<'num_workgroups'>
-]>;
-declare const builtin: {
-    readonly vertexIndex: BuiltinVertexIndex;
-    readonly instanceIndex: BuiltinInstanceIndex;
-    readonly position: BuiltinPosition;
-    readonly clipDistances: BuiltinClipDistances;
-    readonly frontFacing: BuiltinFrontFacing;
-    readonly fragDepth: BuiltinFragDepth;
-    readonly sampleIndex: BuiltinSampleIndex;
-    readonly sampleMask: BuiltinSampleMask;
-    readonly localInvocationId: BuiltinLocalInvocationId;
-    readonly localInvocationIndex: BuiltinLocalInvocationIndex;
-    readonly globalInvocationId: BuiltinGlobalInvocationId;
-    readonly workgroupId: BuiltinWorkgroupId;
-    readonly numWorkgroups: BuiltinNumWorkgroups;
-};
-type AnyBuiltin = (typeof builtin)[keyof typeof builtin];
-
-/**
- * @module typegpu/data
- */
-
-/**
- * Extracts the inferred representation of a resource.
- * @example
- * type A = Infer<F32> // => number
- * type B = Infer<TgpuArray<F32>> // => number[]
- */
-type Infer<T> = Infer$1<Exotic<T>>;
-
-export { Align, type AnyAttribute, type AnyBuiltin, AnyData, AnyLooseData, AnyWgslData, Atomic, BaseWgslData, Builtin, type BuiltinClipDistances, type BuiltinFragDepth, type BuiltinFragment, type BuiltinFrontFacing, type BuiltinGlobalInvocationId, type BuiltinInstanceIndex, type BuiltinLocalInvocationId, type BuiltinLocalInvocationIndex, type BuiltinNumWorkgroups, type BuiltinPosition, type BuiltinSampleIndex, type BuiltinSampleMask, type BuiltinVertexIndex, type BuiltinWorkgroupId, Decorated, Disarray, F32, type HasCustomLocation, I32, type Infer, type IsBuiltin, Location, LooseDecorated, Mat2x2f, Mat3x3f, Mat4x4f, Size, type TgpuArray, type TgpuStruct, U32, Unstruct, Vec3u, Vec4f, WgslArray, WgslStruct, align, PUBLIC_alignmentOf as alignmentOf, arrayOf, atomic, builtin, disarrayOf, isBuiltin, location, m2x2f, m3x3f, m4x4f, mat2x2f, mat3x3f, mat4x4f, matToArray, size, PUBLIC_sizeOf as sizeOf, struct, unstruct, v2f, v3f, v4f };
+export { a as AnyAttribute, A as AnyBuiltin, b as AnyData, r as AnyLooseData, a2 as BuiltinClipDistances, a4 as BuiltinFragDepth, a7 as BuiltinFragment, a3 as BuiltinFrontFacing, aa as BuiltinGlobalInvocationId, a0 as BuiltinInstanceIndex, a8 as BuiltinLocalInvocationId, a9 as BuiltinLocalInvocationIndex, ac as BuiltinNumWorkgroups, a1 as BuiltinPosition, a5 as BuiltinSampleIndex, a6 as BuiltinSampleMask, $ as BuiltinVertexIndex, ab as BuiltinWorkgroupId, e as Disarray, ad as FormatToWGSLType, H as HasCustomLocation, j as Infer, I as IsBuiltin, L as LooseDecorated, aV as PackedData, p as TgpuArray, d as TgpuStruct, ae as TgpuVertexFormatData, f as Unstruct, C as align, Z as alignmentOf, q as arrayOf, B as atomic, l as bool, _ as builtin, t as disarrayOf, n as f16, m as f32, aE as float16, aF as float16x2, aG as float16x4, aH as float32, aI as float32x2, aJ as float32x3, aK as float32x4, o as i32, J as interpolate, N as isBuiltin, W as isData, Q as isDisarray, X as isLooseData, S as isLooseDecorated, R as isUnstruct, G as location, w as mat2x2f, x as mat3x3f, y as mat4x4f, z as matToArray, af as packedFormats, av as sint16, aw as sint16x2, ax as sint16x4, aP as sint32, aQ as sint32x2, aR as sint32x3, aS as sint32x4, aj as sint8, ak as sint8x2, al as sint8x4, F as size, Y as sizeOf, aB as snorm16, aC as snorm16x2, aD as snorm16x4, ap as snorm8, aq as snorm8x2, ar as snorm8x4, s as struct, u as u32, as as uint16, at as uint16x2, au as uint16x4, aL as uint32, aM as uint32x2, aN as uint32x3, aO as uint32x4, ag as uint8, ah as uint8x2, ai as uint8x4, aT as unorm10_10_10_2, ay as unorm16, az as unorm16x2, aA as unorm16x4, am as unorm8, an as unorm8x2, ao as unorm8x4, aU as unorm8x4_bgra, v as unstruct } from '../index-CopjPGJg.cjs';
+export { T as Align, A as AnyWgslData, S as Atomic, B as BaseWgslData, s as Bool, r as Builtin, D as Decorated, a as F16, F as F32, b as I32, Y as Interpolate, L as Location, M as Mat2x2f, O as Mat3x3f, Q as Mat4x4f, X as Size, U as U32, V as Vec2f, e as Vec2h, h as Vec2i, k as Vec2u, c as Vec3f, f as Vec3h, i as Vec3i, l as Vec3u, d as Vec4f, g as Vec4h, j as Vec4i, m as Vec4u, W as WgslArray, n as WgslStruct, a7 as isAlignAttrib, a5 as isAtomic, a8 as isBuiltinAttrib, a6 as isDecorated, aa as isInterpolateAttrib, a9 as isLocationAttrib, ab as isSizeAttrib, a3 as isWgslArray, a2 as isWgslData, a4 as isWgslStruct, G as m2x2f, H as m3x3f, J as m4x4f, K as v2f, ac as v2i, ad as v2u, P as v3f, ae as v3i, af as v3u, R as v4f, ag as v4i, ah as v4u, ai as vec2f, aj as vec2h, ak as vec2i, al as vec2u, am as vec3f, an as vec3h, ao as vec3i, ap as vec3u, aq as vec4f, ar as vec4h, as as vec4i, at as vec4u } from '../vector-BSez01sn.cjs';