Struct noise::RidgedMulti
[−]
[src]
pub struct RidgedMulti { pub octaves: usize, pub frequency: f64, pub lacunarity: f64, pub persistence: f64, pub attenuation: f64, // some fields omitted }
Noise function that outputs ridged-multifractal noise.
This noise function, heavily based on the fBm-noise function, generates ridged-multifractal noise. Ridged-multifractal noise is generated in much the same way as fBm noise, except the output of each octave is modified by an absolute-value function. Modifying the octave values in this way produces ridge-like formations.
The values output from this function will usually range from -1.0 to 1.0 with default values for the parameters, but there are no guarantees that all output values will exist within this range. If the parameters are modified from their defaults, then the output will need to be scaled to remain in the [-1,1] range.
Ridged-multifractal noise is often used to generate craggy mountainous terrain or marble-like textures.
Fields
octaves: usize
Total number of frequency octaves to generate the noise with.
The number of octaves control the amount of detail in the noise function. Adding more octaves increases the detail, with the drawback of increasing the calculation time.
frequency: f64
The number of cycles per unit length that the noise function outputs.
lacunarity: f64
A multiplier that determines how quickly the frequency increases for each successive octave in the noise function.
The frequency of each successive octave is equal to the product of the previous octave's frequency and the lacunarity value.
A lacunarity of 2.0 results in the frequency doubling every octave. For almost all cases, 2.0 is a good value to use.
persistence: f64
A multiplier that determines how quickly the amplitudes diminish for each successive octave in the noise function.
The amplitude of each successive octave is equal to the product of the previous octave's amplitude and the persistence value. Increasing the persistence produces "rougher" noise.
attenuation: f64
The attenuation to apply to the weight on each octave. This reduces the strength of each successive octave, making their respective ridges smaller. The default attenuation is 2.0, making each octave half the height of the previous.
Methods
impl RidgedMulti
[src]
const DEFAULT_SEED: u32
DEFAULT_SEED: u32 = 0
const DEFAULT_OCTAVE_COUNT: usize
DEFAULT_OCTAVE_COUNT: usize = 6
const DEFAULT_FREQUENCY: f64
DEFAULT_FREQUENCY: f64 = 1.0
const DEFAULT_LACUNARITY: f64
DEFAULT_LACUNARITY: f64 = std::f64::consts::PI * 2.0 / 3.0
const DEFAULT_PERSISTENCE: f64
DEFAULT_PERSISTENCE: f64 = 1.0
const DEFAULT_ATTENUATION: f64
DEFAULT_ATTENUATION: f64 = 2.0
const MAX_OCTAVES: usize
MAX_OCTAVES: usize = 32
fn new() -> Self
[src]
fn set_attenuation(self, attenuation: f64) -> Self
[src]
Trait Implementations
impl Clone for RidgedMulti
[src]
fn clone(&self) -> RidgedMulti
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for RidgedMulti
[src]
impl Default for RidgedMulti
[src]
impl MultiFractal for RidgedMulti
[src]
fn set_octaves(self, octaves: usize) -> Self
[src]
fn set_frequency(self, frequency: f64) -> Self
[src]
fn set_lacunarity(self, lacunarity: f64) -> Self
[src]
fn set_persistence(self, persistence: f64) -> Self
[src]
impl Seedable for RidgedMulti
[src]
fn set_seed(self, seed: u32) -> Self
[src]
Set the seed for the function implementing the Seedable
trait
fn seed(&self) -> u32
[src]
Getter to retrieve the seed from the function
impl NoiseFn<Point2<f64>> for RidgedMulti
[src]
2-dimensional RidgedMulti
noise
impl NoiseFn<Point3<f64>> for RidgedMulti
[src]
3-dimensional RidgedMulti
noise
impl NoiseFn<Point4<f64>> for RidgedMulti
[src]
4-dimensional RidgedMulti
noise