typegpu 0.1.3 → 0.2.0

package/data/index.d.cts

@@ -1,13 +1,94 @@
-import { AnySchema, Schema, Unwrap, ISerialOutput, ParseUnwrapped, ISerialInput, MaxValue, IMeasurer, ISchema, UnwrapRecord } from 'typed-binary';
+import { Unwrap, AnySchema, Schema, ISerialOutput, ParseUnwrapped, ISerialInput, MaxValue, IMeasurer, ISchema, UnwrapRecord } from 'typed-binary';
 export { Parsed, Unwrap } from 'typed-binary';
-import { e as TgpuData, R as ResolutionCtx, A as AnyTgpuData, h as TgpuNamable, j as vec2f, b as vec3f, k as vec4f, l as TgpuPointer, m as AnyTgpuLooseData, n as TgpuLooseData } from '../tgpuBuffer-BVk2wCHR.cjs';
-export { t as Vec2f, u as Vec2i, w as Vec2u, x as Vec3f, y as Vec3i, z as Vec3u, B as Vec4f, C as Vec4i, D as Vec4u, o as VecKind, p as vec2i, q as vec2u, c as vec3i, d as vec3u, r as vec4i, s as vec4u, v as vecBase } from '../tgpuBuffer-BVk2wCHR.cjs';
+import { A as AnyTgpuData, x as AnyTgpuLooseData, r as TgpuData, y as TgpuLooseData, R as ResolutionCtx, a as TgpuNamable, z as vec2f, o as vec3f, C as vec4f, N as NumberArrayView, D as Vec2u, V as Vec4u, G as Vec2i, i as Vec4i, H as Vec2f, j as Vec4f, F as F32, J as Vec3f, h as U32, K as Vec3u, I as I32, L as Vec3i, M as TgpuPointer } from '../types-CGmVkuAt.cjs';
+export { P as Bool, Z as VecKind, Q as bool, Y as f32, X as i32, W as u32, _ as vec2i, $ as vec2u, p as vec3i, q as vec3u, a0 as vec4i, a1 as vec4u, v as vecBase } from '../types-CGmVkuAt.cjs';
+
+interface TgpuBaseArray<TElement extends AnyTgpuData | AnyTgpuLooseData = AnyTgpuData | AnyTgpuLooseData> {
+    readonly elementType: TElement;
+    readonly elementCount: number;
+    readonly stride: number;
+}
+/**
+ * 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 AnyTgpuData> extends TgpuBaseArray<TElement>, TgpuData<Unwrap<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 count The number of elements in the array.
+ */
+declare const arrayOf: <TElement extends AnyTgpuData>(elementType: TElement, count: number) => TgpuArray<TElement>;
+/**
+ * Array schema constructed via `d.looseArrayOf` function.
+ *
+ * Useful for defining vertex buffers.
+ * 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.
+ */
+interface TgpuLooseArray<TElement extends AnyTgpuData | AnyTgpuLooseData> extends TgpuBaseArray<TElement>, TgpuLooseData<Unwrap<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 looseArray = d.looseArrayOf(d.vec3f, 3); // packed array of vec3f
+ *
+ * @example
+ * const looseArray = d.looseArrayOf(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 looseArrayOf: <TElement extends AnyTgpuData | AnyTgpuLooseData>(elementType: TElement, count: number) => TgpuLooseArray<TElement>;
+/**
+ * Checks whether passed in value is an array schema,
+ * as opposed to, e.g., a looseArray schema.
+ *
+ * Array schemas can be used to describe uniform and storage buffers,
+ * whereas looseArray schemas cannot.
+ *
+ * @example
+ * isArraySchema(d.arrayOf(d.u32, 4)) // true
+ * isArraySchema(d.looseArrayOf(d.u32, 4)) // false
+ * isArraySchema(d.vec3f) // false
+ */
+declare function isArraySchema<T extends TgpuArray<AnyTgpuData>>(schema: T | unknown): schema is T;
+/**
+ * Checks whether the passed in value is a looseArray schema,
+ * as opposed to, e.g., a regular array schema.
+ *
+ * Array schemas can be used to describe uniform and storage buffers,
+ * whereas looseArray schemas cannot. Loose arrays are useful for
+ * defining vertex buffers instead.
+ *
+ * @example
+ * isLooseArraySchema(d.arrayOf(d.u32, 4)) // false
+ * isLooseArraySchema(d.looseArrayOf(d.u32, 4)) // true
+ * isLooseArraySchema(d.vec3f) // false
+ */
+declare function isLooseArraySchema<T extends TgpuLooseArray<AnyTgpuData>>(schema: T | unknown): schema is T;
 
 declare class SimpleTgpuData<TSchema extends AnySchema> extends Schema<Unwrap<TSchema>> implements TgpuData<Unwrap<TSchema>> {
     readonly size: number;
     readonly byteAlignment: number;
     readonly expressionCode: string;
-    readonly isCustomAligned = false;
     private readonly _innerSchema;
     readonly isLoose: false;
     readonly label?: string | undefined;
@@ -23,88 +104,440 @@ declare class SimpleTgpuData<TSchema extends AnySchema> extends Schema<Unwrap<TS
     write(output: ISerialOutput, value: ParseUnwrapped<TSchema>): void;
     read(input: ISerialInput): ParseUnwrapped<TSchema>;
     measure(value: ParseUnwrapped<TSchema> | MaxValue, measurer?: IMeasurer): IMeasurer;
-    getUnderlyingTypeString(): string;
-    getUnderlyingType(): SimpleTgpuData<AnySchema>;
     resolve(ctx: ResolutionCtx): string;
 }
 
-type Bool = TgpuData<boolean>;
-declare const bool: Bool;
-type U32 = TgpuData<number> & ((v: number | boolean) => number);
-declare const u32: U32;
-type I32 = TgpuData<number> & ((v: number | boolean) => number);
-declare const i32: I32;
-type F32 = TgpuData<number> & ((v: number | boolean) => number);
-declare const f32: F32;
-
-interface TgpuStruct<TProps extends Record<string, AnyTgpuData>> extends ISchema<UnwrapRecord<TProps>>, TgpuData<UnwrapRecord<TProps>>, TgpuNamable {
+interface TgpuBaseStruct<TProps extends Record<string, unknown>> extends ISchema<UnwrapRecord<TProps>> {
+    readonly properties: TProps;
 }
+/**
+ * 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, AnyTgpuData>> extends TgpuBaseStruct<TProps>, TgpuData<UnwrapRecord<TProps>>, TgpuNamable {
+}
+/**
+ * Creates a struct schema that can be used to construct GPU buffers.
+ * Ensures proper alignment and padding of properties (as opposed to a `d.looseStruct` schema).
+ * The order of members matches the passed in properties object.
+ *
+ * @example
+ * const CircleStruct = d.struct({ radius: d.f32, pos: d.vec3f });
+ *
+ * @param properties Record with `string` keys and `TgpuData` values,
+ * each entry describing one struct member.
+ */
 declare const struct: <TProps extends Record<string, AnyTgpuData>>(properties: TProps) => TgpuStruct<TProps>;
-declare function isStructSchema<T extends TgpuStruct<Record<string, AnyTgpuData>>>(schema: T | unknown): schema is T;
-
-interface TgpuArray<TElement extends AnyTgpuData> extends TgpuData<Unwrap<TElement>[]> {
-    readonly elementType: TElement;
-    readonly elementCount: number;
+/**
+ * Struct schema constructed via `d.looseStruct` function.
+ *
+ * Useful for defining vertex buffers, as the standard layout restrictions do not apply.
+ * Members are not aligned in respect to their `byteAlignment`,
+ * unless they are explicitly decorated with the custom align attribute
+ * via `d.align` function.
+ */
+interface TgpuLooseStruct<TProps extends Record<string, AnyTgpuData | AnyTgpuLooseData>> extends TgpuBaseStruct<TProps>, TgpuLooseData<UnwrapRecord<TProps>> {
 }
-declare const arrayOf: <TElement extends AnyTgpuData>(elementType: TElement, count: number) => TgpuArray<TElement>;
-declare function isArraySchema<T extends TgpuArray<AnyTgpuData>>(schema: T | unknown): schema is T;
+/**
+ * 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.looseStruct({ radius: d.f32, pos: d.vec3f }); // packed struct with no padding
+ *
+ * @example
+ * const CircleStruct = d.looseStruct({ 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 looseStruct: <TProps extends Record<string, AnyTgpuData | AnyTgpuLooseData>>(properties: TProps) => TgpuLooseStruct<TProps>;
+/**
+ * Checks whether passed in value is a struct schema,
+ * as opposed to, e.g., a looseStruct schema.
+ *
+ * Struct schemas can be used to describe uniform and storage buffers,
+ * whereas looseStruct schemas cannot.
+ *
+ * @example
+ * isStructSchema(d.struct({ a: d.u32 })) // true
+ * isStructSchema(d.looseStruct({ a: d.u32 })) // false
+ * isStructSchema(d.vec3f) // false
+ */
+declare function isStructSchema<T extends TgpuStruct<Record<string, AnyTgpuData>>>(schema: T | unknown): schema is T;
+/**
+ * Checks whether passed in value is a looseStruct schema,
+ * as opposed to, e.g., a struct schema.
+ *
+ * Struct schemas can be used to describe uniform and storage buffers,
+ * whereas looseStruct schemas cannot. Loose structs are useful for
+ * defining vertex buffers instead.
+ *
+ * @example
+ * isLooseStructSchema(d.struct({ a: d.u32 })) // false
+ * isLooseStructSchema(d.looseStruct({ a: d.u32 })) // true
+ * isLooseStructSchema(d.vec3f) // false
+ */
+declare function isLooseStructSchema<T extends TgpuLooseStruct<Record<string, AnyTgpuData | AnyTgpuLooseData>>>(schema: T | unknown): schema is T;
 
-interface matBase<TColumn> {
-    columns(): Iterable<TColumn>;
+interface matBase<TColumn> extends NumberArrayView {
+    readonly columns: readonly TColumn[];
     elements(): Iterable<number>;
 }
+/**
+ * Interface representing its WGSL matrix type counterpart: mat2x2
+ * A matrix with 2 rows and 2 columns, with elements of type `TColumn`
+ */
 interface mat2x2<TColumn> extends matBase<TColumn> {
-    [0]: TColumn;
-    [1]: TColumn;
-    [idx: number]: TColumn | undefined;
+    readonly length: 4;
+    [n: number]: number;
 }
+/**
+ * Type of the `d.mat2x2f` object/function: matrix data type schema/constructor
+ */
 type Mat2x2f = TgpuData<mat2x2f> & ((...elements: number[]) => mat2x2f) & ((...columns: vec2f[]) => mat2x2f) & (() => mat2x2f);
+/**
+ * Interface representing its WGSL matrix type counterpart: mat2x2f or mat2x2<f32>
+ * A matrix with 2 rows and 2 columns, with elements of type d.f32
+ */
 interface mat2x2f extends mat2x2<vec2f> {
 }
+/**
+ *
+ * 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: Mat2x2f;
+/**
+ * Interface representing its WGSL matrix type counterpart: mat3x3
+ * A matrix with 3 rows and 3 columns, with elements of type `TColumn`
+ */
 interface mat3x3<TColumn> extends matBase<TColumn> {
-    [0]: TColumn;
-    [1]: TColumn;
-    [2]: TColumn;
-    [idx: number]: TColumn | undefined;
+    readonly length: 12;
+    [n: number]: number;
 }
+/**
+ * Type of the `d.mat3x3f` object/function: matrix data type schema/constructor
+ */
 type Mat3x3f = TgpuData<mat3x3f> & ((...elements: number[]) => mat3x3f) & ((...columns: vec3f[]) => mat3x3f) & (() => mat3x3f);
+/**
+ * Interface representing its WGSL matrix type counterpart: mat3x3f or mat3x3<f32>
+ * A matrix with 3 rows and 3 columns, with elements of type d.f32
+ */
 interface mat3x3f extends mat3x3<vec3f> {
 }
+/**
+ *
+ * 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: Mat3x3f;
+/**
+ * Interface representing its WGSL matrix type counterpart: mat4x4
+ * A matrix with 4 rows and 4 columns, with elements of type `TColumn`
+ */
 interface mat4x4<TColumn> extends matBase<TColumn> {
-    [0]: TColumn;
-    [1]: TColumn;
-    [2]: TColumn;
-    [3]: TColumn;
-    [idx: number]: TColumn | undefined;
+    readonly length: 16;
+    [n: number]: number;
 }
+/**
+ * Type of the `d.mat4x4f` object/function: matrix data type schema/constructor
+ */
 type Mat4x4f = TgpuData<mat4x4f> & ((...elements: number[]) => mat4x4f) & ((...columns: vec4f[]) => mat4x4f) & (() => mat4x4f);
+/**
+ * Interface representing its WGSL matrix type counterpart: mat4x4f or mat4x4<f32>
+ * A matrix with 4 rows and 4 columns, with elements of type d.f32
+ */
 interface mat4x4f extends mat4x4<vec4f> {
 }
+/**
+ *
+ * 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: Mat4x4f;
 
+declare const vertexFormats: readonly ["uint8x2", "uint8x4", "sint8x2", "sint8x4", "unorm8x2", "unorm8x4", "snorm8x2", "snorm8x4", "uint16x2", "uint16x4", "sint16x2", "sint16x4", "unorm16x2", "unorm16x4", "snorm16x2", "snorm16x4", "float16x2", "float16x4", "float32", "float32x2", "float32x3", "float32x4", "uint32", "uint32x2", "uint32x3", "uint32x4", "sint32", "sint32x2", "sint32x3", "sint32x4", "unorm10_10_10_2"];
+type VertexFormat = (typeof vertexFormats)[number];
+
+type FormatToWGSLType<T extends VertexFormat> = (typeof formatToWGSLType)[T];
+interface TgpuVertexFormatData<T extends VertexFormat> extends TgpuLooseData<FormatToWGSLType<T>> {
+    readonly kind: T;
+}
+declare const formatToWGSLType: {
+    readonly uint8x2: Vec2u;
+    readonly uint8x4: Vec4u;
+    readonly sint8x2: Vec2i;
+    readonly sint8x4: Vec4i;
+    readonly unorm8x2: Vec2f;
+    readonly unorm8x4: Vec4f;
+    readonly snorm8x2: Vec2f;
+    readonly snorm8x4: Vec4f;
+    readonly uint16x2: Vec2u;
+    readonly uint16x4: Vec4u;
+    readonly sint16x2: Vec2i;
+    readonly sint16x4: Vec4i;
+    readonly unorm16x2: Vec2f;
+    readonly unorm16x4: Vec4f;
+    readonly snorm16x2: Vec2f;
+    readonly snorm16x4: Vec4f;
+    readonly float16x2: Vec2f;
+    readonly float16x4: Vec4f;
+    readonly float32: F32;
+    readonly float32x2: Vec2f;
+    readonly float32x3: Vec3f;
+    readonly float32x4: Vec4f;
+    readonly uint32: U32;
+    readonly uint32x2: Vec2u;
+    readonly uint32x3: Vec3u;
+    readonly uint32x4: Vec4u;
+    readonly sint32: I32;
+    readonly sint32x2: Vec2i;
+    readonly sint32x3: Vec3i;
+    readonly sint32x4: Vec4i;
+    readonly unorm10_10_10_2: Vec4f;
+};
+type uint8x2 = TgpuVertexFormatData<'uint8x2'>;
+declare const uint8x2: uint8x2;
+type uint8x4 = TgpuVertexFormatData<'uint8x4'>;
+declare const uint8x4: uint8x4;
+type sint8x2 = TgpuVertexFormatData<'sint8x2'>;
+declare const sint8x2: sint8x2;
+type sint8x4 = TgpuVertexFormatData<'sint8x4'>;
+declare const sint8x4: sint8x4;
+type unorm8x2 = TgpuVertexFormatData<'unorm8x2'>;
+declare const unorm8x2: unorm8x2;
+type unorm8x4 = TgpuVertexFormatData<'unorm8x4'>;
+declare const unorm8x4: unorm8x4;
+type snorm8x2 = TgpuVertexFormatData<'snorm8x2'>;
+declare const snorm8x2: snorm8x2;
+type snorm8x4 = TgpuVertexFormatData<'snorm8x4'>;
+declare const snorm8x4: snorm8x4;
+type uint16x2 = TgpuVertexFormatData<'uint16x2'>;
+declare const uint16x2: uint16x2;
+type uint16x4 = TgpuVertexFormatData<'uint16x4'>;
+declare const uint16x4: uint16x4;
+type sint16x2 = TgpuVertexFormatData<'sint16x2'>;
+declare const sint16x2: sint16x2;
+type sint16x4 = TgpuVertexFormatData<'sint16x4'>;
+declare const sint16x4: sint16x4;
+type unorm16x2 = TgpuVertexFormatData<'unorm16x2'>;
+declare const unorm16x2: unorm16x2;
+type unorm16x4 = TgpuVertexFormatData<'unorm16x4'>;
+declare const unorm16x4: unorm16x4;
+type snorm16x2 = TgpuVertexFormatData<'snorm16x2'>;
+declare const snorm16x2: snorm16x2;
+type snorm16x4 = TgpuVertexFormatData<'snorm16x4'>;
+declare const snorm16x4: snorm16x4;
+type float16x2 = TgpuVertexFormatData<'float16x2'>;
+declare const float16x2: float16x2;
+type float16x4 = TgpuVertexFormatData<'float16x4'>;
+declare const float16x4: float16x4;
+type float32 = TgpuVertexFormatData<'float32'>;
+declare const float32: float32;
+type float32x2 = TgpuVertexFormatData<'float32x2'>;
+declare const float32x2: float32x2;
+type float32x3 = TgpuVertexFormatData<'float32x3'>;
+declare const float32x3: float32x3;
+type float32x4 = TgpuVertexFormatData<'float32x4'>;
+declare const float32x4: float32x4;
+type uint32 = TgpuVertexFormatData<'uint32'>;
+declare const uint32: uint32;
+type uint32x2 = TgpuVertexFormatData<'uint32x2'>;
+declare const uint32x2: uint32x2;
+type uint32x3 = TgpuVertexFormatData<'uint32x3'>;
+declare const uint32x3: uint32x3;
+type uint32x4 = TgpuVertexFormatData<'uint32x4'>;
+declare const uint32x4: uint32x4;
+type sint32 = TgpuVertexFormatData<'sint32'>;
+declare const sint32: sint32;
+type sint32x2 = TgpuVertexFormatData<'sint32x2'>;
+declare const sint32x2: sint32x2;
+type sint32x3 = TgpuVertexFormatData<'sint32x3'>;
+declare const sint32x3: sint32x3;
+type sint32x4 = TgpuVertexFormatData<'sint32x4'>;
+declare const sint32x4: sint32x4;
+type unorm10_10_10_2 = TgpuVertexFormatData<'unorm10_10_10_2'>;
+declare const unorm10_10_10_2: unorm10_10_10_2;
+
 declare function ptr<TDataType extends AnyTgpuData>(pointsTo: TDataType): TgpuPointer<'function', TDataType>;
 
+/**
+ * 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<TSchema>;
+/**
+ * Atomic schema constructed via `d.atomic` function.
+ */
 interface Atomic<TSchema extends U32 | I32> extends TgpuData<Unwrap<TSchema>> {
 }
+/**
+ * Checks whether the passed in value is a d.atomic schema.
+ *
+ * @example
+ * isAtomicSchema(d.atomic(d.u32)) // true
+ * isAtomicSchema(d.u32) // false
+ */
 declare function isAtomicSchema<T extends Atomic<U32 | I32>>(schema: T | unknown): schema is T;
 
-declare function align<TAlign extends number, TData extends AnyTgpuData>(byteAlignment: TAlign, data: TData): TgpuAligned<TAlign, TData>;
-declare function align<TAlign extends number, TData extends AnyTgpuLooseData>(byteAlignment: TAlign, data: TData): TgpuLooseAligned<TAlign, TData>;
-interface TgpuAligned<TAlign extends number, TData extends AnyTgpuData> extends TgpuData<Unwrap<TData>> {
-    readonly byteAlignment: TAlign;
+interface Align<T extends number> {
+    type: 'align';
+    alignment: T;
 }
-interface TgpuLooseAligned<TAlign extends number, TData extends AnyTgpuLooseData> extends TgpuLooseData<Unwrap<TData>> {
-    readonly byteAlignment: TAlign;
+interface Size<T extends number> {
+    type: 'size';
+    size: T;
 }
-declare function isAlignedSchema<T extends TgpuAligned<number, AnyTgpuData>>(value: T | unknown): value is T;
-
-declare function size<TSize extends number, TData extends AnyTgpuData>(size: TSize, data: TData): TgpuSized<TSize, TData>;
-interface TgpuSized<TSize extends number, TData extends AnyTgpuData> extends TgpuData<Unwrap<TData>> {
-    readonly size: TSize;
+interface Location<T extends number> {
+    type: 'location';
+    location: T;
+}
+type AnyAttribute = Align<number> | Size<number> | Location<number>;
+interface BaseDecorated<TInner extends AnyTgpuData | AnyTgpuLooseData = AnyTgpuData | AnyTgpuLooseData, TAttribs extends AnyAttribute[] = AnyAttribute[]> {
+    readonly inner: TInner;
+    readonly attributes: TAttribs;
+    readonly alignAttrib: number | undefined;
+    readonly sizeAttrib: number | undefined;
+    readonly locationAttrib: number | undefined;
+}
+interface Decorated<TInner extends AnyTgpuData, TAttribs extends AnyAttribute[]> extends BaseDecorated<TInner, TAttribs>, TgpuData<Unwrap<TInner>> {
+}
+interface LooseDecorated<TInner extends AnyTgpuLooseData, TAttribs extends AnyAttribute[]> extends BaseDecorated<TInner, TAttribs>, TgpuLooseData<Unwrap<TInner>> {
 }
-declare function isSizedSchema<T extends TgpuSized<number, TgpuData<unknown>>>(value: T | unknown): value is T;
+type ExtractAttributes<T> = T extends BaseDecorated<AnyTgpuData, infer Attribs> ? Attribs : [];
+type UnwrapDecorated<T> = T extends BaseDecorated<infer Inner> ? Inner : 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 AnyTgpuData | AnyTgpuLooseData, TAttrib extends AnyAttribute> = TData extends AnyTgpuData ? Decorated<UnwrapDecorated<TData>, [TAttrib, ...ExtractAttributes<TData>]> : TData extends AnyTgpuLooseData ? LooseDecorated<UnwrapDecorated<TData>, [
+    TAttrib,
+    ...ExtractAttributes<TData>
+]> : never;
+/**
+ * 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 AnyTgpuData | AnyTgpuLooseData>(alignment: TAlign, data: TData): Decorate<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 AnyTgpuData | AnyTgpuLooseData>(size: TSize, data: TData): Decorate<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 AnyTgpuData | AnyTgpuLooseData>(location: TLocation, data: TData): Decorate<TData, Location<TLocation>>;
+declare function isDecorated<T extends Decorated<AnyTgpuData, AnyAttribute[]>>(value: T | unknown): value is T;
+declare function isLooseDecorated<T extends LooseDecorated<AnyTgpuLooseData, AnyAttribute[]>>(value: T | unknown): value is T;
 
-export { type Atomic, type Bool, type F32, type I32, type Mat2x2f, type Mat3x3f, type Mat4x4f, SimpleTgpuData, type TgpuAligned, type TgpuArray, type TgpuSized, type TgpuStruct, type U32, align, arrayOf, atomic, bool, f32, i32, isAlignedSchema, isArraySchema, isAtomicSchema, isSizedSchema, isStructSchema, type mat2x2, mat2x2f, type mat3x3, mat3x3f, type mat4x4, mat4x4f, ptr, size, struct, u32, vec2f, vec3f, vec4f };
+export { type Align, type AnyAttribute, type Atomic, type BaseDecorated, type Decorated, F32, type FormatToWGSLType, I32, type Location, type LooseDecorated, type Mat2x2f, type Mat3x3f, type Mat4x4f, SimpleTgpuData, type Size, type TgpuArray, type TgpuBaseArray, type TgpuBaseStruct, type TgpuLooseArray, type TgpuLooseStruct, type TgpuStruct, type TgpuVertexFormatData, U32, Vec2f, Vec2i, Vec2u, Vec3f, Vec3i, Vec3u, Vec4f, Vec4i, Vec4u, align, arrayOf, atomic, float16x2, float16x4, float32, float32x2, float32x3, float32x4, isArraySchema, isAtomicSchema, isDecorated, isLooseArraySchema, isLooseDecorated, isLooseStructSchema, isStructSchema, location, looseArrayOf, looseStruct, mat2x2f, mat3x3f, mat4x4f, ptr, sint16x2, sint16x4, sint32, sint32x2, sint32x3, sint32x4, sint8x2, sint8x4, size, snorm16x2, snorm16x4, snorm8x2, snorm8x4, struct, uint16x2, uint16x4, uint32, uint32x2, uint32x3, uint32x4, uint8x2, uint8x4, unorm10_10_10_2, unorm16x2, unorm16x4, unorm8x2, unorm8x4, vec2f, vec3f, vec4f };