typegpu/shared/symbols.js

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

const version = "0.12.2";
export const $internal = Symbol(`typegpu:${version}:$internal`);
/** A plain record of all definitional state of a resource, surviving transfer between runtimes */
export const $soul = Symbol(`typegpu:${version}:$soul`);
/**
 * The getter to the value of this resource, accessible on the GPU
 */
export const $gpuValueOf = Symbol(`typegpu:${version}:$gpuValueOf`);
/**
 * If this symbol is present, this means that getName and setName
 * will refer to object behind this property instead.
 */
export const $getNameForward = Symbol(`typegpu:${version}:$getNameForward`);
/**
 * Marks an object with slot-value bindings
 */
export const $providing = Symbol(`typegpu:${version}:$providing`);
/**
 * Objects can provide the snippet that represents them.
 */
export const $ownSnippet = Symbol(`typegpu:${version}:$ownSnippet`);
export const $resolve = Symbol(`typegpu:${version}:$resolve`);
/**
 * A way for a schema to provide casting behavior, without the need to be explicitly
 * callable by the end-user (e.g. vertex formats)
 */
export const $cast = Symbol(`typegpu:${version}:$cast`);
/**
 * Can be called on the GPU
 */
export const $gpuCallable = Symbol(`typegpu:${version}:$gpuCallable`);
//
// Type tokens
//
/**
 * Type token for the inferred (CPU & GPU) representation of a resource
 */
export const $repr = Symbol(`typegpu:${version}:$repr`);
/**
 * Type token for the inferred (GPU-side) representation of a resource
 * If present, it shadows the value of `$repr` for GPU-side inference.
 */
export const $gpuRepr = Symbol(`typegpu:${version}:$gpuRepr`);
/**
 * Type token for the inferred partial representation of a resource.
 * If present, it shadows the value of `$repr` for use in partial IO.
 */
export const $reprPartial = Symbol(`typegpu:${version}:$reprPartial`);
/**
 * Type token for the inferred patch representation of a resource.
 * Used by the `buffer.patch` API with `Record<number, T>` sparse arrays.
 */
export const $reprPatch = Symbol(`typegpu:${version}:$reprPatch`);
/**
 * Type token for the write-side (input) representation of a resource.
 */
export const $inRepr = Symbol(`typegpu:${version}:$inRepr`);
/**
 * Type token holding schemas that are identical in memory layout.
 */
export const $memIdent = Symbol(`typegpu:${version}:$memIdent`);
/**
 * Type token, signaling that a schema can be used in a storage buffer.
 */
export const $validStorageSchema = Symbol(`typegpu:${version}:$invalidStorageSchema`);
/**
 * Type token, signaling that a schema can be used in a uniform buffer.
 */
export const $validUniformSchema = Symbol(`typegpu:${version}:$validUniformSchema`);
/**
 * Type token, signaling that a schema can be used in a vertex buffer.
 */
export const $validVertexSchema = Symbol(`typegpu:${version}:$validVertexSchema`);
/**
 * Type token, containing a reason for why the schema is invalid (if it is).
 */
export const $invalidSchemaReason = Symbol(`typegpu:${version}:$invalidSchemaReason`);
export function isMarkedInternal(value) {
    return !!value?.[$internal];
}