the current renderer instance
Optionaloptions: { strength?: number; textureSize?: number[] } = {}effect options
Optionalstrength?: numberblur strength in texels
OptionaltextureSize?: number[]texture dimensions [width, height]
Readonlydestroyedtrue once destroy has been called. Distinct from
enabled — which also toggles transiently across a context
lost / restored cycle — to give callers a stable signal for
"this effect has been explicitly released."
whether this effect is active (false in Canvas mode, false after
destroy, and false while the WebGL context is suspended
between an ONCONTEXT_LOST and the matching ONCONTEXT_RESTORED
event).
destroy this shader effect. Idempotent — calling destroy twice is safe. Unsubscribes from the renderer's context-lost / restored events so a destroyed effect is not auto-reactivated.
set the blur strength
blur strength in texels
set the texture size
texture width in pixels
texture height in pixels
Set the uniform to the given value
the uniform name
the value to assign to that uniform
A shader effect that applies a box blur to the sprite. Commonly used for background defocus, depth-of-field simulation, or UI backdrop blur.
See
Renderable.shader for usage
Example