Table of Contents

Class FastNoiseLite

Namespace
Shard.WorldGen.Noise
Assembly
Shard.WorldGen.dll
public class FastNoiseLite
Inheritance
FastNoiseLite
Inherited Members

Constructors

FastNoiseLite(int)

Create new FastNoise object with optional seed

public FastNoiseLite(int seed = 1337)

Parameters

seed int

Methods

DomainWarp(ref float, ref float)

2D warps the input position using current domain warp settings

public void DomainWarp(ref float x, ref float y)

Parameters

x float
y float

Examples

Example usage with GetNoise

DomainWarp(ref x, ref y)
    noise = GetNoise(x, y)

DomainWarp(ref float, ref float, ref float)

3D warps the input position using current domain warp settings

public void DomainWarp(ref float x, ref float y, ref float z)

Parameters

x float
y float
z float

Examples

Example usage with GetNoise

DomainWarp(ref x, ref y, ref z)
    noise = GetNoise(x, y, z)

GetNoise(float, float)

2D noise at given position using current settings

public float GetNoise(float x, float y)

Parameters

x float
y float

Returns

float

Noise output bounded between -1...1

GetNoise(float, float, float)

3D noise at given position using current settings

public float GetNoise(float x, float y, float z)

Parameters

x float
y float
z float

Returns

float

Noise output bounded between -1...1

SetCellularDistanceFunction(CellularDistanceFunction)

Sets distance function used in cellular noise calculations

public void SetCellularDistanceFunction(FastNoiseLite.CellularDistanceFunction cellularDistanceFunction)

Parameters

cellularDistanceFunction FastNoiseLite.CellularDistanceFunction

Remarks

Default: Distance

SetCellularJitter(float)

Sets the maximum distance a cellular point can move from it's grid position

public void SetCellularJitter(float cellularJitter)

Parameters

cellularJitter float

Remarks

Default: 1.0 Note: Setting this higher than 1 will cause artifacts

SetCellularReturnType(CellularReturnType)

Sets return type from cellular noise calculations

public void SetCellularReturnType(FastNoiseLite.CellularReturnType cellularReturnType)

Parameters

cellularReturnType FastNoiseLite.CellularReturnType

Remarks

Default: EuclideanSq

SetDomainWarpAmp(float)

Sets the maximum warp distance from original position when using DomainWarp(...)

public void SetDomainWarpAmp(float domainWarpAmp)

Parameters

domainWarpAmp float

Remarks

Default: 1.0

SetDomainWarpType(DomainWarpType)

Sets the warp algorithm when using DomainWarp(...)

public void SetDomainWarpType(FastNoiseLite.DomainWarpType domainWarpType)

Parameters

domainWarpType FastNoiseLite.DomainWarpType

Remarks

Default: OpenSimplex2

SetFractalGain(float)

Sets octave gain for all fractal noise types

public void SetFractalGain(float gain)

Parameters

gain float

Remarks

Default: 0.5

SetFractalLacunarity(float)

Sets octave lacunarity for all fractal noise types

public void SetFractalLacunarity(float lacunarity)

Parameters

lacunarity float

Remarks

Default: 2.0

SetFractalOctaves(int)

Sets octave count for all fractal noise types

public void SetFractalOctaves(int octaves)

Parameters

octaves int

Remarks

Default: 3

SetFractalPingPongStrength(float)

Sets strength of the fractal ping pong effect

public void SetFractalPingPongStrength(float pingPongStrength)

Parameters

pingPongStrength float

Remarks

Default: 2.0

SetFractalType(FractalType)

Sets method for combining octaves in all fractal noise types

public void SetFractalType(FastNoiseLite.FractalType fractalType)

Parameters

fractalType FastNoiseLite.FractalType

Remarks

Default: None Note: FractalType.DomainWarp... only affects DomainWarp(...)

SetFractalWeightedStrength(float)

Sets octave weighting for all none DomainWarp fratal types

public void SetFractalWeightedStrength(float weightedStrength)

Parameters

weightedStrength float

Remarks

Default: 0.0 Note: Keep between 0...1 to maintain -1...1 output bounding

SetFrequency(float)

Sets frequency for all noise types

public void SetFrequency(float frequency)

Parameters

frequency float

Remarks

Default: 0.01

SetNoiseType(NoiseType)

Sets noise algorithm used for GetNoise(...)

public void SetNoiseType(FastNoiseLite.NoiseType noiseType)

Parameters

noiseType FastNoiseLite.NoiseType

Remarks

Default: OpenSimplex2

SetRotationType3D(RotationType3D)

Sets domain rotation type for 3D Noise and 3D DomainWarp. Can aid in reducing directional artifacts when sampling a 2D plane in 3D

public void SetRotationType3D(FastNoiseLite.RotationType3D rotationType3D)

Parameters

rotationType3D FastNoiseLite.RotationType3D

Remarks

Default: None

SetSeed(int)

Sets seed used for all noise types

public void SetSeed(int seed)

Parameters

seed int

Remarks

Default: 1337