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

use super::functional::{self, constants::PERMUTATION_TABLE_SIZE};
use crate::core::{
    generator::{Generator, Generator1D, Generator2D, Generator3D, Generator4D},
    utils::ptable::{PermutationTable, Seed},
};

/// A generator which produces n-dimensional improved perlin noise.
///
/// For details, see the documentation of [`improved_perlin()`]. Typically, this struct is not meant
/// to be used directly. Instead, [`improved_perlin()`] implemented by [`Source`], should be used to
/// create an improved perlin noise generator.
///
/// # Direct usage of this struct
///
/// Direct instantiation of this struct:
///
/// ```
/// # use libnoise::{ImprovedPerlin, Generator};
/// let generator = ImprovedPerlin::new(42);
/// let value = generator.sample([0.2, 0.5]);
/// ```
///
/// [`improved_perlin()`]: crate::Source::improved_perlin
/// [`Source`]: crate::Source
#[derive(Clone, Debug)]
pub struct ImprovedPerlin<const D: usize> {
    permutation_table: PermutationTable,
}

impl Generator1D for ImprovedPerlin<1> {}
impl Generator2D for ImprovedPerlin<2> {}
impl Generator3D for ImprovedPerlin<3> {}
impl Generator4D for ImprovedPerlin<4> {}

impl<const D: usize> ImprovedPerlin<D> {
    /// Create a new improved perlin noise generator.
    #[inline]
    pub fn new(seed: impl Seed) -> Self {
        let permutation_table = PermutationTable::new(seed, PERMUTATION_TABLE_SIZE, true);
        Self { permutation_table }
    }
}

impl Generator<1> for ImprovedPerlin<1> {
    #[inline]
    fn sample(&self, point: [f64; 1]) -> f64 {
        functional::improved_perlin::noise1d(&self.permutation_table, point)
    }
}

impl Generator<2> for ImprovedPerlin<2> {
    #[inline]
    fn sample(&self, point: [f64; 2]) -> f64 {
        functional::improved_perlin::noise2d(&self.permutation_table, point)
    }
}

impl Generator<3> for ImprovedPerlin<3> {
    #[inline]
    fn sample(&self, point: [f64; 3]) -> f64 {
        functional::improved_perlin::noise3d(&self.permutation_table, point)
    }
}

impl Generator<4> for ImprovedPerlin<4> {
    #[inline]
    fn sample(&self, point: [f64; 4]) -> f64 {
        functional::improved_perlin::noise4d(&self.permutation_table, point)
    }
}