Options
All
  • Public
  • Public/Protected
  • All
Menu

System plugin to the renderer to manage scissor masking.

Scissor masking discards pixels outside of a rectangle called the scissor box. The scissor box is in the framebuffer viewport's space; however, the mask's rectangle is projected from world-space to viewport space automatically by this system.

memberof

PIXI

Hierarchy

  • AbstractMaskSystem
    • ScissorSystem

Index

Constructors

constructor

  • Parameters

    • renderer: Renderer

      The renderer this System works for.

    Returns ScissorSystem

Properties

Protected glConst

glConst: number

Protected maskStack

maskStack: MaskData[]

renderer

renderer: Renderer

Methods

Private _useCurrent

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

    Returns void

destroy

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

    Returns void

getStackLength

  • getStackLength(): number
  • Returns number

pop

  • pop(): void
  • This should be called after a mask is popped off the mask stack. It will rebind the scissor box to be latest with the last mask in the stack.

    This can also be called when you directly modify the scissor box and want to restore PixiJS state.

    Returns void

push

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

    author

    alvin

    Parameters

    Returns void

setMaskStack

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

    Parameters

    Returns void

Generated using TypeDoc