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.

new PIXI.filters.AlphaFilter (alpha) overrides

Name Type Attributes Default Description
alpha number <optional>

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



alpha number

Coefficient for alpha multiplication

Default Value:
  • 1

Inherited Properties

From class PIXI.Filter

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.

Default Value:
  • true

blendMode number inherited

Sets the blendmode of the filter

Default Value:

enabled boolean inherited

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

Default Value:
  • true

legacy boolean readonly inherited

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

The samples of the filter.

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.

Default Value:
  • 0

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

From class PIXI.Shader

Program that the shader uses

uniforms object readonly inherited

Shader uniform values, shortcut for uniformGroup.uniforms

Inherited Methods

From class PIXI.Filter

apply (filterManager, input, output, clearMode, currentState) void inherited

Applies the filter

Name Type Attributes Description
filterManager PIXI.FilterSystem

The renderer to retrieve the filter from

input PIXI.RenderTexture

The input render target.

output PIXI.RenderTexture

The target to output to.

clearMode PIXI.CLEAR_MODES <optional>

Should the output be cleared before rendering to it.

currentState object <optional>

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

From class PIXI.Shader

destroy () void inherited