PixelateHandle
Defined in: effects/src/handles.ts:44
Handle returned by pixelate.
Extends
Section titled “Extends”EffectHandle
Properties
Section titled “Properties”enabled
Section titled “enabled”
readonlyenabled:boolean
Defined in: renderer/dist/api-By3lEj26.d.ts:108
Whether the effect is currently enabled.
Inherited from
Section titled “Inherited from”EffectHandle.enabled
Methods
Section titled “Methods”fadeIn()
Section titled “fadeIn()”fadeIn(
duration):Process
Defined in: renderer/dist/api-By3lEj26.d.ts:112
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
Inherited from
Section titled “Inherited from”EffectHandle.fadeIn
fadeOut()
Section titled “fadeOut()”fadeOut(
duration):Process
Defined in: renderer/dist/api-By3lEj26.d.ts:114
Tween the effect’s primary intensity → 0 over duration seconds.
Parameters
Section titled “Parameters”duration
Section titled “duration”number
Returns
Section titled “Returns”Process
Inherited from
Section titled “Inherited from”EffectHandle.fadeOut
remove()
Section titled “remove()”remove():
void
Defined in: renderer/dist/api-By3lEj26.d.ts:104
Remove the effect immediately. Idempotent.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EffectHandle.remove
run(
p):Process
Defined in: renderer/dist/api-By3lEj26.d.ts:126
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
Inherited from
Section titled “Inherited from”EffectHandle.run
setEnabled()
Section titled “setEnabled()”setEnabled(
on):void
Defined in: renderer/dist/api-By3lEj26.d.ts:106
Toggle the effect without removing it. Flips the underlying filter’s .enabled.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EffectHandle.setEnabled
setIntensity()
Section titled “setIntensity()”setIntensity(
value):void
Defined in: renderer/dist/api-By3lEj26.d.ts:110
Set the effect’s primary intensity. Values are clamped to 0–1.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EffectHandle.setIntensity
setSize()
Section titled “setSize()”setSize(
value):void
Defined in: effects/src/handles.ts:45
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void