the current renderer instance
Optionaloptions: { size?: number; strength?: number } = {}effect options
Optionalsize?: numbervignette spread multiplier (higher = smaller dark area)
Optionalstrength?: numberedge darkening power (lower = stronger darkening, higher = softer falloff)
whether this effect is active (false in Canvas mode)
destroy this shader effect
set the vignette size
spread multiplier (higher = smaller dark area)
set the vignette strength
edge darkening power (lower = stronger, higher = softer)
Set the uniform to the given value
the uniform name
the value to assign to that uniform
A shader effect that darkens the edges of the screen, drawing focus to the center. Commonly used for atmosphere, cinematic feel, or to naturally frame a camera viewport (e.g. minimap).
See
Renderable.shader for usage
Example
Example