Class: NoiseFilter

PIXI.filters.NoiseFilter

A Noise effect filter.

new PIXI.filters.NoiseFilter (noise, seed)

Name Type Default Description
noise number 0.5 optional

The noise intensity, should be a normalized value in the range [0, 1].

seed number optional

A random seed for the noise generation. Default is Math.random().

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.

legacy boolean readonly inherited

Legacy filters use position and uvs from attributes

noise number

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

Default Value:
  • 0.5

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.

Program that the shader uses

resolution number inherited

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

seed number

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

The WebGL state the filter requires to render

uniforms object readonly inherited

Shader uniform values, shortcut for uniformGroup.uniforms

Methods

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

Applies the filter

Name Type Description
filterManager PIXI.systems.FilterSystem

The renderer to retrieve the filter from

input PIXI.RenderTexture

The input render target.

output PIXI.RenderTexture

The target to output to.

clearMode PIXI.CLEAR_MODES

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