Class: ConvolutionFilter

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

Source:

Extends

Members


padding :number

The extra padding that the filter might need

Type:
  • number
Inherited From:
Source:

uniforms :object

The uniforms as an object

Type:
  • object
Inherited From:
Source:

Methods


applyFilter(renderer, input, output, clear)

Applies the filter

Parameters:
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 From:
Source:

getShader(renderer)

Grabs a shader from the current renderer

Parameters:
Name Type Description
renderer PIXI.WebGLRenderer

The renderer to retrieve the shader from

Inherited From:
Source:

syncUniform()

Syncs a uniform between the class object and the shaders.

Inherited From:
Source: