Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SimplexNoise

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

Hierarchy

  • SimplexNoise

Index

Constructors

Methods

Constructors

constructor

  • Creates a new SimplexNoise instance. This involves some setup. You can save a few cpu cycles by reusing the same instance.

    Parameters

    • randomOrSeed: string | number | RandomFn = ...

      A random number generator or a seed (string|number). Defaults to Math.random (random irreproducible initialization).

    Returns SimplexNoise

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]

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]

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]

Generated using TypeDoc