Class: MockNoise

Mock of the X-Ray engine noise class for jest/node.

Implements

• noise

Constructors

Constructor

new MockNoise(
   intensity?: number, 
   grain?: number, 
   fps?: number): MockNoise;

Parameters

Parameter	Type	Default value
intensity	number	0
grain	number	1
fps	number	10

Returns

MockNoise

Methods

set()

set(
   intensity: number, 
   grain: number, 
   fps: number): this;

Set all noise values.

Parameters

Parameter	Type	Description
intensity	number	Noise intensity.
grain	number	Noise grain size.
fps	number	Noise frame rate.

Returns

this

This object for chained setup.

Implementation of

noise.set

---

create()

static create(
   intensity?: number, 
   grain?: number, 
   fps?: number): MockNoise;

Parameters

Parameter	Type	Default value
intensity	number	0
grain	number	1
fps	number	10

Returns

MockNoise

---

mock()

static mock(
   intensity?: number, 
   grain?: number, 
   fps?: number): noise;

Parameters

Parameter	Type	Default value
intensity	number	0
grain	number	1
fps	number	10

Returns

noise

Properties

fps

fps: number;

Noise frame rate.

Implementation of

noise.fps

---

grain

grain: number;

Noise grain size.

Implementation of

noise.grain

---

intensity

intensity: number;

Noise intensity.

Implementation of

noise.intensity