EffectHandle
Defined in: renderer/dist/api-COFaMdt3.d.ts:100
The runtime handle returned by addEffect. Lets the caller toggle, remove,
or fade an effect without tracking its slot in the underlying pixi
filters array.
Effect factories may return a richer handle that extends this — see each
factory’s typed return for extras like setThickness or trigger.
Extended by
Section titled “Extended by”HitFlashHandleBloomHandleOutlineHandleDropShadowHandlePixelateHandleGlowHandleChromaticAberrationHandleVignetteHandleColorGradeHandleGodRayHandleShockwaveHandleMotionBlurHandleBulgePinchHandleHalftoneHandleWaveHandleColorizeHandleGlitchHandleZoomBlurHandleAxisBlurHandleImplosionHandleDissolveHandle
Properties
Section titled “Properties”enabled
Section titled “enabled”
readonlyenabled:boolean
Defined in: renderer/dist/api-COFaMdt3.d.ts:106
Whether the effect is currently enabled.
Methods
Section titled “Methods”fadeIn()
Section titled “fadeIn()”fadeIn(
duration):Process
Defined in: renderer/dist/api-COFaMdt3.d.ts:110
Tween the effect’s primary intensity 0 → 1 over duration seconds.
Parameters
Section titled “Parameters”duration
Section titled “duration”number
Returns
Section titled “Returns”Process
fadeOut()
Section titled “fadeOut()”fadeOut(
duration):Process
Defined in: renderer/dist/api-COFaMdt3.d.ts:112
Tween the effect’s primary intensity → 0 over duration seconds.
Parameters
Section titled “Parameters”duration
Section titled “duration”number
Returns
Section titled “Returns”Process
remove()
Section titled “remove()”remove():
void
Defined in: renderer/dist/api-COFaMdt3.d.ts:102
Remove the effect immediately. Idempotent.
Returns
Section titled “Returns”void
run(
p):Process
Defined in: renderer/dist/api-COFaMdt3.d.ts:124
Schedule a Process scoped to this effect’s lifetime. The process is
routed through the same ScopedProcessQueue the effect’s fades use —
pauses with the owning scene, time-scales with it, and is cancelled
automatically when the effect is removed.
Useful for factories that need timed work (e.g. a one-shot trigger ramp,
a uniform animator) without asking the caller to wire step(dt). The
returned Process can be cancelled early; otherwise it tears down with
the effect.
Parameters
Section titled “Parameters”Process
Returns
Section titled “Returns”Process
setEnabled()
Section titled “setEnabled()”setEnabled(
on):void
Defined in: renderer/dist/api-COFaMdt3.d.ts:104
Toggle the effect without removing it. Flips the underlying filter’s .enabled.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
setIntensity()
Section titled “setIntensity()”setIntensity(
value):void
Defined in: renderer/dist/api-COFaMdt3.d.ts:108
Set the effect’s primary intensity. Values are clamped to 0–1.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/effects.md.