Class: NoiseFilter

Extends

• PIXI.Filter

Members

autoFitboolean

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

blendModenumber

Sets the blendmode of the filter

Default Value:

• PIXI.BLEND_MODES.NORMAL

enabledboolean

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

fragmentSrcstring

The fragment shader.

noisenumber

The amount of noise to apply, this value should be in the range (0, 1].

Default Value:

• 0.5

paddingnumber

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.

resolutionnumber

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

seednumber

A seed value to apply to the random noise generation. Math.random() is a good value to use.

uniformsobject

An object containing the current values of custom uniforms.

Example

Updating the value of a custom uniform

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

vertexSrcstring

The vertex shader.

Methods

inherited apply(filterManager, input, output, clear, currentState)

Filter.js:117

Applies the filter

Name	Type	Description
filterManager	PIXI.FilterManager	The renderer to retrieve the filter from
input	PIXI.RenderTarget	The input render target.
output	PIXI.RenderTarget	The target to output to.
clear	boolean	Should the output be cleared before rendering to it
currentState	object	optional It's current state of filter. There are some useful properties in the currentState : target, filters, sourceFrame, destinationFrame, renderTarget, resolution