melonJS
    Preparing search index...

    Class ScanlineEffect

    A shader effect that overlays horizontal scanlines on the sprite. Can optionally add barrel distortion and vignette for a full CRT monitor look.

    Renderable.shader for usage

    // simple scanlines
    mySprite.shader = new ScanlineEffect(renderer, { opacity: 0.3 });

    // full CRT look with curvature and vignette
    mySprite.shader = new ScanlineEffect(renderer, {
        opacity: 0.3,
        curvature: 0.02,
        vignetteStrength: 0.3,
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _enabledBeforeSuspend destroyed enabled

    Methods

    destroy setCurvature setOpacity setUniform setVignetteStrength

    Constructors

    • Parameters

      • renderer: WebGLRenderer

        the current renderer instance

      • Optionaloptions: { curvature?: number; opacity?: number; vignetteStrength?: number } = {}

        effect options

        • Optionalcurvature?: number

          barrel distortion strength (0.0 = flat, 0.02 = subtle CRT curve)

        • Optionalopacity?: number

          scanline darkness (0.0 = invisible, 1.0 = fully black lines)

        • OptionalvignetteStrength?: number

          edge darkening strength (0.0 = none, 0.3 = subtle)

      Returns ScanlineEffect

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

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods