UiPostEffectChain

Immutable pipeline reference for post-processing UI layers.

Overview

UiPostEffectChain encapsulates a sequence of post-processing shader passes applied to an offscreen layer buffer. A chain can be empty (none()), reference a registered effect ID (of("unigui:tint")), or hold inline pass instances.

Backend renderers resolve chains lazily during render time. If a referenced effect ID is unregistered or post-processing is unsupported, rendering seamlessly falls back to normal direct drawing without crashing.

Creating Effect Chains

// Reference registered effect
UiPostEffectChain vignetteChain = UiPostEffectChain.of("unigui:vignette");

// No-op chain
UiPostEffectChain cleanChain = UiPostEffectChain.none();

API

UiPostEffectChain::copy()

copy()

Returns an independent copy of this chain.

Returns UiPostEffectChain: Resulting UiPostEffectChain..

UiPostEffectChain::effectId()

effectId()

Returns the referenced effect identifier or null.

Returns String: Resulting String..

UiPostEffectChain::inlinePasses()

inlinePasses()

Returns the list of inline passes if defined directly.

Returns List: Resulting List..

UiPostEffectChain::isNone()

isNone()

Returns true if this chain performs no post-processing.

Returns boolean: Resulting boolean..

UiPostEffectChain::none()

none()

Returns an empty chain representing no post-processing.

Returns UiPostEffectChain: Resulting UiPostEffectChain..

UiPostEffectChain::of(List)

of(List)

Creates an inline chain from a list of passes.

Parameter	Type	Description
passes	List	List of UiPostEffectPass.

Returns UiPostEffectChain: Resulting UiPostEffectChain..

UiPostEffectChain::of(String)

of(String)

Creates a chain referencing a registered effect identifier.

Parameter	Type	Description
effectId	String	Effect ID string.

Returns UiPostEffectChain: Resulting UiPostEffectChain..

UiPostEffectChain::of(UiPostEffectDefinition)

of(UiPostEffectDefinition)

Creates a chain holding passes from a definition.

Parameter	Type	Description
definition	UiPostEffectDefinition	Post-effect definition.

Returns UiPostEffectChain: Resulting UiPostEffectChain..

UiPostEffectChain::resolve(UiPostEffectRegistry)

resolve(UiPostEffectRegistry)

Resolves the chain into an ordered list of passes via the registry.

Parameter	Type	Description
registry	UiPostEffectRegistry	UiPostEffectRegistry source.

Returns List: Resulting List..