PokéRogue
    Preparing search index...

    Interface Mask

    Provides methods used for setting, clearing, and creating masks on a Game Object.

    A mask clips the rendered output of a Game Object to the shape defined by a Graphics or Shape Game Object. Only pixels that fall within the mask geometry are drawn to the screen. Masks have no effect on physics or input detection; they are purely a visual rendering tool.

    This component only works under the Canvas Renderer. For WebGL, see Phaser.GameObjects.Components.FilterList#addMask.

    interface Mask {
        mask: GeometryMask;
        clearMask(destroyMask?: boolean): this;
        createGeometryMask<G extends Graphics, S extends Shape>(
            graphics?: Shape | Graphics,
        ): GeometryMask;
        setMask(mask: GeometryMask): this;
    }

    Implemented by

    Index
    mask
    clearMask createGeometryMask setMask
    mask: GeometryMask

    The Mask this Game Object is using during render, or null if no mask has been set.

    • Clears the mask that this Game Object was using.

      This only works in the Canvas Renderer. In WebGL, use a Mask filter instead (see Phaser.GameObjects.Components.FilterList#addMask).

      Parameters

      • OptionaldestroyMask: boolean

        Destroy the mask before clearing it? Default false.

      Returns this

      This Game Object instance.

    • Creates and returns a Geometry Mask. This mask can be used by any Game Object, including this one.

      To create the mask you need to pass in a reference to a Graphics Game Object.

      If you do not provide a graphics object, and this Game Object is an instance of a Graphics object, then it will use itself to create the mask.

      This means you can call this method to create a Geometry Mask from any Graphics Game Object.

      This only works in the Canvas Renderer. In WebGL, use a Mask filter instead (see Phaser.GameObjects.Components.FilterList#addMask).

      Type Parameters

      Parameters

      • Optionalgraphics: Shape | Graphics

        A Graphics Game Object, or any kind of Shape Game Object. The geometry within it will be used as the mask.

      Returns GeometryMask

      This Geometry Mask that was created.

    • Sets the mask that this Game Object will use to render with.

      The mask must have been previously created and must be a GeometryMask. This only works in the Canvas Renderer. In WebGL, use a Mask filter instead (see Phaser.GameObjects.Components.FilterList#addMask).

      If a mask is already set on this Game Object it will be immediately replaced.

      Masks are positioned in global space and are not relative to the Game Object to which they are applied. The reason for this is that multiple Game Objects can all share the same mask.

      Masks have no impact on physics or input detection. They are purely a rendering component that allows you to limit what is visible during the render pass.

      Parameters

      • mask: GeometryMask

        The mask this Game Object will use when rendering.

      Returns this

      This Game Object instance.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods