Navigation
These archived docs are for Phaser 2.2.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

PIXI. ConvolutionFilter

new ConvolutionFilter(matrix, width, height)

The ConvolutionFilter class applies a matrix convolution filter effect. A convolution combines pixels in the input image with neighboring pixels to produce a new image. A wide variety of image effects can be achieved through convolutions, including blurring, edge detection, sharpening, embossing, and beveling. The matrix should be specified as a 9 point Array. See http://docs.gimp.org/en/plug-in-convmatrix.html for more info.

Parameters
Name Type Description
matrix Array

An array of values used for matrix transformation. Specified as a 9 point Array.

width Number

Width of the object you are transforming

height Number

Height of the object you are transforming

Source code: pixi/filters/ConvolutionFilter.js, line 1

Extends

Public Properties

dirty : boolean

Inherited From
Source code: pixi/filters/AbstractFilter.js, line 31

height : number

Height of the object you are transforming

Source code: pixi/filters/ConvolutionFilter.js, line 93

matrix : Array

An array of values used for matrix transformation. Specified as a 9 point Array.

Source code: pixi/filters/ConvolutionFilter.js, line 63

padding : number

Inherited From
Source code: pixi/filters/AbstractFilter.js, line 37

width : number

Width of the object you are transforming

Source code: pixi/filters/ConvolutionFilter.js, line 78

Public Methods

syncUniforms()

Syncs the uniforms between the class object and the shaders.

Inherited From
Source code: pixi/filters/AbstractFilter.js, line 60