Api Sandbox Utility Noise
class

Noise

public static abstract sealed class Noise

Provides access to coherent noise utilities. All of these functions should return between 0 and 1.

Methods

static Single Perlin(Single x, Single y = 0)

2D Perlin noise function. For a thread-safe alternative with more options, use Parameters).

x — Input on the X axis.
y — Input on the Y axis.
returns — Resulting noise at given coordinates, in range of 0 to 1.
static Single Perlin(Single x, Single y, Single z)

3D Perlin noise function. For a thread-safe alternative with more options, use Parameters).

x — Input on the X axis.
y — Input on the Y axis.
z — Input on the Z axis.
returns — Resulting noise at given coordinates, in range of 0 to 1.
static Single Simplex(Single x, Single y = 0)

2D Simplex noise function. For a thread-safe alternative with more options, use Parameters).

x — Input on the X axis.
y — Input on the Y axis.
returns — Resulting noise at given coordinates, in range of 0 to 1.
static Single Simplex(Single x, Single y, Single z)

3D Simplex noise function. For a thread-safe alternative with more options, use Parameters).

x — Input on the X axis.
y — Input on the Y axis.
z — Input on the Z axis.
returns — Resulting noise at given coordinates, in range of 0 to 1.
static Single Fbm(Int32 octaves, Single x, Single y = 0, Single z = 0)

Fractional Brownian Motion noise, a.k.a. Fractal Perlin noise. For a thread-safe alternative with more options, use Parameters) with FractalParameters.

octaves — Number of octaves for the noise. Higher values are slower but produce more detailed results. 3 is a good starting point.
x — Input on the X axis.
y — Input on the Y axis.
z — Input on the Z axis.
returns — Resulting noise at given coordinates, in range of 0 to 1.
static Vector3 FbmVector(Int32 octaves, Single x, Single y = 0)

Fractional Brownian Motion noise, a.k.a. Fractal Perlin noise.

octaves — Number of octaves for the noise. Higher values are slower but produce more detailed results. 3 is a good starting point.
x — Input on the X axis.
y — Input on the Y axis.
static INoiseField ValueField(Parameters parameters)

Creates a Value noise field, effectively smoothly sampled white noise. Use a FractalParameters for the field to have multiple octaves.

static INoiseField PerlinField(Parameters parameters)

Creates a Perlin noise field, which smoothly samples a grid of random gradients. Use a FractalParameters for the field to have multiple octaves.

static INoiseField SimplexField(Parameters parameters)

Creates a Simplex noise field, a cheaper gradient noise function similar to Parameters). Use a FractalParameters for the field to have multiple octaves.

Assembly: Sandbox.System Namespace: Sandbox.Utility Full Name: Sandbox.Utility.Noise