UiPostEffectRegistry

Registry repository storing named post-effect definitions.

Overview

UiPostEffectRegistry stores UiPostEffectDefinition instances keyed by string identifier. The singleton instance UiPostEffectRegistry.global() is accessed across code, XML layouts, and StylePacks to resolve effect pipelines by name.

Registering Custom Post Effect

UiPostEffectDefinition crtDef = UiPostEffectDefinition.create("mymod:crt")
    .pass("mymod:scanlines")
    .pass("mymod:curvature")
    .build();
UiPostEffectRegistry.global().register(crtDef);

API

UiPostEffectRegistry::definitions()

definitions()

Returns a snapshot list of all registered definitions.

Returns List: Resulting List..

UiPostEffectRegistry::find(String)

find(String)

Looks up an effect definition by identifier.

Parameter	Type	Description
id	String	Effect identifier.

Returns Optional: Resulting Optional..

UiPostEffectRegistry::global()

global()

Returns the global post-effect registry singleton.

Returns UiPostEffectRegistry: Resulting UiPostEffectRegistry..

UiPostEffectRegistry::ids()

ids()

Returns an immutable list of all registered effect identifiers.

Returns List: Resulting List..

UiPostEffectRegistry::register(UiPostEffectDefinition)

register(UiPostEffectDefinition)

Registers an effect definition replacing any previous registration with the same ID.

Parameter	Type	Description
definition	UiPostEffectDefinition	Definition to register.

Returns UiPostEffectRegistry: Resulting UiPostEffectRegistry..

UiPostEffectRegistry::unregister(String)

unregister(String)

Removes an effect definition by identifier.

Parameter	Type	Description
id	String	Effect identifier.

Returns boolean: Resulting boolean..