API Documentation

Complete reference for using the ForgeNoise library in your projects

Constructor 

new ForgeNoise(seed)

Parameters

Initializes a noise generator with an optional seed for reproducibility.

  • seed (Number, optional): Random seed value to ensure reproducible results

Noise Functions

generate2D(x, y)

Generates 2D Perlin noise at the specified coordinates.

  • x (Number): X-coordinate
  • y (Number): Y-coordinate
  • Returns: Number in range [-1, 1]

generate3D(x, y, z)

Generates 3D Perlin noise at the specified coordinates.

  • x (Number): X-coordinate
  • y (Number): Y-coordinate
  • z (Number): Z-coordinate
  • Returns: Number in range [-1, 1]

generateSimplex2D(x, y)

Generates 2D Simplex noise at the specified coordinates.

  • x (Number): X-coordinate
  • y (Number): Y-coordinate
  • Returns: Number in range [-1, 1]

generateWorley2D(x, y)

Generates 2D Worley noise at the specified coordinates.

  • x (Number): X-coordinate
  • y (Number): Y-coordinate
  • Returns: Number in range [0, ~1.414]

Advanced Functions

warp2D(x, y, options)

Generates 2D warped noise using domain warping technique.

  • x (Number): X-coordinate
  • y (Number): Y-coordinate
  • options (Object):
    • warpStrength (Number): Controls distortion amount
    • warpScale (Number): Controls frequency of distortion
    • iterations (Number): Number of warping iterations
  • Returns: Number in range [-1, 1]

generateFractal2D(x, y, options)

Generates 2D fractal Brownian motion (fBm) noise.

  • x (Number): X-coordinate
  • y (Number): Y-coordinate
  • options (Object):
    • octaves (Number): Number of noise layers
    • lacunarity (Number): How frequency increases each octave
    • persistence (Number): How amplitude diminishes each octave
    • scale (Number): Initial frequency scale
    • normalized (Boolean): Whether to normalize output value
    • ridged (Boolean): Whether to use ridged noise
    • turbulence (Boolean): Whether to use turbulence
  • Returns: Number in range [-1, 1]

Range Mapping

generate2D01(x, y)

2D Perlin noise mapped to range [0, 1].

  • x (Number): X-coordinate
  • y (Number): Y-coordinate
  • Returns: Number in range [0, 1]

generateSimplex2D01(x, y)

2D Simplex noise mapped to range [0, 1].

  • x (Number): X-coordinate
  • y (Number): Y-coordinate
  • Returns: Number in range [0, 1]

generateWorley2D01(x, y)

2D Worley noise mapped to range [0, 1].

  • x (Number): X-coordinate
  • y (Number): Y-coordinate
  • Returns: Number in range [0, 1]