Class SpriteMaskFilter

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

WebGL only.

Memberof

PIXI

Hierarchy (View Summary)

Constructors

constructor

Properties

autoFit disposeRunner enabled legacy maskMatrix multisample padding program state uniformGroup defaultMultisample defaultResolution SOURCE_KEY_MAP

Accessors

blendMode maskSprite resolution uniforms defaultFragmentSrc defaultVertexSrc

Methods

apply checkUniformExists destroy from

Constructors

constructor

  • new SpriteMaskFilter(sprite: IMaskTarget): SpriteMaskFilter

  • Parameters

    Returns SpriteMaskFilter

  • new SpriteMaskFilter(
        vertexSrc?: string,
        fragmentSrc?: string,
        uniforms?: Dict<any>,
    ): SpriteMaskFilter

  • Parameters

    • OptionalvertexSrc: string

      The source of the vertex shader.

    • OptionalfragmentSrc: string

      The source of the fragment shader.

    • Optionaluniforms: Dict<any>

      Custom uniforms to use to augment the built-in ones.

    Returns SpriteMaskFilter

Properties

autoFit

autoFit: boolean

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

Default

true

disposeRunner

disposeRunner: Runner<any, any[]>

enabled

enabled: boolean

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

Readonlylegacy

legacy: boolean

Legacy filters use position and uvs from attributes (set by filter system)

maskMatrix

maskMatrix: Matrix

Mask matrix

multisample

multisample: null | MSAA_QUALITY

The samples override of the filter instance. If set to null, the sample count of the current render target is used.

Default

PIXI.Filter.defaultMultisample

padding

padding: number

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

program: Program

Program that the shader uses.

state

state: State

The WebGL state the filter requires to render.

uniformGroup

uniformGroup: UniformGroup<Dict<any>>

StaticdefaultMultisample

defaultMultisample: null | MSAA_QUALITY

Default filter samples for any filter.

Static

Default

PIXI.MSAA_QUALITY.NONE

StaticdefaultResolution

defaultResolution: null | number

Default filter resolution for any filter.

Static

StaticSOURCE_KEY_MAP

SOURCE_KEY_MAP: Dict<string>

Used for caching shader IDs.

Accessors

blendMode

  • get blendMode(): BLEND_MODES

  • Sets the blend mode of the filter.

    Returns BLEND_MODES

    Default

    PIXI.BLEND_MODES.NORMAL
  • set blendMode(value: BLEND_MODES): void

  • Parameters

    Returns void

maskSprite

  • get maskSprite(): IMaskTarget

  • Sprite mask

    Returns IMaskTarget

  • set maskSprite(value: IMaskTarget): void

  • Parameters

    Returns void

resolution

  • get resolution(): null | number

  • The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter. If set to null or 0, the resolution of the current render target is used.

    Returns null | number

    Default

    PIXI.Filter.defaultResolution
  • set resolution(value: null | number): void

  • Parameters

    • value: null | number

    Returns void

uniforms

  • get uniforms(): Dict<any>

  • Shader uniform values, shortcut for uniformGroup.uniforms.

    Returns Dict<any>

StaticdefaultFragmentSrc

  • get defaultFragmentSrc(): string

  • The default fragment shader source

    Returns string

StaticdefaultVertexSrc

  • get defaultVertexSrc(): string

  • The default vertex shader source

    Returns string

Methods

apply

checkUniformExists

destroy

  • destroy(): void

  • Returns void

Staticfrom

  • from(vertexSrc?: string, fragmentSrc?: string, uniforms?: Dict<any>): Shader

  • A short hand function to create a shader based of a vertex and fragment shader.

    Parameters

    • OptionalvertexSrc: string

      The source of the vertex shader.

    • OptionalfragmentSrc: string

      The source of the fragment shader.

    • Optionaluniforms: Dict<any>

      Custom uniforms to use to augment the built-in ones.

    Returns Shader

    A shiny new PixiJS shader!

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods