TgpuRenderPipeline
Extends
Section titled “Extends”TgpuNamable.SelfResolvable.Timeable
Type Parameters
Section titled “Type Parameters”• Targets = never
Properties
Section titled “Properties”[$internal]
Section titled “[$internal]”
readonly[$internal]:RenderPipelineInternals
Overrides
Section titled “Overrides”SelfResolvable.[$internal]
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:129
hasIndexBuffer
Section titled “hasIndexBuffer”
readonlyhasIndexBuffer:boolean
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:131
resourceType
Section titled “resourceType”
readonlyresourceType:"render-pipeline"
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:130
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
draw()
Section titled “draw()”draw(
vertexCount,instanceCount?,firstVertex?,firstInstance?):void
Parameters
Section titled “Parameters”vertexCount
Section titled “vertexCount”number
instanceCount?
Section titled “instanceCount?”number
firstVertex?
Section titled “firstVertex?”number
firstInstance?
Section titled “firstInstance?”number
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:181
drawIndexedIndirect()
Section titled “drawIndexedIndirect()”drawIndexedIndirect(
indirectBuffer,indirectOffset?):void
Parameters
Section titled “Parameters”indirectBuffer
Section titled “indirectBuffer”GPUBuffer | TgpuBuffer<BaseData>
indirectOffset?
Section titled “indirectOffset?”number
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:190
drawIndirect()
Section titled “drawIndirect()”drawIndirect(
indirectBuffer,indirectOffset?):void
Parameters
Section titled “Parameters”indirectBuffer
Section titled “indirectBuffer”GPUBuffer | TgpuBuffer<BaseData>
indirectOffset?
Section titled “indirectOffset?”number
Returns
Section titled “Returns”void
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:188
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<
TData>(vertexLayout,buffer):this
Type Parameters
Section titled “Type Parameters”• TData extends WgslArray<BaseData> | Disarray<BaseData>
Parameters
Section titled “Parameters”vertexLayout
Section titled “vertexLayout”TgpuVertexLayout<TData>
buffer
Section titled “buffer”GPUBuffer | TgpuBuffer<TData> & VertexFlag
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:133
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/renderPipeline.ts:141
Call Signature
Section titled “Call Signature”with(
bindGroupLayout,bindGroup):this
Parameters
Section titled “Parameters”bindGroupLayout
Section titled “bindGroupLayout”bindGroup
Section titled “bindGroup”GPUBindGroup
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:145
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/renderPipeline.ts:146
Call Signature
Section titled “Call Signature”with(
encoder):this
Parameters
Section titled “Parameters”encoder
Section titled “encoder”GPUCommandEncoder
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:147
Call Signature
Section titled “Call Signature”with(
pass):this
Parameters
Section titled “Parameters”GPURenderPassEncoder
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:148
Call Signature
Section titled “Call Signature”with(
bundleEncoder):this
Parameters
Section titled “Parameters”bundleEncoder
Section titled “bundleEncoder”GPURenderBundleEncoder
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:149
withColorAttachment()
Section titled “withColorAttachment()”withColorAttachment(
attachment):this
Attaches texture views to the pipeline’s targets (outputs).
Parameters
Section titled “Parameters”attachment
Section titled “attachment”FragmentOutToColorAttachment<Targets>
The object should match the shape returned by the fragment shader, with values matching the ColorAttachment type.
Returns
Section titled “Returns”this
Example
Section titled “Example”// Draw 3 vertices onto the context's canvaspipeline .withColorAttachment({ view: context }) .draw(3)Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:163
withDepthStencilAttachment()
Section titled “withDepthStencilAttachment()”withDepthStencilAttachment(
attachment):this
Parameters
Section titled “Parameters”attachment
Section titled “attachment”DepthStencilAttachment
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:165
withIndexBuffer()
Section titled “withIndexBuffer()”Call Signature
Section titled “Call Signature”withIndexBuffer(
buffer,offsetElements?,sizeElements?):TgpuRenderPipeline<Targets> &HasIndexBuffer
Parameters
Section titled “Parameters”buffer
Section titled “buffer”TgpuBuffer<BaseData> & IndexFlag
offsetElements?
Section titled “offsetElements?”number
sizeElements?
Section titled “sizeElements?”number
Returns
Section titled “Returns”TgpuRenderPipeline<Targets> & HasIndexBuffer
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:169
Call Signature
Section titled “Call Signature”withIndexBuffer(
buffer,indexFormat,offsetBytes?,sizeBytes?):TgpuRenderPipeline<Targets> &HasIndexBuffer
Parameters
Section titled “Parameters”buffer
Section titled “buffer”GPUBuffer
indexFormat
Section titled “indexFormat”GPUIndexFormat
offsetBytes?
Section titled “offsetBytes?”number
sizeBytes?
Section titled “sizeBytes?”number
Returns
Section titled “Returns”TgpuRenderPipeline<Targets> & HasIndexBuffer
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:174
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
withStencilReference()
Section titled “withStencilReference()”withStencilReference(
reference):this
Parameters
Section titled “Parameters”reference
Section titled “reference”number
Returns
Section titled “Returns”this
Defined in
Section titled “Defined in”packages/typegpu/src/core/pipeline/renderPipeline.ts:167
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