Options
All
  • Public
  • Public/Protected
  • All
Menu

System plugin to the renderer to manage stencils (used for masks).

memberof

PIXI

Hierarchy

  • AbstractMaskSystem
    • StencilSystem

Index

Constructors

constructor

  • Parameters

    • renderer: Renderer

      The renderer this System works for.

    Returns StencilSystem

Properties

Protected glConst

glConst: number

Protected maskStack

maskStack: MaskData[]

renderer

renderer: Renderer

Methods

Private _getBitwiseMask

  • _getBitwiseMask(): number
  • Fill 1s equal to the number of acitve stencil masks.

    Returns number

    The bitwise mask.

Private _useCurrent

  • _useCurrent(): void
  • Setup renderer to use the current stencil data.

    Returns void

destroy

  • destroy(): void
  • Destroys the mask stack.

    Returns void

getStackLength

  • getStackLength(): number
  • Returns number

pop

  • Pops stencil mask. MaskData is already removed from stack

    Parameters

    Returns void

push

  • Applies the Mask and adds it to the current stencil stack.

    Parameters

    Returns void

setMaskStack

  • setMaskStack(maskStack: MaskData[]): void
  • Changes the mask stack that is used by this System.

    Parameters

    Returns void

Generated using TypeDoc