Skip to content

Class: noise ​

Post-process noise settings.

Source ​

C++ class noise

Custom Constructor ​

noise

Remarks ​

Combined effectors keep the maximum intensity, grain, and FPS values.

Constructors ​

Constructor ​

ts
new noise(): noise;

Create default noise settings.

Returns ​

noise

Remarks ​

Defaults are intensity 0, grain 1, and 10 FPS.

Constructor ​

ts
new noise(
   intensity: number, 
   grain: number, 
   fps: number): noise;

Create noise settings with all values.

Parameters ​

ParameterTypeDescription
intensitynumberNoise intensity.
grainnumberNoise grain size.
fpsnumberNoise frame rate.

Returns ​

noise

Methods ​

set() ​

ts
set(
   intensity: number, 
   grain: number, 
   fps: number): noise;

Set all noise values.

Parameters ​

ParameterTypeDescription
intensitynumberNoise intensity.
grainnumberNoise grain size.
fpsnumberNoise frame rate.

Returns ​

noise

This object for chained setup.

Properties ​

fps ​

ts
fps: number;

Noise frame rate.


grain ​

ts
grain: number;

Noise grain size.


intensity ​

ts
intensity: number;

Noise intensity.