MotionBlurHandle
Defined in: effects/src/handles.ts:108
Handle returned by motionBlur.
Extends
Section titled “Extends”EffectHandle
Properties
Section titled “Properties”enabled
Section titled “enabled”
readonlyenabled:boolean
Defined in: renderer/dist/api-BwbPRSMp.d.ts:18
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-BwbPRSMp.d.ts:20
Tween the effect’s primary intensity 0 → 1 over duration ms.
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-BwbPRSMp.d.ts:22
Tween the effect’s primary intensity → 0 over duration ms.
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-BwbPRSMp.d.ts:14
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-BwbPRSMp.d.ts:34
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-BwbPRSMp.d.ts:16
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
setVelocity()
Section titled “setVelocity()”setVelocity(
x,y):void
Defined in: effects/src/handles.ts:109
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void