API Docs for: 2.2.1
Show:

DisplacementFilter Class

Extends AbstractFilter
Defined in: pixi/filters/DisplacementFilter.hx:9

The DisplacementFilter class uses the pixel values from the specified texture (called the displacement map) to perform a displacement of an object. You can use this filter to apply all manor of crazy warping effects Currently the r property of the texture is used offset the x and the g property of the texture is used to offset the y.

Constructor

DisplacementFilter

(
  • texture
)

Defined in pixi/filters/DisplacementFilter.hx:9

Parameters:

  • texture Texture

    The texture used for the displacement map * must be power of 2 texture at the moment

Methods

onTextureLoaded

()

Defined in pixi/filters/DisplacementFilter.hx:36

Sets the map dimensions uniforms when the texture becomes available.

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