Documentation / scene / RenderPipeline
Class: RenderPipeline<TCtx>
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:78
Ordered, editable collection of uniquely named render modules.
Type Parameters
TCtx
TCtx extends RenderContext = RenderContext
Constructors
Constructor
new RenderPipeline<
TCtx>(modules?):RenderPipeline<TCtx>
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:88
Parameters
modules?
readonly RenderModule<TCtx>[]
Initial ordered modules. Copied into the pipeline; the array is not retained. Duplicate type values are rejected.
Returns
RenderPipeline<TCtx>
Accessors
modules
Get Signature
get modules(): readonly
RenderModule<TCtx>[]
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:107
The pipeline's modules in authored order.
Returns
readonly RenderModule<TCtx>[]
disposed
Get Signature
get disposed():
boolean
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:112
Whether this pipeline and its owned modules have been disposed.
Returns
boolean
Methods
has()
has(
type):boolean
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:117
Whether a module type is present.
Parameters
type
string
Returns
boolean
get()
get(
type):RenderModule<TCtx>
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:122
Return a module by type, or undefined.
Parameters
type
string
Returns
RenderModule<TCtx>
append()
append(
module):this
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:128
Append a module.
Parameters
module
RenderModule<TCtx>
Returns
this
prepend()
prepend(
module):this
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:142
Prepend a module.
Parameters
module
RenderModule<TCtx>
Returns
this
insertBefore()
insertBefore(
anchor,module):this
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:156
Insert a module before the named anchor.
Parameters
anchor
string | RenderModule<TCtx>
module
RenderModule<TCtx>
Returns
this
insertAfter()
insertAfter(
anchor,module):this
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:171
Insert a module after the named anchor.
Parameters
anchor
string | RenderModule<TCtx>
module
RenderModule<TCtx>
Returns
this
replace()
replace(
anchor,module):this
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:186
Replace a module in place. The previous module is detached but not disposed.
Parameters
anchor
string | RenderModule<TCtx>
module
RenderModule<TCtx>
Returns
this
remove()
remove(
anchor):this
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:208
Remove a module by type or instance. The module is detached but not disposed.
Parameters
anchor
string | RenderModule<TCtx>
Returns
this
disposeModule()
disposeModule(
module):void
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:216
Dispose a detached module explicitly.
Parameters
module
RenderModule<TCtx>
Returns
void
clone()
clone():
RenderPipeline<TCtx>
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:221
Clone the pipeline; lifecycle-aware modules must implement clone.
Returns
RenderPipeline<TCtx>
dispose()
dispose():
void
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:238
Detach and dispose every owned module. Idempotent.
Returns
void
resolveModules()
resolveModules(
context): readonlyRenderModule<TCtx>[]
Defined in: libs/scene/src/render/rendergraph/render_pipeline.ts:262
Resolve enabled modules into their setup order for the given context.
Parameters
context
TCtx
Returns
readonly RenderModule<TCtx>[]