Documentation / scene / RenderModule

Interface: RenderModule<TCtx>

Defined in: libs/scene/src/render/rendergraph/render_module.ts:28

A pipeline stage that declares dependencies and builds graph passes.

Type Parameters

TCtx

TCtx extends RenderContext = RenderContext

Properties

type

readonly type: string

Defined in: libs/scene/src/render/rendergraph/render_module.ts:30

Stable identifier used by pipeline editing methods.

---

reads?

readonly optional reads?: readonly RenderModuleReadDescriptor[]

Defined in: libs/scene/src/render/rendergraph/render_module.ts:33

Blackboard resources required by setup, resolved before module ordering.

---

writes?

readonly optional writes?: readonly FrameResourceKey[]

Defined in: libs/scene/src/render/rendergraph/render_module.ts:36

Blackboard resources published by setup, used for dependency ordering.

Methods

attach()?

optional attach(pipeline): void

Defined in: libs/scene/src/render/rendergraph/render_module.ts:39

Called when this module becomes owned by a pipeline.

Parameters

pipeline

RenderPipeline<TCtx>

Returns

void

---

detach()?

optional detach(pipeline): void

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

Called immediately before this module leaves its owning pipeline.

Parameters

pipeline

RenderPipeline<TCtx>

Returns

void

---

dispose()?

optional dispose(): void

Defined in: libs/scene/src/render/rendergraph/render_module.ts:45

Release resources owned by this module. Called at most once by its pipeline.

Returns

void

---

clone()?

optional clone(): RenderModule<TCtx>

Defined in: libs/scene/src/render/rendergraph/render_module.ts:48

Create an independent module for RenderPipeline.clone.

Returns

RenderModule<TCtx>

---

prepare()

prepare(context): RenderModulePreparation

Defined in: libs/scene/src/render/rendergraph/render_module.ts:51

Prepare pure feature state and requirements for the current frame.

Parameters

context

TCtx

Returns

RenderModulePreparation

---

setup()

setup(context): void

Defined in: libs/scene/src/render/rendergraph/render_module.ts:54

Add this module's passes and publish its outputs.

Parameters

context

TCtx

Returns

void