TgpuRoot

Extends

Unwrapper.WithBinding

Properties

[$internal]

[$internal]: object

logOptions

logOptions: LogGeneratorOptions

Defined in

packages/typegpu/src/core/root/rootTypes.ts:719

~unstable

~unstable: Pick<ExperimentalTgpuRoot, "with" | "withCompute" | "createGuardedComputePipeline" | "withVertex" | "pipe" | "beginRenderPass" | "createComparisonSampler" | "createSampler" | "createTexture" | "flush" | "nameRegistrySetting" | "shaderGenerator">

Defined in

packages/typegpu/src/core/root/rootTypes.ts:905

device

readonly device: GPUDevice

The GPU device associated with this root.

Overrides

Unwrapper.device

Defined in

packages/typegpu/src/core/root/rootTypes.ts:726

Accessors

enabledFeatures

Get Signature

get enabledFeatures(): ReadonlySet<GPUFeatureName>

Retrieves a read-only list of all enabled features of the GPU device.

Returns

ReadonlySet<GPUFeatureName>

A set of strings representing the enabled features.

Defined in

packages/typegpu/src/core/root/rootTypes.ts:896

Methods

configureContext()

configureContext(options): GPUCanvasContext

Creates and configures context for the provided canvas. Automatically sets the format to navigator.gpu.getPreferredCanvasFormat() if not provided.

Parameters

options

ConfigureContextOptions

Returns

GPUCanvasContext

Throws

An error if no context could be obtained

Defined in

packages/typegpu/src/core/root/rootTypes.ts:733

createBindGroup()

createBindGroup<Entries>(layout, entries): TgpuBindGroup<Entries>

Creates a group of resources that can be bound to a shader based on a specified layout.

Type Parameters

• Entries extends Record<string, null | TgpuLayoutEntry> = Record<string, null | TgpuLayoutEntry>

Parameters

layout

TgpuBindGroupLayout<Entries>

Layout describing the bind group to be created.

entries

ExtractBindGroupInputFromLayout<Entries>

A record with values being the resources populating the bind group and keys being their associated names, matching the layout keys.

Returns

TgpuBindGroup<Entries>

Remarks

Typed wrapper around a GPUBindGroup.

Example

const fooLayout = tgpu.bindGroupLayout({
 foo: { uniform: d.vec3f },
 bar: { texture: 'float' },
});

const fooBuffer = ...;
const barTexture = ...;

const fooBindGroup = root.createBindGroup(fooLayout, {
 foo: fooBuffer,
 bar: barTexture,
});

Defined in

packages/typegpu/src/core/root/rootTypes.ts:885

createBuffer()

Call Signature

createBuffer<TData>(typeSchema, initial?): TgpuBuffer<TData>

Allocates memory on the GPU, allows passing data between host and shader.

Type Parameters

• TData extends AnyData

Parameters

typeSchema

ValidateBufferSchema<TData>

The type of data that this buffer will hold.

initial?

Infer<NoInfer<TData>>

The initial value of the buffer. (optional)

Returns

TgpuBuffer<TData>

Remarks

Typed wrapper around a GPUBuffer.

Defined in

packages/typegpu/src/core/root/rootTypes.ts:744

Call Signature

createBuffer<TData>(typeSchema, gpuBuffer): TgpuBuffer<TData>

Allocates memory on the GPU, allows passing data between host and shader.

Type Parameters

• TData extends AnyData

Parameters

typeSchema

ValidateBufferSchema<TData>

The type of data that this buffer will hold.

gpuBuffer

GPUBuffer

A vanilla WebGPU buffer.

Returns

TgpuBuffer<TData>

Remarks

Typed wrapper around a GPUBuffer.

Defined in

packages/typegpu/src/core/root/rootTypes.ts:759

createComputePipeline()

createComputePipeline<ComputeIn>(descriptor): TgpuComputePipeline

Type Parameters

• ComputeIn extends IORecord<AnyComputeBuiltin>

Parameters

descriptor

Descriptor<ComputeIn>

createGuardedComputePipeline()

createGuardedComputePipeline<TArgs>(callback): TgpuGuardedComputePipeline<TArgs>

Creates a compute pipeline that executes the given callback in an exact number of threads. This is different from withCompute(...).createPipeline() in that it does a bounds check on the thread id, where as regular pipelines do not and work in units of workgroups.

Type Parameters

• TArgs extends number[]

Parameters

callback

(…args) => void

A function converted to WGSL and executed on the GPU. It can accept up to 3 parameters (x, y, z) which correspond to the global invocation ID of the executing thread.

Returns

TgpuGuardedComputePipeline<TArgs>

Examples

If no parameters are provided, the callback will be executed once, in a single thread.

const fooPipeline = root
  .createGuardedComputePipeline(() => {
    'use gpu';
    console.log('Hello, GPU!');
  });

fooPipeline.dispatchThreads();
// [GPU] Hello, GPU!

One parameter means n-threads will be executed in parallel.

const fooPipeline = root
  .createGuardedComputePipeline((x) => {
    'use gpu';
    if (x % 16 === 0) {
      // Logging every 16th thread
      console.log('I am the', x, 'thread');
    }
  });

// executing 512 threads
fooPipeline.dispatchThreads(512);
// [GPU] I am the 256 thread
// [GPU] I am the 272 thread
// ... (30 hidden logs)
// [GPU] I am the 16 thread
// [GPU] I am the 240 thread

Inherited from

WithBinding.createGuardedComputePipeline

Defined in

packages/typegpu/src/core/root/rootTypes.ts:417

createMutable()

Call Signature

createMutable<TData>(typeSchema, initial?): TgpuMutable<TData>

Allocates memory on the GPU, allows passing data between host and shader. Can be mutated in-place on the GPU. For a general-purpose buffer, use TgpuRoot.createBuffer.

Type Parameters

• TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

The type of data that this buffer will hold.

initial?

Infer<NoInfer<TData>>

The initial value of the buffer. (optional)

Returns

TgpuMutable<TData>

Defined in

packages/typegpu/src/core/root/rootTypes.ts:799

Call Signature

createMutable<TData>(typeSchema, gpuBuffer): TgpuMutable<TData>

Allocates memory on the GPU, allows passing data between host and shader. Can be mutated in-place on the GPU. For a general-purpose buffer, use TgpuRoot.createBuffer.

Type Parameters

• TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

The type of data that this buffer will hold.

gpuBuffer

GPUBuffer

A vanilla WebGPU buffer.

Returns

TgpuMutable<TData>

Defined in

packages/typegpu/src/core/root/rootTypes.ts:813

createQuerySet()

createQuerySet<T>(type, count, rawQuerySet?): TgpuQuerySet<T>

Creates a query set for collecting timestamps or occlusion queries.

Type Parameters

• T extends GPUQueryType

Parameters

type

T

The type of queries to collect (‘occlusion’ or ‘timestamp’).

count

number

The number of queries in the set.

rawQuerySet?

GPUQuerySet

An optional pre-existing GPUQuerySet to use instead of creating a new one.

Returns

TgpuQuerySet<T>

Remarks

Typed wrapper around a GPUQuerySet.

Defined in

packages/typegpu/src/core/root/rootTypes.ts:855

createReadonly()

Call Signature

createReadonly<TData>(typeSchema, initial?): TgpuReadonly<TData>

Allocates memory on the GPU, allows passing data between host and shader. Read-only on the GPU, optimized for large data. For a general-purpose buffer, use TgpuRoot.createBuffer.

Type Parameters

• TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

The type of data that this buffer will hold.

initial?

Infer<NoInfer<TData>>

The initial value of the buffer. (optional)

Returns

TgpuReadonly<TData>

Defined in

packages/typegpu/src/core/root/rootTypes.ts:826

Call Signature

createReadonly<TData>(typeSchema, gpuBuffer): TgpuReadonly<TData>

Allocates memory on the GPU, allows passing data between host and shader. Read-only on the GPU, optimized for large data. For a general-purpose buffer, use TgpuRoot.createBuffer.

Type Parameters

• TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

The type of data that this buffer will hold.

gpuBuffer

GPUBuffer

A vanilla WebGPU buffer.

Returns

TgpuReadonly<TData>

Defined in

packages/typegpu/src/core/root/rootTypes.ts:840

createRenderPipeline()

Call Signature

createRenderPipeline<TVertexIn, TAttribs, TVertexOut, TFragmentOut>(descriptor): TgpuRenderPipeline<NormalizeOutput<TFragmentOut>>

Type Parameters

• TVertexIn extends In = Record<string, any>

• TAttribs extends object = LayoutToAllowedAttribs<TVertexIn>

• TVertexOut = unknown

• TFragmentOut = unknown

Parameters

descriptor

DescriptorBase & object

Returns

TgpuRenderPipeline<NormalizeOutput<TFragmentOut>>

Inherited from

WithBinding.createRenderPipeline

Defined in

packages/typegpu/src/core/root/rootTypes.ts:257

Call Signature

createRenderPipeline<TVertexIn, TAttribs, TVertexOut>(descriptor): TgpuRenderPipeline<Void>

Type Parameters

• TVertexIn extends In = Record<string, any>

• TAttribs extends object = LayoutToAllowedAttribs<TVertexIn>

• TVertexOut extends Out = Out

Parameters

descriptor

DescriptorBase & object

Returns

TgpuRenderPipeline<Void>

Inherited from

WithBinding.createRenderPipeline

Defined in

packages/typegpu/src/core/root/rootTypes.ts:286

Call Signature

createRenderPipeline<TVertexIn, TAttribs, TVertexOut, TFragmentOut>(descriptor): TgpuRenderPipeline<Void> | TgpuRenderPipeline<NormalizeOutput<TFragmentOut>>

Type Parameters

• TVertexIn extends In = Record<string, any>

• TAttribs extends object = LayoutToAllowedAttribs<TVertexIn>

• TVertexOut extends Out = Out

• TFragmentOut = unknown

Parameters

descriptor

DescriptorBase & {attribs: TAttribs;fragment: TgpuFragmentFn<VertexOutToVarying<OmitBuiltins<TVertexOut>> & Record<string, AnyFragmentInputBuiltin>, Assume<TFragmentOut, Out>> | (input) => AutoFragmentOut<Assume<TFragmentOut, v4f | AnyAutoCustoms>>;targets: FragmentOutToTargets<NoInfer<TFragmentOut>>;vertex: TgpuVertexFn<TVertexIn, Assume<TVertexOut, Out>> | (input) => AutoVertexOut<Assume<TVertexOut, AnyAutoCustoms>>; } | {attribs: TAttribs;fragment: TgpuFragmentFn<VertexOutToVarying<OmitBuiltins<TVertexOut>> & Record<string, AnyFragmentInputBuiltin>, Record<string, never>> | (input) => undefined;targets: undefined;vertex: TgpuVertexFn<TVertexIn, Assume<TVertexOut, Out>> | (input) => AutoVertexOut<Assume<TVertexOut, AnyAutoCustoms>>; }

Returns

TgpuRenderPipeline<Void> | TgpuRenderPipeline<NormalizeOutput<TFragmentOut>>

Inherited from

WithBinding.createRenderPipeline

Defined in

packages/typegpu/src/core/root/rootTypes.ts:315

createUniform()

Call Signature

createUniform<TData>(typeSchema, initial?): TgpuUniform<TData>

Allocates memory on the GPU, allows passing data between host and shader. Read-only on the GPU, optimized for small data. For a general-purpose buffer, use TgpuRoot.createBuffer.

Type Parameters

• TData extends AnyWgslData

Parameters

typeSchema

ValidateUniformSchema<TData>

The type of data that this buffer will hold.

initial?

Infer<NoInfer<TData>>

The initial value of the buffer. (optional)

Returns

TgpuUniform<TData>

Defined in

packages/typegpu/src/core/root/rootTypes.ts:772

Call Signature

createUniform<TData>(typeSchema, gpuBuffer): TgpuUniform<TData>

Allocates memory on the GPU, allows passing data between host and shader. Read-only on the GPU, optimized for small data. For a general-purpose buffer, use TgpuRoot.createBuffer.

Type Parameters

• TData extends AnyWgslData

Parameters

typeSchema

ValidateUniformSchema<TData>

The type of data that this buffer will hold.

gpuBuffer

GPUBuffer

A vanilla WebGPU buffer.

Returns

TgpuUniform<TData>

Defined in

packages/typegpu/src/core/root/rootTypes.ts:786

destroy()

destroy(): void

Destroys all underlying resources (i.e. buffers…) created through this root object. If the object is created via tgpu.init instead of tgpu.initFromDevice, then the inner GPU device is destroyed as well.