TgpuRoot

Defined in: packages/typegpu/src/core/root/rootTypes.ts:411

Extends

• Unwrapper

Properties

~unstable

~unstable: Omit<ExperimentalTgpuRoot, keyof TgpuRoot>

Defined in: packages/typegpu/src/core/root/rootTypes.ts:590

---

device

readonly device: GPUDevice

Defined in: packages/typegpu/src/core/root/rootTypes.ts:415

The GPU device associated with this root.

Overrides

Unwrapper.device

Accessors

enabledFeatures

Get Signature

get enabledFeatures(): ReadonlySet<GPUFeatureName>

Defined in: packages/typegpu/src/core/root/rootTypes.ts:581

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

Returns

ReadonlySet<GPUFeatureName>

A set of strings representing the enabled features.

Methods

createBindGroup()

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:567

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,
});

---

createBuffer()

Call Signature

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:426

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.

Call Signature

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:441

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.

---

createMutable()

Call Signature

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:481

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>

Call Signature

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:495

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>

---

createQuerySet()

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:537

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.

---

createReadonly()

Call Signature

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:508

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>

Call Signature

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:522

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>

---

createUniform()

Call Signature

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:454

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>

Call Signature

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

Defined in: packages/typegpu/src/core/root/rootTypes.ts:468

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>

---

destroy()

destroy(): void

Defined in: packages/typegpu/src/core/root/rootTypes.ts:588

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.

Returns

void

---

unwrap()

Call Signature

unwrap(resource): GPUComputePipeline

Defined in: packages/typegpu/src/unwrapper.ts:25

Parameters

resource

TgpuComputePipeline

Returns

GPUComputePipeline

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPURenderPipeline

Defined in: packages/typegpu/src/unwrapper.ts:26

Parameters

resource

TgpuRenderPipeline

Returns

GPURenderPipeline

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPUBindGroupLayout

Defined in: packages/typegpu/src/unwrapper.ts:27

Parameters

resource

TgpuBindGroupLayout

Returns

GPUBindGroupLayout

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPUBindGroup

Defined in: packages/typegpu/src/unwrapper.ts:28

Parameters

resource

TgpuBindGroup

Returns

GPUBindGroup

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPUBuffer

Defined in: packages/typegpu/src/unwrapper.ts:29

Parameters

resource

TgpuBuffer<AnyData>

Returns

GPUBuffer

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPUTexture

Defined in: packages/typegpu/src/unwrapper.ts:30

Parameters

resource

TgpuTexture

Returns

GPUTexture

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPUTextureView

Defined in: packages/typegpu/src/unwrapper.ts:31

Parameters

resource

TgpuReadonlyTexture<StorageTextureDimension, TexelData> | TgpuWriteonlyTexture<StorageTextureDimension, TexelData> | TgpuMutableTexture<StorageTextureDimension, TexelData> | TgpuSampledTexture<GPUTextureViewDimension, ChannelData>

Returns

GPUTextureView

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPUVertexBufferLayout

Defined in: packages/typegpu/src/unwrapper.ts:38

Parameters

resource

TgpuVertexLayout

Returns

GPUVertexBufferLayout

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPUSampler

Defined in: packages/typegpu/src/unwrapper.ts:39

Parameters

resource

TgpuSampler

Returns

GPUSampler

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPUSampler

Defined in: packages/typegpu/src/unwrapper.ts:40

Parameters

resource

TgpuComparisonSampler

Returns

GPUSampler

Inherited from

Unwrapper.unwrap

Call Signature

unwrap(resource): GPUQuerySet

Defined in: packages/typegpu/src/unwrapper.ts:41

Parameters

resource

TgpuQuerySet<GPUQueryType>

Returns

GPUQuerySet

Inherited from

Unwrapper.unwrap