gameforge - v0.1.12
    Preparing search index...

    Class ScissorSystem

    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.

    PIXI

    Hierarchy

    • AbstractMaskSystem
      • ScissorSystem
    Index

    Constructors

    • Parameters

      • renderer: Renderer

        The renderer this System works for.

      Returns ScissorSystem

    Properties

    maskStack: MaskData[]

    The mask stack

    renderer: Renderer

    Methods

    • evaluates _boundsTransformed, _scissorRect for MaskData

      Parameters

      Returns void

    • Destroys the mask stack.

      Returns void

    • Gets count of masks of certain type.

      Returns number

    • 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.

      Parameters

      • OptionalmaskData: MaskData

        The mask data.

      Returns void

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

      Parameters

      Returns void

      alvin

    • Changes the mask stack that is used by this System.

      Parameters

      Returns void

    • Test, whether the object can be scissor mask with current renderer projection. Calls "calcScissorRect()" if its true.

      Parameters

      Returns boolean

      whether Whether the object can be scissor mask