Struct noise::Turbulence

pub struct Turbulence<Source> {
    pub source: Source,
    pub frequency: f64,
    pub power: f64,
    pub roughness: usize,
    // some fields omitted
}

Noise function that randomly displaces the input value before returning the output value from the source function.

_ is the pseudo-random displacement of the input value. The get() method randomly displaces the coordinates of the input value before retrieving the output value from the source function. To control the turbulence, an application can modify its frequency, its power, and its roughness.

Fields

source: Source

Source function that outputs a value.

frequency: f64

Frequency value for the Turbulence function.

power: f64

Controls the strength of the turbulence by affecting how much each point is moved.

roughness: usize

Affects the roughness of the turbulence. Higher values are rougher.

Implementations

impl<Source> Turbulence<Source>

pub const DEFAULT_SEED: u32

pub const DEFAULT_FREQUENCY: f64

pub const DEFAULT_POWER: f64

pub const DEFAULT_ROUGHNESS: usize

pub fn new(source: Source) -> Self

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

pub fn set_power(self, power: f64) -> Self

pub fn set_roughness(self, roughness: usize) -> Self

Trait Implementations

impl<Source: Clone> Clone for Turbulence<Source>

pub fn clone(&self) -> Turbulence<Source>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Source: Debug> Debug for Turbulence<Source>

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

Formats the value using the given formatter.

impl<Source> NoiseFn<[f64; 2]> for Turbulence<Source> where
    Source: NoiseFn<[f64; 2]>, 

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

impl<Source> NoiseFn<[f64; 3]> for Turbulence<Source> where
    Source: NoiseFn<[f64; 3]>, 

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

impl<Source> NoiseFn<[f64; 4]> for Turbulence<Source> where
    Source: NoiseFn<[f64; 4]>, 

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

impl<Source> Seedable for Turbulence<Source>

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

Set the seed for the function implementing the Seedable trait

pub fn seed(&self) -> u32

Getter to retrieve the seed from the function