Zn_FastNoiseLiteGradient — C# API

Generates coherent and fractal noise gradients using the FastNoiseLite(https://github.com/Auburn/FastNoiseLite) library.

class Zn_FastNoiseLiteGradientReckfellSharpInherits Resource

Generates coherent and fractal noise gradients using the FastNoiseLite(https://github.com/Auburn/FastNoiseLite) library.

This is an alternate implementation of FastNoiseLite, because Reckfell's integration does not expose methods to access gradients directly. These algorithms are specialized to generate vectors to perturb positions, and can be faster than calculating 2 or 3 times a regular noise.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

Zn_FastNoiseLiteGradientConstructor

# Zn_FastNoiseLiteGradient

C#
public Zn_FastNoiseLiteGradient();

Properties9

AmplitudeProperty

# Amplitude

C#
public float Amplitude { get; set; }

FractalGainProperty

# FractalGain

C#
public float FractalGain { get; set; }

FractalLacunarityProperty

# FractalLacunarity

C#
public float FractalLacunarity { get; set; }

FractalOctavesProperty

# FractalOctaves

C#
public int FractalOctaves { get; set; }

FractalTypeProperty

# FractalType

C#
public Zn_FastNoiseLiteGradient.FractalTypeEnum FractalType { get; set; }

NoiseTypeProperty

# NoiseType

C#
public Zn_FastNoiseLiteGradient.NoiseTypeEnum NoiseType { get; set; }

PeriodProperty

# Period

C#
public float Period { get; set; }

RotationType3DProperty

# RotationType3D

C#
public Zn_FastNoiseLiteGradient.RotationType3DEnum RotationType3D { get; set; }

SeedProperty

# Seed

C#
public int Seed { get; set; }

Methods20

GetAmplitudefloat

# GetAmplitude

C#
public float GetAmplitude();

Returns float

GetFractalGainfloat

# GetFractalGain

C#
public float GetFractalGain();

Returns float

GetFractalLacunarityfloat

# GetFractalLacunarity

C#
public float GetFractalLacunarity();

Returns float

GetFractalOctavesint

# GetFractalOctaves

C#
public int GetFractalOctaves();

Returns int

GetFractalTypeZn_FastNoiseLiteGradient.FractalTypeEnum

# GetFractalType

C#
public Zn_FastNoiseLiteGradient.FractalTypeEnum GetFractalType();

Returns Zn_FastNoiseLiteGradient.FractalTypeEnum

GetNoiseTypeZn_FastNoiseLiteGradient.NoiseTypeEnum

# GetNoiseType

C#
public Zn_FastNoiseLiteGradient.NoiseTypeEnum GetNoiseType();

Returns Zn_FastNoiseLiteGradient.NoiseTypeEnum

GetPeriodfloat

# GetPeriod

C#
public float GetPeriod();

Returns float

GetRotationType3DZn_FastNoiseLiteGradient.RotationType3DEnum

# GetRotationType3D

C#
public Zn_FastNoiseLiteGradient.RotationType3DEnum GetRotationType3D();

Returns Zn_FastNoiseLiteGradient.RotationType3DEnum

GetSeedint

# GetSeed

C#
public int GetSeed();

Returns int

SetAmplitudevoid

# SetAmplitude

C#
public void SetAmplitude(float amplitude);

Parameters
Name	Type	Default
`amplitude`	`float`	—

SetFractalGainvoid

# SetFractalGain

C#
public void SetFractalGain(float gain);

Parameters
Name	Type	Default
`gain`	`float`	—

SetFractalLacunarityvoid

# SetFractalLacunarity

C#
public void SetFractalLacunarity(float lacunarity);

Parameters
Name	Type	Default
`lacunarity`	`float`	—

SetFractalOctavesvoid

# SetFractalOctaves

C#
public void SetFractalOctaves(int octaves);

Parameters
Name	Type	Default
`octaves`	`int`	—

SetFractalTypevoid

# SetFractalType

C#
public void SetFractalType(Zn_FastNoiseLiteGradient.FractalTypeEnum type);

Parameters
Name	Type	Default
`type`	`Zn_FastNoiseLiteGradient.FractalTypeEnum`	—

SetNoiseTypevoid

# SetNoiseType

C#
public void SetNoiseType(Zn_FastNoiseLiteGradient.NoiseTypeEnum type);

Parameters
Name	Type	Default
`type`	`Zn_FastNoiseLiteGradient.NoiseTypeEnum`	—

SetPeriodvoid

# SetPeriod

C#
public void SetPeriod(float period);

Parameters
Name	Type	Default
`period`	`float`	—

SetRotationType3Dvoid

# SetRotationType3D

C#
public void SetRotationType3D(Zn_FastNoiseLiteGradient.RotationType3DEnum type);

Parameters
Name	Type	Default
`type`	`Zn_FastNoiseLiteGradient.RotationType3DEnum`	—

SetSeedvoid

# SetSeed

C#
public void SetSeed(int seed);

Parameters
Name	Type	Default
`seed`	`int`	—

Warp2DVector2

# Warp2D

C#
public Vector2 Warp2D(Vector2 position);

Parameters
Name	Type	Default
`position`	`Vector2`	—

Returns Vector2

Warp3DVector3

# Warp3D

C#
public Vector3 Warp3D(Vector3 position);

Parameters
Name	Type	Default
`position`	`Vector3`	—

Returns Vector3

Zn_FastNoiseLiteGradient.FractalTypeEnum

Value	Description
`DomainWarpIndependent = 2`
`DomainWarpProgressive = 1`
`None = 0`

Zn_FastNoiseLiteGradient.NoiseTypeEnum

Value	Description
`OpenSimplex2 = 0`
`OpenSimplex2Reduced = 1`
`Value = 2`

Zn_FastNoiseLiteGradient.RotationType3DEnum

Value	Description
`ImproveXyPlanes = 1`
`ImproveXzPlanes = 2`
`None = 0`