Class AlphaFilter

Simplest filter - applies alpha.

Use this instead of Container's alpha property to avoid visual layering of individual elements. AlphaFilter applies alpha evenly across the entire display object and any opaque elements it contains. If elements are not opaque, they will blend with each other anyway.

Very handy if you want to use common features of all filters:

  1. Assign a blendMode to this filter, blend all elements inside display object with background.

  2. To use clipping in display coordinates, assign a filterArea to the same container that has this filter.

Memberof

PIXI

Hierarchy (view full)

Constructors

constructor

Properties

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

Accessors

alpha blendMode resolution uniforms defaultFragmentSrc defaultVertexSrc

Methods

apply checkUniformExists destroy from

Constructors

constructor

  • new AlphaFilter(alpha?): Pixi.AlphaFilter

  • Parameters

    • Optional alpha: number

      Amount of alpha from 0 to 1, where 0 is transparent

    Returns Pixi.AlphaFilter

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.

Readonly legacy

legacy: boolean

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

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

Static SOURCE_KEY_MAP

SOURCE_KEY_MAP: Dict<string>

Used for caching shader IDs.

Static defaultMultisample

defaultMultisample: null | MSAA_QUALITY

Default filter samples for any filter.

Static

Default

PIXI.MSAA_QUALITY.NONE

Static defaultResolution

defaultResolution: null | number

Default filter resolution for any filter.

Static

Accessors

alpha

  • get alpha(): number

  • Coefficient for alpha multiplication

    Returns number

    Default

    1
  • set alpha(value): void

  • Parameters

    • value: number

    Returns void

blendMode

  • get blendMode(): BLEND_MODES

  • Sets the blend mode of the filter.

    Returns BLEND_MODES

    Default

    PIXI.BLEND_MODES.NORMAL
  • set blendMode(value): 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): void

  • Parameters

    • value: null | number

    Returns void

uniforms

  • get uniforms(): Dict<any>

  • Shader uniform values, shortcut for uniformGroup.uniforms.

    Returns Dict<any>

Static defaultFragmentSrc

  • get defaultFragmentSrc(): string

  • The default fragment shader source

    Returns string

Static defaultVertexSrc

  • get defaultVertexSrc(): string

  • The default vertex shader source

    Returns string

Methods

apply

  • apply(filterManager, input, output, clearMode?, _currentState?): void

  • Applies the filter

    Parameters

    • filterManager: FilterSystem

      The renderer to retrieve the filter from

    • input: RenderTexture

      The input render target.

    • output: RenderTexture

      The target to output to.

    • Optional clearMode: CLEAR_MODES

      Should the output be cleared before rendering to it.

    • Optional _currentState: FilterState

      It's current state of filter. There are some useful properties in the currentState : target, filters, sourceFrame, destinationFrame, renderTarget, resolution

    Returns void

checkUniformExists

  • checkUniformExists(name, group): boolean

  • Parameters

    Returns boolean

destroy

  • destroy(): void

  • Returns void

Static from

  • from(vertexSrc?, fragmentSrc?, uniforms?): Shader

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

    Parameters

    • Optional vertexSrc: string

      The source of the vertex shader.

    • Optional fragmentSrc: string

      The source of the fragment shader.

    • Optional uniforms: Dict<any>

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

    Returns Shader

    A shiny new PixiJS shader!

Settings

Member Visibility

Theme

On This Page

constructorautoFitdisposeRunnerenabledlegacymultisamplepaddingprogramstateuniformGroupSOURCE_KEY_MAPdefaultMultisampledefaultResolutionalphablendModeresolutionuniformsdefaultFragmentSrcdefaultVertexSrcapplycheckUniformExistsdestroyfrom

Generated using TypeDoc