phaser - v4.0.0-rc.4
    Preparing search index...

    Interface Alpha

    Provides methods used for setting the alpha properties of a Game Object. Should be applied as a mixin and not used directly.

    interface Alpha {
        alpha: number;
        alphaBottomLeft: number;
        alphaBottomRight: number;
        alphaTopLeft: number;
        alphaTopRight: number;
        clearAlpha(): this;
        setAlpha(
            topLeft?: number,
            topRight?: number,
            bottomLeft?: number,
            bottomRight?: number,
        ): this;
    }

    Implemented by

    Index

    Properties

    alpha alphaBottomLeft alphaBottomRight alphaTopLeft alphaTopRight

    Methods

    clearAlpha setAlpha

    Properties

    alpha: number

    The alpha value of the Game Object.

    This is a global value, impacting the entire Game Object, not just a region of it.

    alphaBottomLeft: number

    The alpha value starting from the bottom-left of the Game Object. This value is interpolated from the corner to the center of the Game Object.

    alphaBottomRight: number

    The alpha value starting from the bottom-right of the Game Object. This value is interpolated from the corner to the center of the Game Object.

    alphaTopLeft: number

    The alpha value starting from the top-left of the Game Object. This value is interpolated from the corner to the center of the Game Object.

    alphaTopRight: number

    The alpha value starting from the top-right of the Game Object. This value is interpolated from the corner to the center of the Game Object.

    Methods

    • Clears all alpha values associated with this Game Object.

      Immediately sets the alpha levels back to 1 (fully opaque).

      Returns this

    • Set the Alpha level of this Game Object. The alpha controls the opacity of the Game Object as it renders. Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.

      If your game is running under WebGL you can optionally specify four different alpha values, each of which correspond to the four corners of the Game Object. Under Canvas only the topLeft value given is used.

      Parameters

      • OptionaltopLeft: number

        The alpha value used for the top-left of the Game Object. If this is the only value given it's applied across the whole Game Object. Default 1.

      • OptionaltopRight: number

        The alpha value used for the top-right of the Game Object. WebGL only.

      • OptionalbottomLeft: number

        The alpha value used for the bottom-left of the Game Object. WebGL only.

      • OptionalbottomRight: number

        The alpha value used for the bottom-right of the Game Object. WebGL only.

      Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods