TgpuRenderPipeline
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:80
Extends
Section titled “Extends”TgpuNamable
.SelfResolvable
.Timeable
Type Parameters
Section titled “Type Parameters”• Output extends IOLayout
= IOLayout
Properties
Section titled “Properties”[$internal]
Section titled “[$internal]”
readonly
[$internal]:RenderPipelineInternals
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:82
hasIndexBuffer
Section titled “hasIndexBuffer”
readonly
hasIndexBuffer:boolean
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:84
resourceType
Section titled “resourceType”
readonly
resourceType:"render-pipeline"
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:83
Methods
Section titled “Methods”~resolve()
Section titled “~resolve()”~resolve(
ctx
):string
Defined in: packages/typegpu/src/types.ts:260
Parameters
Section titled “Parameters”ResolutionCtx
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”SelfResolvable.~resolve
$name()
Section titled “$name()”$name(
label
):this
Defined in: packages/typegpu/src/shared/meta.ts:83
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”TgpuNamable.$name
draw()
Section titled “draw()”draw(
vertexCount
,instanceCount
?,firstVertex
?,firstInstance
?):void
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:115
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
toString()
Section titled “toString()”toString():
string
Defined in: packages/typegpu/src/types.ts:261
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”SelfResolvable.toString
with()
Section titled “with()”Call Signature
Section titled “Call Signature”with<
TData
>(vertexLayout
,buffer
):this
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:86
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”TgpuBuffer
<TData
> & VertexFlag
Returns
Section titled “Returns”this
Call Signature
Section titled “Call Signature”with<
Entries
>(bindGroupLayout
,bindGroup
):this
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:90
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
withColorAttachment()
Section titled “withColorAttachment()”withColorAttachment(
attachment
):this
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:95
Parameters
Section titled “Parameters”attachment
Section titled “attachment”FragmentOutToColorAttachment
<Output
>
Returns
Section titled “Returns”this
withDepthStencilAttachment()
Section titled “withDepthStencilAttachment()”withDepthStencilAttachment(
attachment
):this
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:99
Parameters
Section titled “Parameters”attachment
Section titled “attachment”DepthStencilAttachment
Returns
Section titled “Returns”this
withIndexBuffer()
Section titled “withIndexBuffer()”Call Signature
Section titled “Call Signature”withIndexBuffer(
buffer
,offsetElements
?,sizeElements
?):TgpuRenderPipeline
<Output
> &HasIndexBuffer
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:103
Parameters
Section titled “Parameters”buffer
Section titled “buffer”TgpuBuffer
<AnyWgslData
> & IndexFlag
offsetElements?
Section titled “offsetElements?”number
sizeElements?
Section titled “sizeElements?”number
Returns
Section titled “Returns”TgpuRenderPipeline
<Output
> & HasIndexBuffer
Call Signature
Section titled “Call Signature”withIndexBuffer(
buffer
,indexFormat
,offsetBytes
?,sizeBytes
?):TgpuRenderPipeline
<Output
> &HasIndexBuffer
Defined in: packages/typegpu/src/core/pipeline/renderPipeline.ts:108
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
<Output
> & HasIndexBuffer
withPerformanceCallback()
Section titled “withPerformanceCallback()”withPerformanceCallback(
callback
):this
Defined in: packages/typegpu/src/core/pipeline/timeable.ts:6
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:10
Parameters
Section titled “Parameters”options
Section titled “options”beginningOfPassWriteIndex?
Section titled “beginningOfPassWriteIndex?”number
endOfPassWriteIndex?
Section titled “endOfPassWriteIndex?”number
querySet
Section titled “querySet”TgpuQuerySet
<"timestamp"
> | GPUQuerySet
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Timeable.withTimestampWrites