TgpuRenderPipeline

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

Extends

TgpuNamable.SelfResolvable.Timeable

Type Parameters

Targets

Targets = never

Properties

[$internal]

readonly [$internal]: RenderPipelineInternals

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

Overrides

SelfResolvable.[$internal]

hasIndexBuffer

readonly hasIndexBuffer: boolean

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

resourceType

readonly resourceType: "render-pipeline"

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

Methods

[$resolve]()

[$resolve](ctx): ResolvedSnippet

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

Parameters

ctx

ResolutionCtx

Returns

ResolvedSnippet

Inherited from

SelfResolvable.[$resolve]

$name()

$name(label): this

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

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

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

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

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

toString()

toString(): string

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

Returns

string

Inherited from

SelfResolvable.toString

with()

Call Signature

with<TData>(vertexLayout, buffer): this

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

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

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

Parameters

bindGroupLayout

TgpuBindGroupLayout

bindGroup

GPUBindGroup

Returns

this

Call Signature

with(bindGroup): this

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

Parameters

bindGroup

TgpuBindGroup

Returns

this

Call Signature

with(encoder): this

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

Parameters

encoder

GPUCommandEncoder

Returns

this

Call Signature

with(pass): this

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

Parameters

pass

GPURenderPassEncoder

Returns

this

Call Signature

with(bundleEncoder): this

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

Parameters

bundleEncoder

GPURenderBundleEncoder

Returns

this

withColorAttachment()

withColorAttachment(attachment): this

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

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

Parameters

attachment

DepthStencilAttachment

Returns

this

withIndexBuffer()

Call Signature

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

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

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

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

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

Parameters

reference

number

Returns

this

withTimestampWrites()

withTimestampWrites(options): this

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

Parameters

options

beginningOfPassWriteIndex?

number

endOfPassWriteIndex?

number

querySet

TgpuQuerySet<"timestamp"> | GPUQuerySet

Returns

this

Inherited from

Timeable.withTimestampWrites