Realtime Fractal Renderer Documentation
fnl_state Struct Reference

#include <FastNoiseLite.h>

Collaboration diagram for fnl_state:
Collaboration graph

Data Fields

int seed
 
float frequency
 
fnl_noise_type noise_type
 
fnl_rotation_type_3d rotation_type_3d
 
fnl_fractal_type fractal_type
 
int octaves
 
float lacunarity
 
float gain
 
float weighted_strength
 
float ping_pong_strength
 
fnl_cellular_distance_func cellular_distance_func
 
fnl_cellular_return_type cellular_return_type
 
float cellular_jitter_mod
 
fnl_domain_warp_type domain_warp_type
 
float domain_warp_amp
 

Detailed Description

Structure containing entire noise system state.

Note
Must only be created using fnlCreateState(optional: seed). To ensure defaults are set.

Definition at line 126 of file FastNoiseLite.h.

Field Documentation

◆ cellular_distance_func

fnl_cellular_distance_func cellular_distance_func

The distance function used in cellular noise calculations.

Remarks
Default: FNL_CELLULAR_FUNC_DISTANCE

Definition at line 194 of file FastNoiseLite.h.

◆ cellular_jitter_mod

float cellular_jitter_mod

The maximum distance a cellular point can move from it's grid position.

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

Definition at line 207 of file FastNoiseLite.h.

◆ cellular_return_type

fnl_cellular_return_type cellular_return_type

The cellular return type from cellular noise calculations.

Remarks
Default: FNL_CELLULAR_RETURN_VALUE_EUCLIEANSQ

Definition at line 200 of file FastNoiseLite.h.

◆ domain_warp_amp

float domain_warp_amp

The maximum warp distance from original position when using fnlDomainWarp...

Remarks
Default: 1.0

Definition at line 219 of file FastNoiseLite.h.

◆ domain_warp_type

fnl_domain_warp_type domain_warp_type

The warp algorithm when using fnlDomainWarp...

Remarks
Default: OpenSimplex2

Definition at line 213 of file FastNoiseLite.h.

◆ fractal_type

fnl_fractal_type fractal_type

The method used for combining octaves for all fractal noise types.

Remarks
Default: None
FNL_FRACTAL_DOMAIN_WARP_... only effects fnlDomainWarp...

Definition at line 157 of file FastNoiseLite.h.

◆ frequency

float frequency

The frequency for all noise types.

Remarks
Default: 0.01

Definition at line 138 of file FastNoiseLite.h.

◆ gain

float gain

The octave gain for all fractal noise types.

Remarks
Default: 0.5

Definition at line 175 of file FastNoiseLite.h.

◆ lacunarity

float lacunarity

The octave lacunarity for all fractal noise types.

Remarks
Default: 2.0

Definition at line 169 of file FastNoiseLite.h.

◆ noise_type

fnl_noise_type noise_type

The noise algorithm to be used by GetNoise(...).

Remarks
Default: FNL_NOISE_OPENSIMPLEX2

Definition at line 144 of file FastNoiseLite.h.

◆ octaves

int octaves

The octave count for all fractal noise types.

Remarks
Default: 3

Definition at line 163 of file FastNoiseLite.h.

◆ ping_pong_strength

float ping_pong_strength

The strength of the fractal ping pong effect.

Remarks
Default: 2.0

Definition at line 188 of file FastNoiseLite.h.

◆ rotation_type_3d

fnl_rotation_type_3d rotation_type_3d

Sets noise rotation type for 3D.

Remarks
Default: FNL_ROTATION_NONE

Definition at line 150 of file FastNoiseLite.h.

◆ seed

int seed

Seed used for all noise types.

Remarks
Default: 1337

Definition at line 132 of file FastNoiseLite.h.

◆ weighted_strength

float weighted_strength

The octave weighting for all none Domaain Warp fractal types.

Remarks
Default: 0.0

Definition at line 182 of file FastNoiseLite.h.


The documentation for this struct was generated from the following file: