TgpuComputePipeline
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:88
Extends
Section titled “Extends”TgpuNamable.SelfResolvable.Timeable
Properties
Section titled “Properties”[$internal]
Section titled “[$internal]”
readonly[$internal]:ComputePipelineInternals
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:89
Overrides
Section titled “Overrides”SelfResolvable.[$internal]
[$soul]
Section titled “[$soul]”
readonly[$soul]:TgpuComputePipelineSoul
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:90
resourceType
Section titled “resourceType”
readonlyresourceType:"compute-pipeline"
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:91
Methods
Section titled “Methods”[$resolve]()
Section titled “[$resolve]()”[$resolve](
ctx):ResolvedSnippet
Defined in: packages/typegpu/src/types.ts:426
Parameters
Section titled “Parameters”ResolutionCtx
Returns
Section titled “Returns”ResolvedSnippet
Inherited from
Section titled “Inherited from”SelfResolvable.[$resolve]
$name()
Section titled “$name()”$name(
label):this
Defined in: packages/typegpu/src/shared/meta.ts:44
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TgpuNamable.$name
dispatchWorkgroups()
Section titled “dispatchWorkgroups()”dispatchWorkgroups(
x,y?,z?):void
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:116
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”void
dispatchWorkgroupsIndirect()
Section titled “dispatchWorkgroupsIndirect()”dispatchWorkgroupsIndirect<
T>(indirectBuffer,start?):void
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:138
Dispatches compute workgroups using parameters read from a buffer.
The buffer must contain 3 consecutive u32 values (x, y, z workgroup counts).
To get the correct offset within complex data structures, use d.memoryLayoutOf(...).
Type Parameters
Section titled “Type Parameters”T extends AnyWgslData
Parameters
Section titled “Parameters”indirectBuffer
Section titled “indirectBuffer”Buffer marked with ‘indirect’ usage containing dispatch parameters or raw GPUBuffer
GPUBuffer | TgpuBuffer<T> & IndirectFlag
start?
Section titled “start?”PrimitiveOffsetInfo pointing to the first dispatch parameter. If not provided, starts at offset 0. To obtain safe offsets, use d.memoryLayoutOf(...).
number | PrimitiveOffsetInfo
Returns
Section titled “Returns”void
initAsync()
Section titled “initAsync()”initAsync():
Promise<void>
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:122
Immediately resolves the pipeline, then awaits device.createComputePipelineAsync().
NOTE: it is not necessary to initialize pipelines manually.
Returns
Section titled “Returns”Promise<void>
initSync()
Section titled “initSync()”initSync():
void
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:128
Immediately resolves the pipeline and creates WebGPU resources. NOTE: it is not necessary to initialize pipelines manually.
Returns
Section titled “Returns”void
toString()
Section titled “toString()”toString():
string
Defined in: packages/typegpu/src/types.ts:427
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”SelfResolvable.toString
with()
Section titled “with()”Call Signature
Section titled “Call Signature”with<
Entries>(bindGroupLayout,bindGroup):this
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:97
Type Parameters
Section titled “Type Parameters”Entries
Section titled “Entries”Entries extends Record<string, TgpuLayoutEntry | null>
Parameters
Section titled “Parameters”bindGroupLayout
Section titled “bindGroupLayout”TgpuBindGroupLayout<Entries>
bindGroup
Section titled “bindGroup”TgpuBindGroup<Entries>
Returns
Section titled “Returns”this
Call Signature
Section titled “Call Signature”with(
bindGroupLayout,bindGroup):this
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:101
Parameters
Section titled “Parameters”bindGroupLayout
Section titled “bindGroupLayout”bindGroup
Section titled “bindGroup”GPUBindGroup
Returns
Section titled “Returns”this
Call Signature
Section titled “Call Signature”with(
bindGroup):this
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:102
Parameters
Section titled “Parameters”bindGroup
Section titled “bindGroup”Returns
Section titled “Returns”this
Call Signature
Section titled “Call Signature”with(
pass):this
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:107
Directs subsequent dispatches into the given compute pass, letting multiple pipelines share one pass (and one submission).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
Call Signature
Section titled “Call Signature”with(
encoder):this
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:112
Directs subsequent dispatches into the given command encoder. Each dispatch records its own compute pass; the caller owns the submission.
Parameters
Section titled “Parameters”encoder
Section titled “encoder”Returns
Section titled “Returns”this
Call Signature
Section titled “Call Signature”with(
encoder):this
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:113
Parameters
Section titled “Parameters”encoder
Section titled “encoder”GPUCommandEncoder
Returns
Section titled “Returns”this
Call Signature
Section titled “Call Signature”with(
pass):this
Defined in: packages/typegpu/src/core/pipeline/computePipeline.ts:114
Parameters
Section titled “Parameters”GPUComputePassEncoder
Returns
Section titled “Returns”this
withPerformanceCallback()
Section titled “withPerformanceCallback()”withPerformanceCallback(
callback):this
Defined in: packages/typegpu/src/core/pipeline/timeable.ts:13
Attaches a callback reporting the GPU-side start and end timestamps of the pipeline’s pass. Repeated executions within one command encoder write to the same query set indices, so the callback fires once, with the timestamps of the last execution.
Parameters
Section titled “Parameters”callback
Section titled “callback”(start, end) => void | Promise<void>
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Timeable.withPerformanceCallback
withTimestampWrites()
Section titled “withTimestampWrites()”withTimestampWrites(
options):this
Defined in: packages/typegpu/src/core/pipeline/timeable.ts:15
Parameters
Section titled “Parameters”options
Section titled “options”beginningOfPassWriteIndex?
Section titled “beginningOfPassWriteIndex?”number
endOfPassWriteIndex?
Section titled “endOfPassWriteIndex?”number
querySet
Section titled “querySet”GPUQuerySet | TgpuQuerySet<"timestamp">
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Timeable.withTimestampWrites