melonJS
    Preparing search index...

    Class VignetteEffect

    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).

    Renderable.shader for usage

    // subtle vignette on the main camera
    app.viewport.shader = new VignetteEffect(renderer);

    // stronger cinematic vignette
    app.viewport.shader = new VignetteEffect(renderer, {
        strength: 0.3,
        size: 20.0,
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _enabledBeforeSuspend destroyed enabled size strength

    Methods

    destroy setSize setStrength setUniform

    Constructors

    Properties

    _enabledBeforeSuspend

    _enabledBeforeSuspend: boolean | undefined
    destroyed: boolean = false

    true 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."

    enabled: boolean = false

    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).

    size: number
    strength: number

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods