TgpuComputePipeline
Extends
Section titled “Extends”TgpuNamable.SelfResolvable.Timeable
Properties
Section titled “Properties”[$internal]
Section titled “[$internal]”
readonly[$internal]:ComputePipelineInternals
Overrides
Section titled “Overrides”SelfResolvable.[$internal]
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/computePipeline.ts:51
resourceType
Section titled “resourceType”
readonlyresourceType:"compute-pipeline"
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/computePipeline.ts:52
Methods
Section titled “Methods”[$resolve]()
Section titled “[$resolve]()”[$resolve](
ctx):ResolvedSnippet
Parameters
Section titled “Parameters”ResolutionCtx
Returns
Section titled “Returns”ResolvedSnippet
Inherited from
Section titled “Inherited from”SelfResolvable.[$resolve]
Defined in
Section titled “Defined in”packages/typegpu/src/types.ts:319
$name()
Section titled “$name()”$name(
label):this
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TgpuNamable.$name
Defined in
Section titled “Defined in”packages/typegpu/src/shared/meta.ts:97
dispatchWorkgroups()
Section titled “dispatchWorkgroups()”dispatchWorkgroups(
x,y?,z?):void
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/computePipeline.ts:64
dispatchWorkgroupsIndirect()
Section titled “dispatchWorkgroupsIndirect()”dispatchWorkgroupsIndirect<
T>(indirectBuffer,start?):void
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”TgpuBuffer<T> & IndirectFlag
Buffer marked with ‘indirect’ usage containing dispatch parameters
start?
Section titled “start?”number | PrimitiveOffsetInfo
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/computePipeline.ts:74
toString()
Section titled “toString()”toString():
string
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”SelfResolvable.toString
Defined in
Section titled “Defined in”packages/typegpu/src/types.ts:320
with()
Section titled “with()”Call Signature
Section titled “Call Signature”with<
Entries>(bindGroupLayout,bindGroup):this
Type Parameters
Section titled “Type Parameters”• Entries extends Record<string, null | TgpuLayoutEntry>
Parameters
Section titled “Parameters”bindGroupLayout
Section titled “bindGroupLayout”TgpuBindGroupLayout<Entries>
bindGroup
Section titled “bindGroup”TgpuBindGroup<Entries>
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/computePipeline.ts:58
Call Signature
Section titled “Call Signature”with(
bindGroup):this
Parameters
Section titled “Parameters”bindGroup
Section titled “bindGroup”Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/computePipeline.ts:62
withPerformanceCallback()
Section titled “withPerformanceCallback()”withPerformanceCallback(
callback):this
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
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/timeable.ts:6
withTimestampWrites()
Section titled “withTimestampWrites()”withTimestampWrites(
options):this
Parameters
Section titled “Parameters”options
Section titled “options”options.beginningOfPassWriteIndex
Section titled “options.beginningOfPassWriteIndex”number
options.endOfPassWriteIndex
Section titled “options.endOfPassWriteIndex”number
options.querySet
Section titled “options.querySet”TgpuQuerySet<"timestamp"> | GPUQuerySet
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Timeable.withTimestampWrites