libnoise 1.2.0

A simple, performant, and customizable procedural noise generation library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

use crate::core::generator::{Generator, Generator1D, Generator2D, Generator3D, Generator4D};

/// A generator applying fractal brownian motion on the underlying generator.
///
/// For details, see the documentation of [`fbm()`]. Typically, this struct is not meant
/// to be used directly. Instead, [`fbm()`] implemented by [`Generator`], should be used
/// to create [`Fbm`].
///
/// [`fbm()`]: Generator::fbm
#[derive(Clone, Copy, Debug)]
pub struct Fbm<const D: usize, G> {
    generator: G,
    octaves: u32,
    frequency: f64,
    lacunarity: f64,
    persistence: f64,
    normalization_factor: f64,
}

impl<G: Generator<1>> Generator1D for Fbm<1, G> {}
impl<G: Generator<2>> Generator2D for Fbm<2, G> {}
impl<G: Generator<3>> Generator3D for Fbm<3, G> {}
impl<G: Generator<4>> Generator4D for Fbm<4, G> {}

impl<const D: usize, G> Fbm<D, G>
where
    G: Generator<D>,
{
    #[inline]
    pub fn new(
        generator: G,
        octaves: u32,
        frequency: f64,
        lacunarity: f64,
        persistence: f64,
    ) -> Self {
        let normalization_factor = compute_normalization_factor(octaves, persistence);
        Self {
            generator,
            octaves,
            frequency,
            lacunarity,
            persistence,
            normalization_factor,
        }
    }
}

macro_rules! impl_generator {
    ($dim:literal) => {
        impl<G: Generator<$dim>> Generator<$dim> for Fbm<$dim, G> {
            fn sample(&self, point: [f64; $dim]) -> f64 {
                let mut noise = 0.0;
                let mut amp = 1.0;
                let mut freq = self.frequency;
                for _ in 0..self.octaves {
                    noise += amp * self.generator.sample(point.map(|x| x * freq));
                    freq *= self.lacunarity;
                    amp *= self.persistence;
                }
                noise * self.normalization_factor
            }
        }
    };
}

impl_generator!(1);
impl_generator!(2);
impl_generator!(3);
impl_generator!(4);

#[inline]
fn compute_normalization_factor(octaves: u32, persistence: f64) -> f64 {
    1.0 / (0..octaves).fold(0.0, |acc, octave| acc + persistence.powi(octave as i32))
}