Struct Fbm

pub struct Fbm<Noise> {
    pub noise: Noise,
    pub octaves: u32,
    pub gain: f32,
    pub lacunarity: f32,
    pub fractal_bounding: f32,
}

Fractal Brownian motion (fBm) noise.

fBm noise is created by calling the base noise octaves amount of times with increasing frequency and decreasing amplitude.

Note: This modifier assumes the base noise returns values in the [-1, 1] range.

Fields

noise: Noise

octaves: u32

gain: f32

lacunarity: f32

fractal_bounding: f32

Implementations

impl<Noise> Fbm<Noise>

pub const fn new(noise: Noise, octaves: u32, gain: f32, lacunarity: f32) -> Self

pub const fn weighted(self, strength: f32) -> Weighted<Self>

Trait Implementations

impl<Noise: Clone> Clone for Fbm<Noise>

fn clone(&self) -> Fbm<Noise>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Noise: Debug> Debug for Fbm<Noise>

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

Formats the value using the given formatter.

impl<N> Noise for Fbm<N>

fn seed(self, seed: i32) -> Seeded<Self>

where Self: Sized,

Sets a seed to be sampled with.

fn frequency(self, frequency: f32) -> Frequency<Self>

where Self: Sized,

Modifies a noise with a frequency multiplier.

fn fbm(self, octaves: u32, gain: f32, lacunarity: f32) -> Fbm<Self>

where Self: Sized,

Creates a fractal from this noise with the provided octaves, gain and lacunarity.

fn ridged(self) -> Ridged<Self>

where Self: Sized,

Modifies a noise to create a peak at 0.

fn triangle_wave(self, frequency: f32) -> TriangleWave<Self>

where Self: Sized,

Applies a triangle wave to the output of a base noise function.

fn tileable(self, width: f32, height: f32) -> Tileable<Self>

where Self: Sized,

Creates a tileable 2D noise from a 4D noise.

fn mul_seed(self, value: i32) -> MulSeed<Self>

where Self: Sized,

Multiplies the seed by value.

impl<Noise: PartialEq> PartialEq for Fbm<Noise>

fn eq(&self, other: &Fbm<Noise>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Noise, const DIM: usize> Sample<DIM> for Fbm<Noise>

where Noise: SampleWithSeed<DIM>,

fn sample(&self, point: [f32; DIM]) -> f32

impl<Noise, const DIM: usize, const LANES: usize> Sample<DIM, Simd<f32, LANES>> for Fbm<Noise>

where Noise: SampleWithSeed<DIM, Simd<f32, LANES>>, LaneCount<LANES>: SupportedLaneCount,

Available on crate feature nightly-simd only.

fn sample(&self, point: Simd<f32, LANES>) -> f32

impl<Noise, const DIM: usize> SampleWithSeed<DIM> for Fbm<Noise>

where Noise: SampleWithSeed<DIM>,

fn sample_with_seed(&self, point: [f32; DIM], seed: i32) -> f32

impl<Noise, const DIM: usize, const LANES: usize> SampleWithSeed<DIM, Simd<f32, LANES>> for Fbm<Noise>

where Noise: SampleWithSeed<DIM, Simd<f32, LANES>>, LaneCount<LANES>: SupportedLaneCount,

Available on crate feature nightly-simd only.

fn sample_with_seed(&self, point: Simd<f32, LANES>, seed: i32) -> f32

impl<Noise: Copy> Copy for Fbm<Noise>

impl<Noise> StructuralPartialEq for Fbm<Noise>