Struct noise::RidgedMulti

pub struct RidgedMulti<T> {
    pub octaves: usize,
    pub frequency: f64,
    pub lacunarity: f64,
    pub persistence: f64,
    pub attenuation: f64,
    /* private fields */
}

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.

Implementations

impl<T> RidgedMulti<T>

where T: Default + Seedable,

pub const DEFAULT_SEED: u32 = 0u32

pub const DEFAULT_OCTAVE_COUNT: usize = 6usize

pub const DEFAULT_FREQUENCY: f64 = 1f64

pub const DEFAULT_LACUNARITY: f64 = 2.0943951023931953f64

pub const DEFAULT_PERSISTENCE: f64 = 1f64

pub const DEFAULT_ATTENUATION: f64 = 2f64

pub const MAX_OCTAVES: usize = 32usize

pub fn new(seed: u32) -> Self

pub fn set_attenuation(self, attenuation: f64) -> Self

pub fn set_sources(self, sources: Vec<T>) -> Self

Trait Implementations

impl<T: Clone> Clone for RidgedMulti<T>

fn clone(&self) -> RidgedMulti<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for RidgedMulti<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for RidgedMulti<T>

where T: Default + Seedable,

fn default() -> Self

Returns the “default value” for a type.

impl<T> MultiFractal for RidgedMulti<T>

where T: Default + Seedable,

fn set_octaves(self, octaves: usize) -> Self

fn set_frequency(self, frequency: f64) -> Self

fn set_lacunarity(self, lacunarity: f64) -> Self

fn set_persistence(self, persistence: f64) -> Self

impl<T> NoiseFn<f64, 2> for RidgedMulti<T>

where T: NoiseFn<f64, 2>,

2-dimensional RidgedMulti noise

fn get(&self, point: [f64; 2]) -> f64

impl<T> NoiseFn<f64, 3> for RidgedMulti<T>

where T: NoiseFn<f64, 3>,

3-dimensional RidgedMulti noise

fn get(&self, point: [f64; 3]) -> f64

impl<T> NoiseFn<f64, 4> for RidgedMulti<T>

where T: NoiseFn<f64, 4>,

4-dimensional RidgedMulti noise

fn get(&self, point: [f64; 4]) -> f64

impl<T> Seedable for RidgedMulti<T>

where T: Default + Seedable,

fn set_seed(self, seed: u32) -> Self

Set the seed for the function implementing the Seedable trait

fn seed(&self) -> u32

Getter to retrieve the seed from the function