Documentation / scene / CompositorBuildLayerOptions

Interface: CompositorBuildLayerOptions

Defined in: libs/scene/src/posteffect/compositor.ts:18

Options for building a post effect layer as render graph passes.

Properties

graph

graph: RenderGraph

Defined in: libs/scene/src/posteffect/compositor.ts:20

The render graph being built.

---

ctx

ctx: DrawContext

Defined in: libs/scene/src/posteffect/compositor.ts:22

Frame draw context.

---

layer

layer: PostEffectLayer

Defined in: libs/scene/src/posteffect/compositor.ts:24

The layer to build.

---

blackboard

blackboard: RGBlackboard

Defined in: libs/scene/src/posteffect/compositor.ts:26

Named frame resources.

---

input

input: RGHandle

Defined in: libs/scene/src/posteffect/compositor.ts:28

Chain input color handle.

---

finalOutput?

optional finalOutput?: object

Defined in: libs/scene/src/posteffect/compositor.ts:35

Direct final target for the last effect of the chain, or null to always end the chain in an intermediate texture. Pass the imported backbuffer handle together with isScreen=false when rendering into a framebuffer, or isScreen=true when the final target is the device default framebuffer.

handle

handle: RGHandle

isScreen

isScreen: boolean

---

inputResidesInFinalTarget?

optional inputResidesInFinalTarget?: boolean

Defined in: libs/scene/src/posteffect/compositor.ts:42

True when the chain input physically resides in the final target (final framebuffer used as scene intermediate). An effect whose input is the final target must never direct-write it — sampling and rendering the same texture in one pass is a feedback loop.

---

sceneDepthAttachment?

optional sceneDepthAttachment?: RGTextureAttachment

Defined in: libs/scene/src/posteffect/compositor.ts:47

Depth attachment for intermediate effect outputs that request one: either a graph texture handle or a backend depth texture.

---

dependencies?

optional dependencies?: RGHandle<RGHandleKind, unknown>[]

Defined in: libs/scene/src/posteffect/compositor.ts:49

Ordering/lifetime dependencies declared by every effect pass.

---

historyReads?

optional historyReads?: PostEffectHistoryRead[]

Defined in: libs/scene/src/posteffect/compositor.ts:51

History bindings kept in a read scope while effects execute.

---

history?

optional history?: HistoryResourceManager<Texture2D<unknown>>

Defined in: libs/scene/src/posteffect/compositor.ts:53

Cross-frame history resource manager.