TgpuRoot

Extends

Unwrapper

Properties

[$internal]

[$internal]: object

logOptions

logOptions: LogGeneratorOptions

Defined in

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

~unstable

~unstable: Omit<ExperimentalTgpuRoot, keyof TgpuRoot>

Defined in

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

device

readonly device: GPUDevice

The GPU device associated with this root.

Overrides

Unwrapper.device

Defined in

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

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:757

Methods

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:743

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:602

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:617

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:657

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:671

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:713

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:684

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:698

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:630

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:644

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.