Home Reference Source
import {NoiseEffect} from 'postprocessing/src/effects/NoiseEffect.js'
public class | source

NoiseEffect

Extends:

Effect → NoiseEffect

Indirect Implements:

A noise effect.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new noise effect.

Member Summary

Public Members
public get

Indicates whether the noise should be multiplied with the input color.

public set

Enables or disables noise premultiplication.

Inherited Summary

From class Effect
public

[key]: *

public

The effect attributes.

public

The blend mode of this effect.

public

Preprocessor macro definitions.

public

The fragment shader.

public

The name of this effect.

public

uniforms: Map<String, Uniform>

Shader uniforms.

public

The vertex shader.

public

Performs a shallow search for properties that define a dispose method and deletes them.

public

initialize(renderer: WebGLRenderer, alpha: Boolean)

Performs initialization tasks.

public

setDepthTexture(depthTexture: Texture, depthPacking: Number)

Sets the depth texture.

public

setSize(width: Number, height: Number)

Updates the size of this effect.

public

update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, delta: Number)

Updates the effect by performing supporting operations.

Public Constructors

public constructor(options: Object) source

Constructs a new noise effect.

Override:

Effect#constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

The options.

options.blendFunction BlendFunction
  • optional
  • default: BlendFunction.SCREEN

The blend function of this effect.

options.premultiply Boolean
  • optional
  • default: false

Whether the noise should be multiplied with the input color.

Public Members

public get premultiply: Boolean source

Indicates whether the noise should be multiplied with the input color.

public set premultiply: Boolean source

Enables or disables noise premultiplication.

You'll need to call EffectPass#recompile after changing this value.