TgpuRenderPipeline

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:177

Extends

TgpuNamable.SelfResolvable.Timeable

Type Parameters

Targets

Targets = never

Properties

[$internal]

readonly [$internal]: RenderPipelineInternals

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:179

Overrides

SelfResolvable.[$internal]

[$soul]

readonly [$soul]: TgpuRenderPipelineSoul

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:180

hasIndexBuffer

readonly hasIndexBuffer: boolean

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:182

resourceType

readonly resourceType: "render-pipeline"

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:181

Methods

[$resolve]()

[$resolve](ctx): ResolvedSnippet

Defined in: packages/typegpu/src/types.ts:435

Parameters

ctx

ResolutionCtx

Returns

ResolvedSnippet

Inherited from

SelfResolvable.[$resolve]

$name()

$name(label): this

Defined in: packages/typegpu/src/shared/meta.ts:44

Parameters

label

string

Returns

this

Inherited from

TgpuNamable.$name

draw()

draw(vertexCount, instanceCount?, firstVertex?, firstInstance?): void

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:260

Parameters

vertexCount

number

instanceCount?

number

firstVertex?

number

firstInstance?

number

Returns

void

drawIndexedIndirect()

drawIndexedIndirect(indirectBuffer, indirectOffset?): void

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:300

Draws indexed primitives using parameters read from a buffer. The buffer must contain 5 consecutive 32-bit integer values (indexCount u32, instanceCount u32, firstIndex u32, baseVertex i32, firstInstance u32). To get the correct offset within complex data structures, use d.memoryLayoutOf(...).

Parameters

indirectBuffer

Buffer marked with ‘indirect’ usage containing draw parameters or raw GPUBuffer

GPUBuffer | TgpuBuffer<BaseData> & IndirectFlag

indirectOffset?

PrimitiveOffsetInfo pointing to the first draw parameter. If not provided, starts at offset 0. To obtain safe offsets, use d.memoryLayoutOf(...).

number | PrimitiveOffsetInfo

Returns

void

drawIndirect()

drawIndirect(indirectBuffer, indirectOffset?): void

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:287

Draws primitives using parameters read from a buffer. The buffer must contain 4 consecutive u32 values (vertexCount, instanceCount, firstVertex, firstInstance). To get the correct offset within complex data structures, use d.memoryLayoutOf(...).

Parameters

indirectBuffer

Buffer marked with ‘indirect’ usage containing draw parameters or raw GPUBuffer

GPUBuffer | TgpuBuffer<BaseData> & IndirectFlag

indirectOffset?

PrimitiveOffsetInfo pointing to the first draw parameter. If not provided, starts at offset 0. To obtain safe offsets, use d.memoryLayoutOf(...).

number | PrimitiveOffsetInfo

Returns

void

initAsync()

initAsync(): Promise<void>

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:271

Immediately resolves the pipeline, then awaits device.createRenderPipelineAsync(). NOTE: it is not necessary to initialize pipelines manually.

Returns

Promise<void>

initSync()

initSync(): void

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:277

Immediately resolves the pipeline and creates WebGPU resources. NOTE: it is not necessary to initialize pipelines manually.

Returns

void

pipe()

pipe<T>(transform): T

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:228

Applies a transform to this pipeline, letting packages hand out reusable configuration steps, e.g. pipeline.pipe(mesh.inject()).

Type Parameters

T

T

Parameters

transform

(pipeline) => T

Returns

T

toString()

toString(): string

Defined in: packages/typegpu/src/types.ts:436

Returns

string

Inherited from

SelfResolvable.toString

with()

Call Signature

with<TData>(vertexLayout, buffer): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:184

Type Parameters

TData

TData extends WgslArray<BaseData> | Disarray<BaseData>

Parameters

vertexLayout

TgpuVertexLayout<TData>

buffer

GPUBuffer | TgpuBuffer<TData> & VertexFlag

Returns

this

Call Signature

with<Entries>(bindGroupLayout, bindGroup): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:192

Type Parameters

Entries

Entries extends Record<string, TgpuLayoutEntry | null>

Parameters

bindGroupLayout

TgpuBindGroupLayout<Entries>

bindGroup

TgpuBindGroup<Entries>

Returns

this

Call Signature

with(bindGroupLayout, bindGroup): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:196

Parameters

bindGroupLayout

TgpuBindGroupLayout

bindGroup

GPUBindGroup

Returns

this

Call Signature

with(bindGroup): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:197

Parameters

bindGroup

TgpuBindGroup

Returns

this

Call Signature

with<T>(immediate, value): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:207

Provides a value for the given immediate variable, applied on draw like the rest of the pipeline-held state and overridden by pass.setImmediates. The value is captured (copied) at call time; mutating it afterwards has no effect.

Passing an ArrayBuffer or typed array skips serialization entirely; the bytes are copied verbatim and the caller guarantees they match the schema’s layout.

Type Parameters

T

T extends AnyWgslData

Parameters

immediate

TgpuImmediateVar<T>

value

ArrayBuffer | ArrayBufferView<ArrayBufferLike> | InferInput<T>

Returns

this

Call Signature

with(pass): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:215

Directs subsequent draw calls into the given render pass or render bundle encoder, letting multiple pipelines share one pass (and one submission).

Parameters

pass

TgpuRenderCommands

Returns

this

Call Signature

with(encoder): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:220

Directs subsequent draw calls into the given command encoder. Each draw records its own render pass; the caller owns the submission.

Parameters

encoder

TgpuCommandEncoder

Returns

this

Call Signature

with(encoder): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:221

Parameters

encoder

GPUCommandEncoder

Returns

this

Call Signature

with(pass): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:222

Parameters

pass

GPURenderPassEncoder

Returns

this

Call Signature

with(bundleEncoder): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:223

Parameters

bundleEncoder

GPURenderBundleEncoder

Returns

this

withColorAttachment()

withColorAttachment(attachment): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:242

Attaches texture views to the pipeline’s targets (outputs).

Parameters

attachment

FragmentOutToColorAttachment<Targets>

The object should match the shape returned by the fragment shader, with values matching the ColorAttachment type.

Returns

this

Example

// Draw 3 vertices onto the context's canvas
pipeline
  .withColorAttachment({ view: context })
  .draw(3)

withDepthStencilAttachment()

withDepthStencilAttachment(attachment): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:244

Parameters

attachment

DepthStencilAttachment

Returns

this

withIndexBuffer()

Call Signature

withIndexBuffer(buffer, offsetElements?, sizeElements?): TgpuRenderPipeline<Targets> & HasIndexBuffer

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:248

Parameters

buffer

TgpuBuffer<BaseData> & IndexFlag

offsetElements?

number

sizeElements?

number

Returns

TgpuRenderPipeline<Targets> & HasIndexBuffer

Call Signature

withIndexBuffer(buffer, indexFormat, offsetBytes?, sizeBytes?): TgpuRenderPipeline<Targets> & HasIndexBuffer

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:253

Parameters

buffer

GPUBuffer

indexFormat

GPUIndexFormat

offsetBytes?

number

sizeBytes?

number

Returns

TgpuRenderPipeline<Targets> & HasIndexBuffer

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

callback

(start, end) => void | Promise<void>

Returns

this

Inherited from

Timeable.withPerformanceCallback

withStencilReference()

withStencilReference(reference): this

Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:246

Parameters

reference

number

Returns

this

withTimestampWrites()

withTimestampWrites(options): this

Defined in: packages/typegpu/src/core/pipeline/timeable.ts:15

Parameters

options

beginningOfPassWriteIndex?

number

endOfPassWriteIndex?

number

querySet

GPUQuerySet | TgpuQuerySet<"timestamp">

Returns

this

Inherited from

Timeable.withTimestampWrites