pixi.js
    Preparing search index...

    Class AlphaMaskAdvanced

    AlphaMask is an effect that applies a mask to a container using a sprite texture. By default, the red channel of the mask texture controls visibility. Set channel to 'alpha' to use the alpha channel instead, which is useful for masks defined by transparency. The mask can be inverted, and non-sprite masks are rendered to a texture automatically.

    Implements

    Index

    Constructors

    Properties

    channel: MaskChannel = 'red'
    inverse: boolean = false
    mask: Container
    pipe: string = 'alphaMask'
    priority: number = 0
    renderMaskToTexture: boolean
    extension: ExtensionMetadata = ExtensionType.MaskEffect

    Methods

    • Parameters

      • bounds: Bounds
      • OptionalskipUpdateTransform: boolean

      Returns void

    • Parameters

      Returns void

    • Returns void

    • Parameters

      • mask: any

      Returns boolean