melonJS
    Preparing search index...

    Class GlowEffect

    A shader effect that adds a colored glow around the sprite. Similar to OutlineEffect but with a soft, blurred edge instead of a hard line. Commonly used for power-ups, magic items, or selection highlights.

    Renderable.shader for usage

    // blue glow for a magic item
    mySprite.shader = new GlowEffect(renderer, {
        color: [0.2, 0.5, 1.0],
        intensity: 1.5,
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _enabledBeforeSuspend destroyed enabled intensity

    Methods

    destroy setColor setIntensity setTextureSize setUniform

    Constructors

    • Parameters

      • renderer: WebGLRenderer

        the current renderer instance

      • Optionaloptions: { color?: number[]; intensity?: number; textureSize?: number[]; width?: number } = {}

        effect options

        • Optionalcolor?: number[]

          glow color as [r, g, b] (0.0–1.0)

        • Optionalintensity?: number

          glow brightness multiplier

        • OptionaltextureSize?: number[]

          texture dimensions [width, height]

        • Optionalwidth?: number

          glow spread in pixels

      Returns GlowEffect

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

    intensity: number

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods