Documentation / scene / Compositor
Class: Compositor
Defined in: libs/scene/src/posteffect/compositor.ts:71
Post processing compositor
Constructors
Constructor
new Compositor():
Compositor
Defined in: libs/scene/src/posteffect/compositor.ts:77
Creates an instance of Compositor
Returns
Compositor
Methods
buildLayer()
buildLayer(
options):CompositorBuildLayerResult
Defined in: libs/scene/src/posteffect/compositor.ts:118
Build the enabled effects of a layer as render graph passes.
Effects are chained through graph texture handles: each effect's setup() declares its passes reading the previous output. Where each effect output lands (intermediate texture or the final target) is decided here through the PostEffectSetupContext.createOutput implementation, so effect code never handles final-target selection.
Parameters
options
Build inputs.
Returns
The chain output handle and whether the final target was written directly.
appendPostEffect()
appendPostEffect(
postEffect):void
Defined in: libs/scene/src/posteffect/compositor.ts:202
Adds a posteffect
Parameters
postEffect
The post effect to add
Returns
void
removePostEffect()
removePostEffect(
postEffect):void
Defined in: libs/scene/src/posteffect/compositor.ts:248
Removes a posteffect that was previously added
Parameters
postEffect
The posteffect to be remove.
Returns
void
clear()
clear():
void
Defined in: libs/scene/src/posteffect/compositor.ts:261
Removes all post effects
Returns
void