PIXI

Class: ConvolutionFilter

PIXI.filters. ConvolutionFilter

new PIXI.filters.ConvolutionFilter(matrix, width, height)

filters/convolution/ConvolutionFilter.js, line 19

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.

Name Type Description
matrix Array.<number>

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

Extends

Members

heightnumber

Height of the object you are transforming

matrixArray.<number>

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

paddingnumber

The extra padding that the filter might need

uniformsobject

The uniforms as an object

widthnumber

Width of the object you are transforming

Methods

inherited applyFilter(renderer, input, output, clear)

core/renderers/webgl/filters/AbstractFilter.js, line 93

Applies the filter

Name Type Description
renderer PIXI.WebGLRenderer

The renderer to retrieve the filter from
input PIXI.RenderTarget
output PIXI.RenderTarget
clear boolean

Whether or not we want to clear the outputTarget

inherited getShader(renderer)

core/renderers/webgl/filters/AbstractFilter.js, line 64

Grabs a shader from the current renderer

Name Type Description
renderer PIXI.WebGLRenderer

The renderer to retrieve the shader from

inherited syncUniform()

core/renderers/webgl/filters/AbstractFilter.js, line 104

Syncs a uniform between the class object and the shaders.