PIXI

Class: BlurXFilter

PIXI.filters. BlurXFilter

The BlurXFilter applies a horizontal Gaussian blur to an object.

new PIXI.filters.BlurXFilter(strength, quality, resolution, kernelSize)

filters/blur/BlurXFilter.js, line 15
Name Type Default Description
strength number

The strength of the blur filter.
quality number

The quality of the blur filter.
resolution number

The resolution of the blur filter.
kernelSize number 5 optional

The kernelSize of the blur filter.Options: 5, 7, 9, 11, 13, 15.

Extends

Members

blurnumber

Sets the strength of both the blur.

Default Value:
  • 16

enabledboolean

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

fragmentSrcstring

The fragment shader.

paddingnumber

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.

qualitynumber

Sets the quality of the blur by modifying the number of passes. More passes means higher
quaility bluring but the lower the performance.

Default Value:
  • 4

resolutionnumber

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

uniformsobject

An object containing the current values of custom uniforms.

Example

Updating the value of a custom uniform

filter.uniforms.time = performance.now();

vertexSrcstring

The vertex shader.

Methods

apply(filterManager, input, output, clear)

filters/blur/BlurXFilter.js, line 54

Applies the filter.

Name Type Description
filterManager PIXI.FilterManager

The manager.
input PIXI.RenderTarget

The input target.
output PIXI.RenderTarget

The output target.
clear boolean

Should the output be cleared before rendering?