Open 3D Engine FastNoise Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
FastNoise Class Reference

Public Types

enum  NoiseType : int {
  Value , ValueFractal , Perlin , PerlinFractal ,
  Simplex , SimplexFractal , Cellular , WhiteNoise ,
  Cubic , CubicFractal
}
 
enum  Interp : int { Linear , Hermite , Quintic }
 
enum  FractalType : int { FBM , Billow , RigidMulti }
 
enum  CellularDistanceFunction : int { Euclidean , Manhattan , Natural }
 
enum  CellularReturnType : int {
  CellValue , NoiseLookup , Distance , Distance2 ,
  Distance2Add , Distance2Sub , Distance2Mul , Distance2Div
}
 

Public Member Functions

 FastNoise (int seed=1337)
 
void SetSeed (int seed)
 
int GetSeed () const
 
void SetFrequency (FN_DECIMAL frequency)
 
FN_DECIMAL GetFrequency () const
 
void SetInterp (Interp interp)
 
Interp GetInterp () const
 
void SetNoiseType (NoiseType noiseType)
 
NoiseType GetNoiseType () const
 
void SetFractalOctaves (int octaves)
 
int GetFractalOctaves () const
 
void SetFractalLacunarity (FN_DECIMAL lacunarity)
 
FN_DECIMAL GetFractalLacunarity () const
 
void SetFractalGain (FN_DECIMAL gain)
 
FN_DECIMAL GetFractalGain () const
 
void SetFractalType (FractalType fractalType)
 
FractalType GetFractalType () const
 
void SetCellularDistanceFunction (CellularDistanceFunction cellularDistanceFunction)
 
CellularDistanceFunction GetCellularDistanceFunction () const
 
void SetCellularReturnType (CellularReturnType cellularReturnType)
 
CellularReturnType GetCellularReturnType () const
 
void SetCellularNoiseLookup (FastNoise *noise)
 
FastNoiseGetCellularNoiseLookup () const
 
void SetCellularDistance2Indices (int cellularDistanceIndex0, int cellularDistanceIndex1)
 
void GetCellularDistance2Indices (int &cellularDistanceIndex0, int &cellularDistanceIndex1) const
 
void SetCellularJitter (FN_DECIMAL cellularJitter)
 
FN_DECIMAL GetCellularJitter () const
 
void SetGradientPerturbAmp (FN_DECIMAL gradientPerturbAmp)
 
FN_DECIMAL GetGradientPerturbAmp () const
 
FN_DECIMAL GetValue (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetValueFractal (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetPerlin (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetPerlinFractal (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetSimplex (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetSimplexFractal (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetCellular (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetWhiteNoise (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetWhiteNoiseInt (int x, int y) const
 
FN_DECIMAL GetCubic (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetCubicFractal (FN_DECIMAL x, FN_DECIMAL y) const
 
FN_DECIMAL GetNoise (FN_DECIMAL x, FN_DECIMAL y) const
 
void GradientPerturb (FN_DECIMAL &x, FN_DECIMAL &y) const
 
void GradientPerturbFractal (FN_DECIMAL &x, FN_DECIMAL &y) const
 
FN_DECIMAL GetValue (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetValueFractal (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetPerlin (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetPerlinFractal (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetSimplex (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetSimplexFractal (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetCellular (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetWhiteNoise (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetWhiteNoiseInt (int x, int y, int z) const
 
FN_DECIMAL GetCubic (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetCubicFractal (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
FN_DECIMAL GetNoise (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z) const
 
void GradientPerturb (FN_DECIMAL &x, FN_DECIMAL &y, FN_DECIMAL &z) const
 
void GradientPerturbFractal (FN_DECIMAL &x, FN_DECIMAL &y, FN_DECIMAL &z) const
 
FN_DECIMAL GetSimplex (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z, FN_DECIMAL w) const
 
FN_DECIMAL GetWhiteNoise (FN_DECIMAL x, FN_DECIMAL y, FN_DECIMAL z, FN_DECIMAL w) const
 
FN_DECIMAL GetWhiteNoiseInt (int x, int y, int z, int w) const
 

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