Class SimplexNoise

Deterministic simplex noise generator suitable for 2D, 3D and 4D spaces.

Index

Constructors

Methods

noise2D noise3D noise4D

Constructors

constructor

new SimplexNoise(randomOrSeed?: string | number | RandomFn): SimplexNoise
Creates a new SimplexNoise instance. This involves some setup. You can save a few cpu cycles by reusing the same instance.
Parameters
- OptionalrandomOrSeed: string | number | RandomFn
  A random number generator or a seed (string|number). Defaults to Math.random (random irreproducible initialization).
Returns SimplexNoise
- Defined in node_modules/simplex-noise/dist/esm/simplex-noise.d.ts:16

Methods

noise2D

noise2D(x: number, y: number): number
Samples the noise field in 2 dimensions
Parameters
- x: number
- y: number
Returns number
a number in the interval [-1, 1]
- Defined in node_modules/simplex-noise/dist/esm/simplex-noise.d.ts:23

noise3D

noise3D(x: number, y: number, z: number): number
Samples the noise field in 3 dimensions
Parameters
- x: number
- y: number
- z: number
Returns number
a number in the interval [-1, 1]
- Defined in node_modules/simplex-noise/dist/esm/simplex-noise.d.ts:31

noise4D

noise4D(x: number, y: number, z: number, w: number): number
Samples the noise field in 4 dimensions
Parameters
- x: number
- y: number
- z: number
- w: number
Returns number
a number in the interval [-1, 1]
- Defined in node_modules/simplex-noise/dist/esm/simplex-noise.d.ts:39