PixiJS

Class: DisplacementFilter

PIXI.filters.DisplacementFilter

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 to offset the x and the g property of the texture is used to offset the y.

new PIXI.filters.DisplacementFilter (sprite, scale)

DisplacementFilter.js:18
Name Type Description
sprite PIXI.Sprite

The sprite used for the displacement map. (make sure its added to the scene!)
scale number

The scale of the displacement

Extends

Members

autoFit boolean inherited

If enabled, PixiJS will fit the filter area into boundaries for better performance. Switch it off if it does not work for specific shader.

blendMode number inherited

Sets the blendmode of the filter

Default Value:
  • PIXI.BLEND_MODES.NORMAL

enabled boolean inherited

If enabled is true the filter is applied, if false it will not.

fragmentSrc string inherited

The fragment shader.

map PIXI.Texture

The texture used for the displacement map. Must be power of 2 sized texture.

padding number inherited

The padding of the filter. Some filters require extra space to breath such as a blur. Increasing this will add extra width and height to the bounds of the object that the filter is applied to.

resolution number inherited

The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter.

uniforms object inherited

An object containing the current values of custom uniforms.

Example

Updating the value of a custom uniform

filter.uniforms.time = performance.now();

vertexSrc string inherited

The vertex shader.

Methods

apply (filterManager, input, output) overrides

DisplacementFilter.js:59

Applies the filter.

Name Type Description
filterManager PIXI.FilterManager

The manager.
input PIXI.RenderTarget

The input target.
output PIXI.RenderTarget

The output target.