Struct noise::Turbulence

pub struct Turbulence<Source, F>where
    F: Default + Seedable,{
    pub source: Source,
    pub frequency: f64,
    pub power: f64,
    pub roughness: usize,
    /* private fields */
}

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, F> Turbulence<Source, F>where
    F: Default + Seedable,

pub const DEFAULT_SEED: u32 = 0u32

pub const DEFAULT_FREQUENCY: f64 = 1f64

pub const DEFAULT_POWER: f64 = 1f64

pub const DEFAULT_ROUGHNESS: usize = 3usize

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, F: Clone> Clone for Turbulence<Source, F>where
    F: Default + Seedable,

fn clone(&self) -> Turbulence<Source, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Source: Debug, F: Debug> Debug for Turbulence<Source, F>where
    F: Default + Seedable,

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

Formats the value using the given formatter.

impl<Source, F> NoiseFn<f64, 2> for Turbulence<Source, F>where
    Source: NoiseFn<f64, 2>,
    F: Default + Seedable + NoiseFn<f64, 2>,

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

impl<Source, F> NoiseFn<f64, 3> for Turbulence<Source, F>where
    Source: NoiseFn<f64, 3>,
    F: Default + Seedable + NoiseFn<f64, 3>,

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

impl<Source, F> NoiseFn<f64, 4> for Turbulence<Source, F>where
    Source: NoiseFn<f64, 4>,
    F: Default + Seedable + NoiseFn<f64, 4>,

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

impl<Source, F> Seedable for Turbulence<Source, F>where
    F: 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