typegpu/shared/soul.d.ts

A thin layer between JS and WebGPU/WGSL that improves development experience and allows for faster iteration.

/**
 * The base shape of a soul: a plain record of all definitional state of a resource,
 * holding everything that survives transfer between runtimes. Souls carry own data
 * properties only, no methods, no prototype and no symbol keys. Raw GPU objects
 * belong here too, they cross runtimes as shareable host objects pointing to the
 * same underlying resource
 */
export interface TgpuSoul<TType extends string = string> {
    readonly type: TType;
    /** Only set/read through `setName` and `getName` - do not change manually */
    label?: string | undefined;
}
/** A soul of a resource that owns a device object, filled in by `[$internal].materialize()` */
export interface TgpuDeviceOwningSoul<TType extends string = string, TRaw = unknown> extends TgpuSoul<TType> {
    readonly device: GPUDevice;
    raw?: TRaw | undefined;
}