Class: ScissorSystem

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

new PIXI.ScissorSystem (renderer) overrides

Name Type Description
renderer PIXI.Renderer

The renderer this System works for.

Extends

Methods

calcScissorRect (maskData) void

evaluates _boundsTransformed, _scissorRect for MaskData

Name Type Description
maskData PIXI.MaskData

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.

push (maskData) void

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

Name Type Description
maskData PIXI.MaskData

The mask data.

testScissor (maskData) boolean

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

Name Type Description
maskData PIXI.MaskData

mask data

Returns:
Type Description
boolean whether Whether the object can be scissor mask

Inherited Properties

From class PIXI.AbstractMaskSystem

maskStack Array<PIXI.MaskData> protected inherited

The mask stack

Inherited Methods

From class PIXI.AbstractMaskSystem

Destroys the mask stack.

getStackLength () number inherited

Gets count of masks of certain type.

Returns:
Type Description
number

setMaskStack (maskStack) void inherited

Changes the mask stack that is used by this System.

Name Type Description
maskStack Array<PIXI.MaskData>

The mask stack