API Docs for: 2.2.1
Show:

ConvolutionFilter Class

Extends AbstractFilter
Defined in: pixi/filters/ConvolutionFilter.hx:6

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.

Constructor

ConvolutionFilter

(
  • matrix
  • width
  • height
)

Defined in pixi/filters/ConvolutionFilter.hx:6

Parameters:

  • 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

Item Index

Methods

Properties

Methods

syncUniforms

()

Inherited from AbstractFilter: pixi/filters/AbstractFilter.hx:16

Syncs the uniforms between the class object and the shaders.

Properties

fragmentSrc

Array private

Inherited from AbstractFilter: pixi/filters/AbstractFilter.hx:56

padding

Float

Inherited from AbstractFilter: pixi/filters/AbstractFilter.hx:29

passes

Array an array of filter objects

Inherited from AbstractFilter: pixi/filters/AbstractFilter.hx:35

An array of passes - some filters contain a few steps this array simply stores the steps in a liniear fashion. For example the blur filter has two passes blurX and blurY.

shaders

Array an array of shaders

Inherited from AbstractFilter: pixi/filters/AbstractFilter.hx:43

uniforms

Object private

Inherited from AbstractFilter: pixi/filters/AbstractFilter.hx:49