typegpu 0.0.0-alpha.1

package/dist/types-gpN_64mT.d.cts

@@ -0,0 +1,148 @@
+import { Parsed, ISchema } from 'typed-binary';
+
+/**
+ * Helpful when creating new Resolvable types. For internal use.
+ */
+declare class WgslIdentifier implements WgslResolvable {
+    label?: string | undefined;
+    $name(label: string | undefined): this;
+    resolve(ctx: ResolutionCtx): string;
+    toString(): string;
+}
+
+declare const WgslSettableTrait: unique symbol;
+interface WgslSettable {
+    readonly [WgslSettableTrait]: true;
+}
+
+type Getter = <T>(plum: WgslPlum<T>) => T;
+type Unsubscribe = () => unknown;
+type ExtractPlumValue<T> = T extends WgslPlum<infer TValue> ? TValue : never;
+interface WgslPlum<TValue = unknown> {
+    readonly __brand: 'WgslPlum';
+    $name(label: string): this;
+    /**
+     * Computes the value of this plum. Circumvents the store
+     * memoization, so use with care.
+     */
+    compute(get: Getter): TValue;
+}
+declare const WgslExternalPlumTrait: unique symbol;
+interface WgslExternalPlum {
+    readonly [WgslExternalPlumTrait]: true;
+    readonly version: number;
+    subscribe(listener: () => unknown): Unsubscribe;
+}
+/**
+ * Creates a computed plum. Its value depends on the plums read using `get`
+ * inside the `compute` function, so cannot be set imperatively.
+ *
+ * @param compute A pure function that describes this plum's value.
+ */
+declare function plum<T extends Wgsl>(compute: (get: Getter) => T): WgslPlum<T> & WgslResolvable;
+/**
+ * Creates a computed plum. Its value depends on the plums read using `get`
+ * inside the `compute` function, so cannot be set imperatively.
+ *
+ * @param compute A pure function that describes this plum's value.
+ */
+declare function plum<T>(compute: (get: Getter) => T): WgslPlum<T>;
+/**
+ * Creates a plum with an initial value of `initial`.
+ * Its value can be updated by calling `runtime.setPlum(thePlum, newValue)`.
+ *
+ * @param initial The initial value of this plum.
+ */
+declare function plum<T extends Wgsl>(initial: T): WgslPlum<T> & WgslSettable & WgslResolvable;
+/**
+ * Creates a plum with an initial value of `initial`.
+ * Its value can be updated by calling `runtime.setPlum(thePlum, newValue)`.
+ *
+ * @param initial The initial value of this plum.
+ */
+declare function plum<T>(initial: T): WgslPlum<T> & WgslSettable;
+declare function plumFromEvent<T>(subscribe: (listener: () => unknown) => Unsubscribe, getLatest: () => T): WgslPlum<T> & WgslExternalPlum;
+
+type Wgsl = string | boolean | number | WgslResolvable;
+/**
+ * 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<WgslSlot<unknown>>;
+    addDeclaration(item: WgslResolvable): void;
+    addBinding(bindable: WgslBindable, identifier: WgslIdentifier): void;
+    nameFor(token: WgslResolvable): 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;
+}
+interface WgslResolvable {
+    readonly label?: string | undefined;
+    resolve(ctx: ResolutionCtx): string;
+}
+declare function isResolvable(value: unknown): value is WgslResolvable;
+declare function isWgsl(value: unknown): value is Wgsl;
+interface WgslSlot<T> {
+    readonly __brand: 'WgslSlot';
+    readonly defaultValue: T | undefined;
+    readonly label?: string | undefined;
+    $name(label: string): WgslSlot<T>;
+    /**
+     * 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;
+}
+declare function isSlot<T>(value: unknown | WgslSlot<T>): value is WgslSlot<T>;
+/**
+ * Represents a value that is available at resolution time.
+ */
+type Eventual<T> = T | WgslSlot<T>;
+type EventualGetter = <T>(value: Eventual<T>) => T;
+type InlineResolve = (get: EventualGetter) => Wgsl;
+interface WgslResolvableSlot<T extends Wgsl> extends WgslResolvable, WgslSlot<T> {
+    $name(label: string): WgslResolvableSlot<T>;
+}
+type SlotValuePair<T> = [WgslSlot<T>, T];
+interface WgslAllocatable<TData extends AnyWgslData = AnyWgslData> {
+    /**
+     * 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> | WgslPlum<Parsed<TData>> | undefined;
+    readonly flags: GPUBufferUsageFlags;
+}
+interface WgslBindable<TData extends AnyWgslData = AnyWgslData, TUsage extends BufferUsage = BufferUsage> extends WgslResolvable {
+    readonly allocatable: WgslAllocatable<TData>;
+    readonly usage: TUsage;
+}
+type BufferUsage = 'uniform' | 'readonly_storage' | 'mutable_storage';
+interface WgslData<TInner> extends ISchema<TInner>, WgslResolvable {
+    readonly byteAlignment: number;
+    readonly size: number;
+}
+type AnyWgslData = WgslData<unknown>;
+interface WgslPointer<TScope extends 'function', TInner extends AnyWgslData> {
+    readonly scope: TScope;
+    readonly pointsTo: TInner;
+}
+/**
+ * A virtual representation of a WGSL value.
+ */
+type WgslValue<TDataType> = {
+    readonly __dataType: TDataType;
+};
+type AnyWgslPointer = WgslPointer<'function', AnyWgslData>;
+type WgslFnArgument = AnyWgslPointer | AnyWgslData;
+declare function isPointer(value: AnyWgslPointer | AnyWgslData): value is AnyWgslPointer;
+
+export { type AnyWgslData as A, type BufferUsage as B, type ExtractPlumValue as E, type InlineResolve as I, type ResolutionCtx as R, type SlotValuePair as S, type Unsubscribe as U, type WgslSlot as W, type WgslResolvable as a, type Wgsl as b, type WgslPlum as c, type WgslSettable as d, type WgslAllocatable as e, type WgslBindable as f, type Eventual as g, type WgslFnArgument as h, type WgslValue as i, WgslIdentifier as j, type WgslResolvableSlot as k, plumFromEvent as l, isResolvable as m, isWgsl as n, isSlot as o, plum as p, type EventualGetter as q, type WgslData as r, type WgslPointer as s, type AnyWgslPointer as t, isPointer as u };

package/dist/types-gpN_64mT.d.ts

@@ -0,0 +1,148 @@
+import { Parsed, ISchema } from 'typed-binary';
+
+/**
+ * Helpful when creating new Resolvable types. For internal use.
+ */
+declare class WgslIdentifier implements WgslResolvable {
+    label?: string | undefined;
+    $name(label: string | undefined): this;
+    resolve(ctx: ResolutionCtx): string;
+    toString(): string;
+}
+
+declare const WgslSettableTrait: unique symbol;
+interface WgslSettable {
+    readonly [WgslSettableTrait]: true;
+}
+
+type Getter = <T>(plum: WgslPlum<T>) => T;
+type Unsubscribe = () => unknown;
+type ExtractPlumValue<T> = T extends WgslPlum<infer TValue> ? TValue : never;
+interface WgslPlum<TValue = unknown> {
+    readonly __brand: 'WgslPlum';
+    $name(label: string): this;
+    /**
+     * Computes the value of this plum. Circumvents the store
+     * memoization, so use with care.
+     */
+    compute(get: Getter): TValue;
+}
+declare const WgslExternalPlumTrait: unique symbol;
+interface WgslExternalPlum {
+    readonly [WgslExternalPlumTrait]: true;
+    readonly version: number;
+    subscribe(listener: () => unknown): Unsubscribe;
+}
+/**
+ * Creates a computed plum. Its value depends on the plums read using `get`
+ * inside the `compute` function, so cannot be set imperatively.
+ *
+ * @param compute A pure function that describes this plum's value.
+ */
+declare function plum<T extends Wgsl>(compute: (get: Getter) => T): WgslPlum<T> & WgslResolvable;
+/**
+ * Creates a computed plum. Its value depends on the plums read using `get`
+ * inside the `compute` function, so cannot be set imperatively.
+ *
+ * @param compute A pure function that describes this plum's value.
+ */
+declare function plum<T>(compute: (get: Getter) => T): WgslPlum<T>;
+/**
+ * Creates a plum with an initial value of `initial`.
+ * Its value can be updated by calling `runtime.setPlum(thePlum, newValue)`.
+ *
+ * @param initial The initial value of this plum.
+ */
+declare function plum<T extends Wgsl>(initial: T): WgslPlum<T> & WgslSettable & WgslResolvable;
+/**
+ * Creates a plum with an initial value of `initial`.
+ * Its value can be updated by calling `runtime.setPlum(thePlum, newValue)`.
+ *
+ * @param initial The initial value of this plum.
+ */
+declare function plum<T>(initial: T): WgslPlum<T> & WgslSettable;
+declare function plumFromEvent<T>(subscribe: (listener: () => unknown) => Unsubscribe, getLatest: () => T): WgslPlum<T> & WgslExternalPlum;
+
+type Wgsl = string | boolean | number | WgslResolvable;
+/**
+ * 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<WgslSlot<unknown>>;
+    addDeclaration(item: WgslResolvable): void;
+    addBinding(bindable: WgslBindable, identifier: WgslIdentifier): void;
+    nameFor(token: WgslResolvable): 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;
+}
+interface WgslResolvable {
+    readonly label?: string | undefined;
+    resolve(ctx: ResolutionCtx): string;
+}
+declare function isResolvable(value: unknown): value is WgslResolvable;
+declare function isWgsl(value: unknown): value is Wgsl;
+interface WgslSlot<T> {
+    readonly __brand: 'WgslSlot';
+    readonly defaultValue: T | undefined;
+    readonly label?: string | undefined;
+    $name(label: string): WgslSlot<T>;
+    /**
+     * 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;
+}
+declare function isSlot<T>(value: unknown | WgslSlot<T>): value is WgslSlot<T>;
+/**
+ * Represents a value that is available at resolution time.
+ */
+type Eventual<T> = T | WgslSlot<T>;
+type EventualGetter = <T>(value: Eventual<T>) => T;
+type InlineResolve = (get: EventualGetter) => Wgsl;
+interface WgslResolvableSlot<T extends Wgsl> extends WgslResolvable, WgslSlot<T> {
+    $name(label: string): WgslResolvableSlot<T>;
+}
+type SlotValuePair<T> = [WgslSlot<T>, T];
+interface WgslAllocatable<TData extends AnyWgslData = AnyWgslData> {
+    /**
+     * 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> | WgslPlum<Parsed<TData>> | undefined;
+    readonly flags: GPUBufferUsageFlags;
+}
+interface WgslBindable<TData extends AnyWgslData = AnyWgslData, TUsage extends BufferUsage = BufferUsage> extends WgslResolvable {
+    readonly allocatable: WgslAllocatable<TData>;
+    readonly usage: TUsage;
+}
+type BufferUsage = 'uniform' | 'readonly_storage' | 'mutable_storage';
+interface WgslData<TInner> extends ISchema<TInner>, WgslResolvable {
+    readonly byteAlignment: number;
+    readonly size: number;
+}
+type AnyWgslData = WgslData<unknown>;
+interface WgslPointer<TScope extends 'function', TInner extends AnyWgslData> {
+    readonly scope: TScope;
+    readonly pointsTo: TInner;
+}
+/**
+ * A virtual representation of a WGSL value.
+ */
+type WgslValue<TDataType> = {
+    readonly __dataType: TDataType;
+};
+type AnyWgslPointer = WgslPointer<'function', AnyWgslData>;
+type WgslFnArgument = AnyWgslPointer | AnyWgslData;
+declare function isPointer(value: AnyWgslPointer | AnyWgslData): value is AnyWgslPointer;
+
+export { type AnyWgslData as A, type BufferUsage as B, type ExtractPlumValue as E, type InlineResolve as I, type ResolutionCtx as R, type SlotValuePair as S, type Unsubscribe as U, type WgslSlot as W, type WgslResolvable as a, type Wgsl as b, type WgslPlum as c, type WgslSettable as d, type WgslAllocatable as e, type WgslBindable as f, type Eventual as g, type WgslFnArgument as h, type WgslValue as i, WgslIdentifier as j, type WgslResolvableSlot as k, plumFromEvent as l, isResolvable as m, isWgsl as n, isSlot as o, plum as p, type EventualGetter as q, type WgslData as r, type WgslPointer as s, type AnyWgslPointer as t, isPointer as u };

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "typegpu",
+  "version": "0.0.0-alpha.1",
+  "description": "A thin layer between JS and WebGPU/WGSL that improves development experience and allows for faster iteration.",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "module": "./dist/index.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.cjs"
+    },
+    "./*": {
+      "types": "./*.d.ts",
+      "module": "./dist/*.js",
+      "import": "./dist/*.js",
+      "default": "./dist/*.cjs"
+    },
+    "./data": {
+      "types": "./dist/data/index.d.ts",
+      "module": "./dist/data/index.js",
+      "import": "./dist/data/index.js",
+      "default": "./dist/data/index.cjs"
+    },
+    "./macro": {
+      "types": "./dist/macro/index.d.ts",
+      "module": "./dist/macro/index.js",
+      "import": "./dist/macro/index.js",
+      "default": "./dist/macro/index.cjs"
+    },
+    "./web": {
+      "types": "./dist/web/index.d.ts",
+      "module": "./dist/web/index.js",
+      "import": "./dist/web/index.js",
+      "default": "./dist/web/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=12.20.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/software-mansion/typegpu.git"
+  },
+  "keywords": [
+    "webgpu",
+    "wgpu",
+    "wgsl",
+    "typescript",
+    "compute",
+    "shader",
+    "shaders",
+    "gpgpu"
+  ],
+  "bugs": {
+    "url": "https://github.com/software-mansion/typegpu/issues"
+  },
+  "homepage": "https://github.com/software-mansion/typegpu",
+  "devDependencies": {
+    "tsup": "^8.0.2",
+    "typescript": "^5.3.3",
+    "typed-binary": "^4.0.0",
+    "@webgpu/types": "^0.1.43",
+    "typegpu": "0.0.0-alpha.1",
+    "@typegpu/wgsl-parser": "0.0.0"
+  },
+  "packageManager": "pnpm@8.15.8+sha256.691fe176eea9a8a80df20e4976f3dfb44a04841ceb885638fe2a26174f81e65e",
+  "peerDependencies": {
+    "typed-binary": "^4.0.1"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "test:types": "pnpm tsc --p ./tsconfig.json --noEmit && pnpm tsc --p ./tsconfig.test.json --noEmit"
+  }
+}