typegpu 0.1.2 → 0.2.0-alpha.0

package/vector-D5Vx-xhb.d.ts

@@ -1,516 +0,0 @@
-import { Unwrap, ISchema, Parsed } from 'typed-binary';
-
-/**
- * Can be assigned a name. Not to be confused with
- * being able to HAVE a name.
- */
-interface TgpuNamable {
-    $name(label?: string | undefined): this;
-}
-
-type Getter = <T>(plum: TgpuPlum<T>) => T;
-interface TgpuPlum<TValue = unknown> extends TgpuNamable {
-    readonly __brand: 'TgpuPlum';
-    /**
-     * Computes the value of this plum. Circumvents the store
-     * memoization, so use with care.
-     */
-    compute(get: Getter): TValue;
-}
-
-interface TgpuBufferUsage<TData extends AnyTgpuData, TUsage extends BufferUsage = BufferUsage> extends TgpuBindable<TData, TUsage> {
-    value: Unwrap<TData>;
-}
-
-type AnyTgpuDataTuple = [AnyTgpuData, ...AnyTgpuData[]] | [];
-type UnwrapArgs<T extends AnyTgpuDataTuple> = {
-    [Idx in keyof T]: Unwrap<T[Idx]>;
-};
-type UnwrapReturn<T extends AnyTgpuData | undefined> = T extends undefined ? void : Unwrap<T>;
-/**
- * Describes a function signature (its arguments and return type)
- */
-interface TgpuFnShell<Args extends AnyTgpuDataTuple, Return extends AnyTgpuData | undefined> {
-    readonly argTypes: Args;
-    readonly returnType: Return | undefined;
-    /**
-     * Creates a type-safe implementation of this signature
-     */
-    implement(body: (...args: UnwrapArgs<Args>) => UnwrapReturn<Return>): TgpuFn<Args, Return>;
-}
-interface TgpuFnBase<Args extends AnyTgpuDataTuple, Return extends AnyTgpuData | undefined = undefined> extends TgpuResolvable, TgpuNamable {
-    readonly shell: TgpuFnShell<Args, Return>;
-    /** The JS function body passed as an implementation of a TypeGPU function. */
-    readonly body: (...args: UnwrapArgs<Args>) => UnwrapReturn<Return>;
-    readonly bodyResolvable: TgpuResolvable;
-    $uses(dependencyMap: Record<string, Wgsl>): this;
-}
-type TgpuFn<Args extends AnyTgpuDataTuple, Return extends AnyTgpuData | undefined = undefined> = TgpuFnBase<Args, Return> & ((...args: UnwrapArgs<Args>) => UnwrapReturn<Return>);
-
-type Wgsl = string | number | TgpuResolvable | symbol | boolean;
-/**
- * Passed into each resolvable item. All sibling items share a resolution ctx,
- * and a new resolution ctx is made when going down each level in the tree.
- */
-interface ResolutionCtx {
-    /**
-     * Slots that were used by items resolved by this context.
-     */
-    readonly usedSlots: Iterable<TgpuSlot<unknown>>;
-    addDeclaration(item: TgpuResolvable): void;
-    addBinding(bindable: TgpuBindable, identifier: TgpuIdentifier): void;
-    addRenderResource(resource: TgpuRenderResource, identifier: TgpuIdentifier): void;
-    addBuiltin(builtin: symbol): void;
-    nameFor(token: TgpuResolvable): string;
-    /**
-     * Unwraps all layers of slot indirection and returns the concrete value if available.
-     * @throws {MissingSlotValueError}
-     */
-    unwrap<T>(eventual: Eventual<T>): T;
-    resolve(item: Wgsl, slotValueOverrides?: SlotValuePair<unknown>[]): string;
-    transpileFn(fn: TgpuFn<any, any>, externalMap: Record<string, Wgsl>): {
-        head: Wgsl;
-        body: Wgsl;
-    };
-}
-interface TgpuResolvable {
-    readonly label?: string | undefined;
-    resolve(ctx: ResolutionCtx): string;
-}
-interface TgpuIdentifier extends TgpuNamable, TgpuResolvable {
-}
-/**
- * Represents a value that is available at resolution time.
- */
-type Eventual<T> = T | TgpuSlot<T>;
-type SlotValuePair<T> = [TgpuSlot<T>, T];
-interface TgpuAllocatable<TData extends AnyTgpuData = AnyTgpuData> {
-    /**
-     * The data type this allocatable was constructed with.
-     * It informs the size and format of data in both JS and
-     * binary.
-     */
-    readonly dataType: TData;
-    readonly initial?: Parsed<TData> | TgpuPlum<Parsed<TData>> | undefined;
-    readonly flags: GPUBufferUsageFlags;
-}
-interface TgpuBindable<TData extends AnyTgpuData = AnyTgpuData, TUsage extends BufferUsage = BufferUsage> extends TgpuResolvable {
-    readonly allocatable: TgpuAllocatable<TData>;
-    readonly usage: TUsage;
-}
-type TgpuSamplerType = 'sampler' | 'sampler_comparison';
-type TgpuTypedTextureType = 'texture_1d' | 'texture_2d' | 'texture_2d_array' | 'texture_3d' | 'texture_cube' | 'texture_cube_array' | 'texture_multisampled_2d';
-type TgpuDepthTextureType = 'texture_depth_2d' | 'texture_depth_2d_array' | 'texture_depth_cube' | 'texture_depth_cube_array' | 'texture_depth_multisampled_2d';
-type TgpuStorageTextureType = 'texture_storage_1d' | 'texture_storage_2d' | 'texture_storage_2d_array' | 'texture_storage_3d';
-type TgpuExternalTextureType = 'texture_external';
-type TgpuRenderResourceType = TgpuSamplerType | TgpuTypedTextureType | TgpuDepthTextureType | TgpuStorageTextureType | TgpuExternalTextureType;
-interface TgpuRenderResource extends TgpuResolvable {
-    readonly type: TgpuRenderResourceType;
-}
-type BufferUsage = 'uniform' | 'readonly' | 'mutable' | 'vertex';
-type ValueOf<T> = T extends TgpuSlot<infer I> ? ValueOf<I> : T extends TgpuBufferUsage<infer D> ? ValueOf<D> : T extends TgpuData<unknown> ? Unwrap<T> : T;
-interface TgpuData<TInner> extends ISchema<TInner>, TgpuResolvable {
-    readonly byteAlignment: number;
-    readonly size: number;
-}
-type AnyTgpuData = TgpuData<unknown>;
-interface TgpuPointer<TScope extends 'function', TInner extends AnyTgpuData> {
-    readonly scope: TScope;
-    readonly pointsTo: TInner;
-}
-interface TgpuSlot<T> extends TgpuNamable {
-    readonly __brand: 'TgpuSlot';
-    readonly defaultValue: T | undefined;
-    readonly label?: string | undefined;
-    /**
-     * Used to determine if code generated using either value `a` or `b` in place
-     * of the slot will be equivalent. Defaults to `Object.is`.
-     */
-    areEqual(a: T, b: T): boolean;
-    value: ValueOf<T>;
-}
-
-interface Swizzle2<T2, T3, T4> {
-    readonly xx: T2;
-    readonly xy: T2;
-    readonly yx: T2;
-    readonly yy: T2;
-    readonly xxx: T3;
-    readonly xxy: T3;
-    readonly xyx: T3;
-    readonly xyy: T3;
-    readonly yxx: T3;
-    readonly yxy: T3;
-    readonly yyx: T3;
-    readonly yyy: T3;
-    readonly xxxx: T4;
-    readonly xxxy: T4;
-    readonly xxyx: T4;
-    readonly xxyy: T4;
-    readonly xyxx: T4;
-    readonly xyxy: T4;
-    readonly xyyx: T4;
-    readonly xyyy: T4;
-    readonly yxxx: T4;
-    readonly yxxy: T4;
-    readonly yxyx: T4;
-    readonly yxyy: T4;
-    readonly yyxx: T4;
-    readonly yyxy: T4;
-    readonly yyyx: T4;
-    readonly yyyy: T4;
-}
-interface Swizzle3<T2, T3, T4> extends Swizzle2<T2, T3, T4> {
-    readonly xz: T2;
-    readonly yz: T2;
-    readonly zx: T2;
-    readonly zy: T2;
-    readonly zz: T2;
-    readonly xxz: T3;
-    readonly xyz: T3;
-    readonly xzx: T3;
-    readonly xzy: T3;
-    readonly xzz: T3;
-    readonly yxz: T3;
-    readonly yyz: T3;
-    readonly yzx: T3;
-    readonly yzy: T3;
-    readonly yzz: T3;
-    readonly zxx: T3;
-    readonly zxy: T3;
-    readonly zxz: T3;
-    readonly zyx: T3;
-    readonly zyy: T3;
-    readonly zyz: T3;
-    readonly zzx: T3;
-    readonly zzy: T3;
-    readonly zzz: T3;
-    readonly xxxz: T4;
-    readonly xxyz: T4;
-    readonly xxzx: T4;
-    readonly xxzy: T4;
-    readonly xxzz: T4;
-    readonly xyxz: T4;
-    readonly xyyz: T4;
-    readonly xyzx: T4;
-    readonly xyzy: T4;
-    readonly xyzz: T4;
-    readonly xzxx: T4;
-    readonly xzxy: T4;
-    readonly xzxz: T4;
-    readonly xzyx: T4;
-    readonly xzyy: T4;
-    readonly xzyz: T4;
-    readonly xzzx: T4;
-    readonly xzzy: T4;
-    readonly xzzz: T4;
-    readonly yxxz: T4;
-    readonly yxyz: T4;
-    readonly yxzx: T4;
-    readonly yxzy: T4;
-    readonly yxzz: T4;
-    readonly yyxz: T4;
-    readonly yyyz: T4;
-    readonly yyzx: T4;
-    readonly yyzy: T4;
-    readonly yyzz: T4;
-    readonly yzxx: T4;
-    readonly yzxy: T4;
-    readonly yzxz: T4;
-    readonly yzyx: T4;
-    readonly yzyy: T4;
-    readonly yzyz: T4;
-    readonly yzzx: T4;
-    readonly yzzy: T4;
-    readonly yzzz: T4;
-    readonly zxxx: T4;
-    readonly zxxy: T4;
-    readonly zxxz: T4;
-    readonly zxyx: T4;
-    readonly zxyy: T4;
-    readonly zxyz: T4;
-    readonly zxzx: T4;
-    readonly zxzy: T4;
-    readonly zxzz: T4;
-    readonly zyxx: T4;
-    readonly zyxy: T4;
-    readonly zyxz: T4;
-    readonly zyyx: T4;
-    readonly zyyy: T4;
-    readonly zyyz: T4;
-    readonly zyzx: T4;
-    readonly zyzy: T4;
-    readonly zyzz: T4;
-    readonly zzxx: T4;
-    readonly zzxy: T4;
-    readonly zzxz: T4;
-    readonly zzyx: T4;
-    readonly zzyy: T4;
-    readonly zzyz: T4;
-    readonly zzzx: T4;
-    readonly zzzy: T4;
-    readonly zzzz: T4;
-}
-interface Swizzle4<T2, T3, T4> extends Swizzle3<T2, T3, T4> {
-    readonly yw: T2;
-    readonly zw: T2;
-    readonly wx: T2;
-    readonly wy: T2;
-    readonly wz: T2;
-    readonly ww: T2;
-    readonly xxw: T3;
-    readonly xyw: T3;
-    readonly xzw: T3;
-    readonly xwx: T3;
-    readonly xwy: T3;
-    readonly xwz: T3;
-    readonly xww: T3;
-    readonly yxw: T3;
-    readonly yyw: T3;
-    readonly yzw: T3;
-    readonly ywx: T3;
-    readonly ywy: T3;
-    readonly ywz: T3;
-    readonly yww: T3;
-    readonly zxw: T3;
-    readonly zyw: T3;
-    readonly zzw: T3;
-    readonly zwx: T3;
-    readonly zwy: T3;
-    readonly zwz: T3;
-    readonly zww: T3;
-    readonly wxx: T3;
-    readonly wxz: T3;
-    readonly wxy: T3;
-    readonly wyy: T3;
-    readonly wyz: T3;
-    readonly wzz: T3;
-    readonly wwx: T3;
-    readonly wwy: T3;
-    readonly wwz: T3;
-    readonly www: T3;
-    readonly xxxw: T4;
-    readonly xxyw: T4;
-    readonly xxzw: T4;
-    readonly xxwx: T4;
-    readonly xxwy: T4;
-    readonly xxwz: T4;
-    readonly xxww: T4;
-    readonly xyxw: T4;
-    readonly xyyw: T4;
-    readonly xyzw: T4;
-    readonly xywx: T4;
-    readonly xywy: T4;
-    readonly xywz: T4;
-    readonly xyww: T4;
-    readonly xzxw: T4;
-    readonly xzyw: T4;
-    readonly xzzw: T4;
-    readonly xzwx: T4;
-    readonly xzwy: T4;
-    readonly xzwz: T4;
-    readonly xzww: T4;
-    readonly xwxx: T4;
-    readonly xwxy: T4;
-    readonly xwxz: T4;
-    readonly xwyy: T4;
-    readonly xwyz: T4;
-    readonly xwzz: T4;
-    readonly xwwx: T4;
-    readonly xwwy: T4;
-    readonly xwwz: T4;
-    readonly xwww: T4;
-    readonly yxxw: T4;
-    readonly yxyw: T4;
-    readonly yxzw: T4;
-    readonly yxwx: T4;
-    readonly yxwy: T4;
-    readonly yxwz: T4;
-    readonly yxww: T4;
-    readonly yyxw: T4;
-    readonly yyyw: T4;
-    readonly yyzw: T4;
-    readonly yywx: T4;
-    readonly yywy: T4;
-    readonly yywz: T4;
-    readonly yyww: T4;
-    readonly yzxw: T4;
-    readonly yzyw: T4;
-    readonly yzzw: T4;
-    readonly yzwx: T4;
-    readonly yzwy: T4;
-    readonly yzwz: T4;
-    readonly yzww: T4;
-    readonly ywxx: T4;
-    readonly ywxy: T4;
-    readonly ywxz: T4;
-    readonly ywxw: T4;
-    readonly ywyy: T4;
-    readonly ywyz: T4;
-    readonly ywzz: T4;
-    readonly ywwx: T4;
-    readonly ywwy: T4;
-    readonly ywwz: T4;
-    readonly ywww: T4;
-    readonly zxxw: T4;
-    readonly zxyw: T4;
-    readonly zxzw: T4;
-    readonly zxwx: T4;
-    readonly zxwy: T4;
-    readonly zxwz: T4;
-    readonly zxww: T4;
-    readonly zyxw: T4;
-    readonly zyyw: T4;
-    readonly zyzw: T4;
-    readonly zywx: T4;
-    readonly zywy: T4;
-    readonly zywz: T4;
-    readonly zyww: T4;
-    readonly zzxw: T4;
-    readonly zzyw: T4;
-    readonly zzzw: T4;
-    readonly zzwx: T4;
-    readonly zzwy: T4;
-    readonly zzwz: T4;
-    readonly zzww: T4;
-    readonly zwxx: T4;
-    readonly zwxy: T4;
-    readonly zwxz: T4;
-    readonly zwxw: T4;
-    readonly zwyy: T4;
-    readonly zwyz: T4;
-    readonly zwzz: T4;
-    readonly zwwx: T4;
-    readonly zwwy: T4;
-    readonly zwwz: T4;
-    readonly zwww: T4;
-    readonly wxxx: T4;
-    readonly wxxy: T4;
-    readonly wxxz: T4;
-    readonly wxxw: T4;
-    readonly wxyx: T4;
-    readonly wxyy: T4;
-    readonly wxyz: T4;
-    readonly wxyw: T4;
-    readonly wxzx: T4;
-    readonly wxzy: T4;
-    readonly wxzz: T4;
-    readonly wxzw: T4;
-    readonly wxwx: T4;
-    readonly wxwy: T4;
-    readonly wxwz: T4;
-    readonly wxww: T4;
-    readonly wyxx: T4;
-    readonly wyxy: T4;
-    readonly wyxz: T4;
-    readonly wyxw: T4;
-    readonly wyyy: T4;
-    readonly wyyz: T4;
-    readonly wyzw: T4;
-    readonly wywx: T4;
-    readonly wywy: T4;
-    readonly wywz: T4;
-    readonly wyww: T4;
-    readonly wzxx: T4;
-    readonly wzxy: T4;
-    readonly wzxz: T4;
-    readonly wzxw: T4;
-    readonly wzyy: T4;
-    readonly wzyz: T4;
-    readonly wzzy: T4;
-    readonly wzzw: T4;
-    readonly wzwx: T4;
-    readonly wzwy: T4;
-    readonly wzwz: T4;
-    readonly wzww: T4;
-    readonly wwxx: T4;
-    readonly wwxy: T4;
-    readonly wwxz: T4;
-    readonly wwxw: T4;
-    readonly wwyy: T4;
-    readonly wwyz: T4;
-    readonly wwzz: T4;
-    readonly wwwx: T4;
-    readonly wwwy: T4;
-    readonly wwwz: T4;
-    readonly wwww: T4;
-}
-interface vec2 {
-    x: number;
-    y: number;
-    [Symbol.iterator](): Iterator<number>;
-}
-interface vec3 {
-    x: number;
-    y: number;
-    z: number;
-    [Symbol.iterator](): Iterator<number>;
-}
-interface vec4 {
-    x: number;
-    y: number;
-    z: number;
-    w: number;
-    [Symbol.iterator](): Iterator<number>;
-}
-type VecKind = 'vec2f' | 'vec2i' | 'vec2u' | 'vec3f' | 'vec3i' | 'vec3u' | 'vec4f' | 'vec4i' | 'vec4u';
-interface vecBase {
-    kind: VecKind;
-    [Symbol.iterator](): Iterator<number>;
-}
-type Vec2f = TgpuData<vec2f> & ((x: number, y: number) => vec2f) & ((xy: number) => vec2f) & (() => vec2f);
-interface vec2f extends vec2, Swizzle2<vec2f, vec3f, vec4f> {
-    /** use to distinguish between vectors of the same size on the type level */
-    kind: 'vec2f';
-}
-declare const vec2f: Vec2f;
-type Vec2i = TgpuData<vec2i> & ((x: number, y: number) => vec2i) & ((xy: number) => vec2i) & (() => vec2i);
-interface vec2i extends vec2, Swizzle2<vec2i, vec3i, vec4i> {
-    /** use to distinguish between vectors of the same size on the type level */
-    kind: 'vec2i';
-}
-declare const vec2i: Vec2i;
-type Vec2u = TgpuData<vec2u> & ((x: number, y: number) => vec2u) & ((xy: number) => vec2u) & (() => vec2u);
-interface vec2u extends vec2, Swizzle2<vec2u, vec3u, vec4u> {
-    /** use to distinguish between vectors of the same size on the type level */
-    kind: 'vec2u';
-}
-declare const vec2u: Vec2u;
-type Vec3f = TgpuData<vec3f> & ((x: number, y: number, z: number) => vec3f) & ((xyz: number) => vec3f) & (() => vec3f);
-interface vec3f extends vec3, Swizzle3<vec2f, vec3f, vec4f> {
-    /** use to distinguish between vectors of the same size on the type level */
-    kind: 'vec3f';
-}
-declare const vec3f: Vec3f;
-type Vec3i = TgpuData<vec3i> & ((x: number, y: number, z: number) => vec3i) & ((xyz: number) => vec3i) & (() => vec3i);
-interface vec3i extends vec3, Swizzle3<vec2i, vec3i, vec4i> {
-    /** use to distinguish between vectors of the same size on the type level */
-    kind: 'vec3i';
-}
-declare const vec3i: Vec3i;
-type Vec3u = TgpuData<vec3u> & ((x: number, y: number, z: number) => vec3u) & ((xyz: number) => vec3u) & (() => vec3u);
-interface vec3u extends vec3, Swizzle3<vec2u, vec3u, vec4u> {
-    /** use to distinguish between vectors of the same size on the type level */
-    kind: 'vec3u';
-}
-declare const vec3u: Vec3u;
-type Vec4f = TgpuData<vec4f> & ((x: number, y: number, z: number, w: number) => vec4f) & ((xyzw: number) => vec4f) & (() => vec4f);
-interface vec4f extends vec4, Swizzle4<vec2f, vec3f, vec4f> {
-    /** use to distinguish between vectors of the same size on the type level */
-    kind: 'vec4f';
-}
-declare const vec4f: Vec4f;
-type Vec4i = TgpuData<vec4i> & ((x: number, y: number, z: number, w: number) => vec4i) & ((xyzw: number) => vec4i) & (() => vec4i);
-interface vec4i extends vec4, Swizzle4<vec2i, vec3i, vec4i> {
-    /** use to distinguish between vectors of the same size on the type level */
-    kind: 'vec4i';
-}
-declare const vec4i: Vec4i;
-type Vec4u = TgpuData<vec4u> & ((x: number, y: number, z: number, w: number) => vec4u) & ((xyzw: number) => vec4u) & (() => vec4u);
-interface vec4u extends vec4, Swizzle4<vec2u, vec3u, vec4u> {
-    /** use to distinguish between vectors of the same size on the type level */
-    kind: 'vec4u';
-}
-declare const vec4u: Vec4u;
-
-export { type AnyTgpuData as A, type ResolutionCtx as R, type TgpuAllocatable as T, type VecKind as V, type TgpuNamable as a, type TgpuPlum as b, vec3f as c, vec3i as d, vec3u as e, type TgpuData as f, vec2f as g, vec4f as h, type TgpuPointer as i, vec2i as j, vec2u as k, vec4i as l, vec4u as m, type Vec2f as n, type Vec2i as o, type Vec2u as p, type Vec3f as q, type Vec3i as r, type Vec3u as s, type Vec4f as t, type Vec4i as u, type vecBase as v, type Vec4u as w };