Class: SpriteMaskFilter

PIXI.SpriteMaskFilter

This handles a Sprite acting as a mask, as opposed to a Graphic.

WebGL only.

new PIXI.SpriteMaskFilter (sprite)

Name Type Description
sprite PIXI.Sprite

the target sprite

Extends

Members

autoFit boolean inherited

If enabled, PixiJS will fit the filter area into boundaries for better performance. Switch it off if it does not work for specific shader.

blendMode number inherited

Sets the blendmode of the filter

Default Value:
  • PIXI.BLEND_MODES.NORMAL

enabled boolean inherited

If enabled is true the filter is applied, if false it will not.

legacy boolean readonly inherited

Legacy filters use position and uvs from attributes

maskMatrix PIXI.Matrix

Mask matrix

maskSprite PIXI.Sprite

Sprite mask

padding number inherited

The padding of the filter. Some filters require extra space to breath such as a blur. Increasing this will add extra width and height to the bounds of the object that the filter is applied to.

Program that the shader uses

resolution number inherited

The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter.

The WebGL state the filter requires to render

uniforms object readonly inherited

Shader uniform values, shortcut for uniformGroup.uniforms

Methods

apply (filterManager, input, output, clear) overrides

Applies the filter

Name Type Description
filterManager PIXI.systems.FilterSystem

The renderer to retrieve the filter from

input PIXI.RenderTexture

The input render target.

output PIXI.RenderTexture

The target to output to.

clear boolean

Should the output be cleared before rendering to it.