TgpuRoot

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

Extends

Unwrapper.WithBinding

Properties

[$internal]

[$internal]: object

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

logOptions

logOptions: LogGeneratorOptions

~unstable

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

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

device

readonly device: GPUDevice

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

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

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

configureContext()

configureContext(options): GPUCanvasContext

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

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

createBindGroup()

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

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

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

Type Parameters

Entries

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

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, initializer): TgpuBuffer<TData>

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

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

Type Parameters

TData

TData extends AnyData

Parameters

typeSchema

ValidateBufferSchema<TData>

The type of data that this buffer will hold.

initializer

(buffer) => void

Returns

TgpuBuffer<TData>

Remarks

Typed wrapper around a GPUBuffer.

Call Signature

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

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

Type Parameters

TData

TData extends AnyData

Parameters

Call Signature

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

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

Type Parameters

TData

TData extends AnyData

Parameters

typeSchema

ValidateBufferSchema<TData>

initial?

InferInput<NoInfer> | (buffer) => void

Returns

TgpuBuffer<TData>

Call Signature

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

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

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

Type Parameters

TData

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.

createComparisonSampler()

createComparisonSampler(props): TgpuFixedComparisonSampler

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

Parameters

props

WgslComparisonSamplerProps

Returns

TgpuFixedComparisonSampler

createComputePipeline()

createComputePipeline<ComputeIn>(descriptor): TgpuComputePipeline

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

Type Parameters

ComputeIn

ComputeIn extends IORecord<AnyComputeBuiltin>

Parameters

descriptor

Descriptor<ComputeIn>

Returns

TgpuComputePipeline

Inherited from

WithBinding.createComputePipeline

createGuardedComputePipeline()

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

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

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

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

createMutable()

Call Signature

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

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

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

TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

The type of data that this buffer will hold.

initializer

(buffer) => void

Returns

TgpuMutable<TData>

Call Signature

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

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

Type Parameters

TData

TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

initial?

InferInput<NoInfer>

Returns

TgpuMutable<TData>

Call Signature

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

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

Type Parameters

TData

TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

initial?

InferInput<NoInfer> | (buffer) => void

Returns

TgpuMutable<TData>

Call Signature

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

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

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

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

Creates a query set for collecting timestamps or occlusion queries.

Type Parameters

T

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, initializer): TgpuReadonly<TData>

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

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

TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

The type of data that this buffer will hold.

initializer

(buffer) => void

Returns

TgpuReadonly<TData>

Call Signature

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

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

Type Parameters

TData

TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

initial?

InferInput<NoInfer>

Returns

TgpuReadonly<TData>

Call Signature

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

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

Type Parameters

TData

TData extends AnyWgslData

Parameters

typeSchema

ValidateStorageSchema<TData>

initial?

InferInput<NoInfer> | (buffer) => void

Returns

TgpuReadonly<TData>

Call Signature

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

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

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

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>

createRenderPipeline()

Call Signature

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

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

Type Parameters

TVertexIn

TVertexIn extends In = Record<string, any>

TAttribs

TAttribs extends object = LayoutToAllowedAttribs<TVertexIn>

TVertexOut

TVertexOut = unknown

TFragmentOut

TFragmentOut = unknown

Parameters

descriptor

DescriptorBase & object

Returns

TgpuRenderPipeline<NormalizeOutput<TFragmentOut>>

Inherited from

WithBinding.createRenderPipeline

Call Signature

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

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

Type Parameters

TVertexIn

TVertexIn extends In = Record<string, any>

TAttribs

TAttribs extends object = LayoutToAllowedAttribs<TVertexIn>

TVertexOut

TVertexOut extends Out = Out

Parameters

descriptor

DescriptorBase & object

Returns

TgpuRenderPipeline<Void>

Inherited from

WithBinding.createRenderPipeline

Call Signature

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

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

Type Parameters

TVertexIn

TVertexIn extends In = Record<string, any>

TAttribs

TAttribs extends object = LayoutToAllowedAttribs<TVertexIn>

TVertexOut

TVertexOut extends Out = Out

TFragmentOut

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>; 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

createSampler()

createSampler(props): TgpuFixedSampler

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

Parameters

props

WgslSamplerProps

Returns

TgpuFixedSampler

createTexture()

createTexture<TWidth, THeight, TDepth, TSize, TFormat, TMipLevelCount, TSampleCount, TViewFormats, TDimension>(props): TgpuTexture<{ [K in “size” | “dimension” | “format” | “mipLevelCount” | “sampleCount” | “viewFormats”]: ({ format: TFormat; size: Mutable<TSize> } & OmitProps<{ dimension: GPUTextureDimension extends TDimension ? undefined : TDimension extends “2d” ? undefined : TDimension; mipLevelCount: number extends TMipLevelCount ? undefined : TMipLevelCount extends 1 ? undefined : TMipLevelCount; sampleCount: number extends TSampleCount ? undefined : TSampleCount extends 1 ? undefined : TSampleCount; viewFormats: GPUTextureFormat[] extends TViewFormats ? undefined : TViewFormats extends never[] ? undefined : TViewFormats extends SrgbVariantOrSelf<TFormat> ? TViewFormats : never }, undefined>)[K] }>

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

Type Parameters

TWidth

TWidth extends number

THeight

THeight extends number

TDepth

TDepth extends number

TSize

TSize extends readonly [TWidth] | readonly [TWidth, THeight] | readonly [TWidth, THeight, TDepth]

TFormat

TFormat extends GPUTextureFormat

TMipLevelCount

TMipLevelCount extends number

TSampleCount

TSampleCount extends number

TViewFormats

TViewFormats extends GPUTextureFormat[]

TDimension

TDimension extends GPUTextureDimension

Parameters

props

CreateTextureOptions<TSize, TFormat, TMipLevelCount, TSampleCount, TViewFormats, TDimension>

Returns

TgpuTexture<{ [K in “size” | “dimension” | “format” | “mipLevelCount” | “sampleCount” | “viewFormats”]: ({ format: TFormat; size: Mutable<TSize> } & OmitProps<{ dimension: GPUTextureDimension extends TDimension ? undefined : TDimension extends “2d” ? undefined : TDimension; mipLevelCount: number extends TMipLevelCount ? undefined : TMipLevelCount extends 1 ? undefined : TMipLevelCount; sampleCount: number extends TSampleCount ? undefined : TSampleCount extends 1 ? undefined : TSampleCount; viewFormats: GPUTextureFormat[] extends TViewFormats ? undefined : TViewFormats extends never[] ? undefined : TViewFormats extends SrgbVariantOrSelf<TFormat> ? TViewFormats : never }, undefined>)[K] }>

createUniform()

Call Signature

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

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

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

TData extends AnyWgslData

Parameters

typeSchema

ValidateUniformSchema<TData>

The type of data that this buffer will hold.

initializer

(buffer) => void

Returns

TgpuUniform<TData>

Call Signature

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

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

Type Parameters

TData

TData extends AnyWgslData

Parameters

typeSchema

ValidateUniformSchema<TData>

initial?

InferInput<NoInfer>

Returns

TgpuUniform<TData>

Call Signature

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

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

Type Parameters

TData

TData extends AnyWgslData

Parameters

typeSchema

ValidateUniformSchema<TData>

initial?

InferInput<NoInfer> | (buffer) => void

Returns

TgpuUniform<TData>

Call Signature

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

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

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

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

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.