melonJS
    Preparing search index...

    Class OutlineEffect

    A shader effect that draws a colored outline around the sprite. Works by sampling neighboring pixels — if any neighbor is opaque but the current pixel is transparent, it draws the outline color. Commonly used for selection highlights, hover states, or collectible glow.

    Renderable.shader for usage

    // yellow outline for selection
    mySprite.shader = new OutlineEffect(renderer, {
        color: [1.0, 1.0, 0.0],
        width: 2.0,
    });

    // remove the effect
    mySprite.shader = undefined;

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _enabledBeforeSuspend destroyed enabled

    Methods

    destroy setColor setTextureSize setUniform setWidth

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

    Methods

    • set the texture size for accurate outline width calculation

      Parameters

      • width: number

        texture width in pixels

      • height: number

        texture height in pixels

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods