Skip to content

Documentation / scene / RenderGraph

Class: RenderGraph

Defined in: libs/scene/src/render/rendergraph/rendergraph.ts:21

Declarative render pass and resource dependency graph.

Constructors

Constructor

new RenderGraph(): RenderGraph

Returns

RenderGraph

Methods

importTexture()

importTexture<TTexture>(name): RGTextureHandle<TTexture>

Defined in: libs/scene/src/render/rendergraph/rendergraph.ts:31

Import an external texture that the graph does not own.

Type Parameters

TTexture

TTexture = BaseTexture<unknown>

Parameters

name

string

Returns

RGTextureHandle<TTexture>


addPass()

addPass<T>(name, setup): T

Defined in: libs/scene/src/render/rendergraph/rendergraph.ts:42

Add a pass. The setup callback declares dependencies and execution.

Type Parameters

T

T = void

Parameters

name

string

setup

(builder) => T

Returns

T


compile()

compile(outputs): CompiledRenderGraph

Defined in: libs/scene/src/render/rendergraph/rendergraph.ts:96

Cull dead passes, sort dependencies, and calculate resource lifetimes. Outputs must be their latest written versions.

Parameters

outputs

RGHandle<RGHandleKind, unknown>[]

Returns

CompiledRenderGraph


reset()

reset(): void

Defined in: libs/scene/src/render/rendergraph/rendergraph.ts:139

Clear all passes, resources, and compiled state.

Returns

void

Released under the MIT License.