implement rng in place of u32 seeds

Closes #197
Razaekel · May 19, 2024 · 1953743 · 1953743
1 parent aab9e56
commit 1953743
Show file tree

Hide file tree

Showing 16 changed files with 177 additions and 134 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -3,9 +3,9 @@
 //! # Example
 //!
 //! ```rust
-//! use noise::{NoiseFn, Perlin, Seedable};
+//! use noise::{NoiseFn, Perlin, Seedable, DEFAULT_SEED};
 //!
-//! let perlin = Perlin::new(1);
+//! let perlin = Perlin::new(DEFAULT_SEED);
 //! let val = perlin.get([42.4, 37.7, 2.8]);
 //! ```
 

diff --git a/src/noise_fns.rs b/src/noise_fns.rs
@@ -50,8 +50,14 @@ where
 /// Trait for functions that require a seed before generating their values
 pub trait Seedable {
     /// Set the seed for the function implementing the `Seedable` trait
-    fn set_seed(self, seed: u32) -> Self;
+    fn set_seed(self, seed: Seed) -> Self;
 
     /// Getter to retrieve the seed from the function
-    fn seed(&self) -> u32;
+    fn seed(&self) -> Seed;
 }
+
+pub type Seed = [u8; 16];
+
+pub const DEFAULT_SEED: Seed = [
+    0x4f, 0x09, 0xd6, 0x9f, 0x62, 0x9b, 0x09, 0x0c, 0x0c, 0x49, 0x09, 0xfe, 0x6f, 0x1d, 0x4a, 0x38,
+];
diff --git a/src/noise_fns/generators/fractals.rs b/src/noise_fns/generators/fractals.rs
@@ -7,7 +7,7 @@ mod fbm;
 mod hybridmulti;
 mod ridgedmulti;
 
-use crate::Seedable;
+use crate::{Seed, Seedable};
 
 /// Trait for `MultiFractal` functions
 pub trait MultiFractal {
@@ -20,14 +20,16 @@ pub trait MultiFractal {
     fn set_persistence(self, persistence: f64) -> Self;
 }
 
-fn build_sources<Source>(seed: u32, octaves: usize) -> Vec<Source>
+fn build_sources<Source>(seed: Seed, octaves: usize) -> Vec<Source>
 where
     Source: Default + Seedable,
 {
     let mut sources = Vec::with_capacity(octaves);
     for x in 0..octaves {
         let source = Source::default();
-        sources.push(source.set_seed(seed + x as u32));
+        let mut seed = seed;
+        seed[0] += x as u8;
+        sources.push(source.set_seed(seed));
     }
     sources
 }
diff --git a/src/noise_fns/generators/fractals/basicmulti.rs b/src/noise_fns/generators/fractals/basicmulti.rs
@@ -1,6 +1,7 @@
 use crate::{
     math::vectors::*,
-    noise_fns::{MultiFractal, NoiseFn, Seedable},
+    noise_fns::{MultiFractal, NoiseFn, Seedable, DEFAULT_SEED},
+    Seed,
 };
 use alloc::vec::Vec;
 
@@ -44,7 +45,8 @@ pub struct BasicMulti<T> {
     /// persistence produces "rougher" noise.
     pub persistence: f64,
 
-    seed: u32,
+    seed: Seed,
+
     sources: Vec<T>,
     scale_factor: f64,
 }
@@ -53,14 +55,13 @@ impl<T> BasicMulti<T>
 where
     T: Default + Seedable,
 {
-    pub const DEFAULT_SEED: u32 = 0;
     pub const DEFAULT_OCTAVES: usize = 6;
     pub const DEFAULT_FREQUENCY: f64 = 2.0;
     pub const DEFAULT_LACUNARITY: f64 = core::f64::consts::PI * 2.0 / 3.0;
     pub const DEFAULT_PERSISTENCE: f64 = 0.5;
     pub const MAX_OCTAVES: usize = 32;
 
-    pub fn new(seed: u32) -> Self {
+    pub fn new(seed: Seed) -> Self {
         Self {
             seed,
             octaves: Self::DEFAULT_OCTAVES,
@@ -92,7 +93,7 @@ where
     T: Default + Seedable,
 {
     fn default() -> Self {
-        Self::new(Self::DEFAULT_SEED)
+        Self::new(DEFAULT_SEED)
     }
 }
 
@@ -135,7 +136,7 @@ impl<T> Seedable for BasicMulti<T>
 where
     T: Default + Seedable,
 {
-    fn set_seed(self, seed: u32) -> Self {
+    fn set_seed(self, seed: Seed) -> Self {
         if self.seed == seed {
             return self;
         }
@@ -147,7 +148,7 @@ where
         }
     }
 
-    fn seed(&self) -> u32 {
+    fn seed(&self) -> Seed {
         self.seed
     }
 }

diff --git a/src/noise_fns/generators/fractals/billow.rs b/src/noise_fns/generators/fractals/billow.rs
@@ -1,6 +1,7 @@
 use crate::{
     math::{scale_shift, vectors::*},
-    noise_fns::{MultiFractal, NoiseFn, Seedable},
+    noise_fns::{MultiFractal, NoiseFn, Seedable, DEFAULT_SEED},
+    Seed,
 };
 use alloc::vec::Vec;
 
@@ -41,7 +42,8 @@ pub struct Billow<T> {
     /// persistence produces "rougher" noise.
     pub persistence: f64,
 
-    seed: u32,
+    seed: Seed,
+
     sources: Vec<T>,
     scale_factor: f64,
 }
@@ -50,14 +52,13 @@ impl<T> Billow<T>
 where
     T: Default + Seedable,
 {
-    pub const DEFAULT_SEED: u32 = 0;
     pub const DEFAULT_OCTAVE_COUNT: usize = 6;
     pub const DEFAULT_FREQUENCY: f64 = 1.0;
     pub const DEFAULT_LACUNARITY: f64 = core::f64::consts::PI * 2.0 / 3.0;
     pub const DEFAULT_PERSISTENCE: f64 = 0.5;
     pub const MAX_OCTAVES: usize = 32;
 
-    pub fn new(seed: u32) -> Self {
+    pub fn new(seed: Seed) -> Self {
         Self {
             seed,
             octaves: Self::DEFAULT_OCTAVE_COUNT,
@@ -88,7 +89,7 @@ where
     T: Default + Seedable,
 {
     fn default() -> Self {
-        Self::new(Self::DEFAULT_SEED)
+        Self::new(DEFAULT_SEED)
     }
 }
 
@@ -131,7 +132,7 @@ impl<T> Seedable for Billow<T>
 where
     T: Default + Seedable,
 {
-    fn set_seed(self, seed: u32) -> Self {
+    fn set_seed(self, seed: Seed) -> Self {
         if self.seed == seed {
             return self;
         }
@@ -143,7 +144,7 @@ where
         }
     }
 
-    fn seed(&self) -> u32 {
+    fn seed(&self) -> Seed {
         self.seed
     }
 }

diff --git a/src/noise_fns/generators/fractals/fbm.rs b/src/noise_fns/generators/fractals/fbm.rs
@@ -1,6 +1,7 @@
 use crate::{
     math::vectors::*,
-    noise_fns::{MultiFractal, NoiseFn, Seedable},
+    noise_fns::{MultiFractal, NoiseFn, Seedable, DEFAULT_SEED},
+    Seed,
 };
 use alloc::vec::Vec;
 
@@ -50,7 +51,7 @@ pub struct Fbm<T> {
     /// persistence produces "rougher" noise.
     pub persistence: f64,
 
-    seed: u32,
+    seed: Seed,
     sources: Vec<T>,
     scale_factor: f64,
 }
@@ -59,14 +60,13 @@ impl<T> Fbm<T>
 where
     T: Default + Seedable,
 {
-    pub const DEFAULT_SEED: u32 = 0;
     pub const DEFAULT_OCTAVE_COUNT: usize = 6;
     pub const DEFAULT_FREQUENCY: f64 = 1.0;
     pub const DEFAULT_LACUNARITY: f64 = core::f64::consts::PI * 2.0 / 3.0;
     pub const DEFAULT_PERSISTENCE: f64 = 0.5;
     pub const MAX_OCTAVES: usize = 32;
 
-    pub fn new(seed: u32) -> Self {
+    pub fn new(seed: Seed) -> Self {
         Self {
             seed,
             octaves: Self::DEFAULT_OCTAVE_COUNT,
@@ -97,7 +97,7 @@ where
     T: Default + Seedable,
 {
     fn default() -> Self {
-        Self::new(Self::DEFAULT_SEED)
+        Self::new(DEFAULT_SEED)
     }
 }
 
@@ -140,7 +140,7 @@ impl<T> Seedable for Fbm<T>
 where
     T: Default + Seedable,
 {
-    fn set_seed(self, seed: u32) -> Self {
+    fn set_seed(self, seed: Seed) -> Self {
         if self.seed == seed {
             return self;
         }
@@ -152,7 +152,7 @@ where
         }
     }
 
-    fn seed(&self) -> u32 {
+    fn seed(&self) -> Seed {
         self.seed
     }
 }

diff --git a/src/noise_fns/generators/fractals/hybridmulti.rs b/src/noise_fns/generators/fractals/hybridmulti.rs
@@ -1,6 +1,7 @@
 use crate::{
     math::vectors::*,
-    noise_fns::{MultiFractal, NoiseFn, Seedable},
+    noise_fns::{MultiFractal, NoiseFn, Seedable, DEFAULT_SEED},
+    Seed,
 };
 use alloc::vec::Vec;
 
@@ -38,7 +39,7 @@ pub struct HybridMulti<T> {
     /// persistence produces "rougher" noise.
     pub persistence: f64,
 
-    seed: u32,
+    seed: Seed,
     sources: Vec<T>,
     scale_factor: f64,
 }
@@ -47,14 +48,13 @@ impl<T> HybridMulti<T>
 where
     T: Default + Seedable,
 {
-    pub const DEFAULT_SEED: u32 = 0;
     pub const DEFAULT_OCTAVES: usize = 6;
     pub const DEFAULT_FREQUENCY: f64 = 2.0;
     pub const DEFAULT_LACUNARITY: f64 = core::f64::consts::PI * 2.0 / 3.0;
     pub const DEFAULT_PERSISTENCE: f64 = 0.25;
     pub const MAX_OCTAVES: usize = 32;
 
-    pub fn new(seed: u32) -> Self {
+    pub fn new(seed: Seed) -> Self {
         Self {
             seed,
             octaves: Self::DEFAULT_OCTAVES,
@@ -100,7 +100,7 @@ where
     T: Default + Seedable,
 {
     fn default() -> Self {
-        Self::new(Self::DEFAULT_SEED)
+        Self::new(DEFAULT_SEED)
     }
 }
 
@@ -143,7 +143,7 @@ impl<T> Seedable for HybridMulti<T>
 where
     T: Default + Seedable,
 {
-    fn set_seed(self, seed: u32) -> Self {
+    fn set_seed(self, seed: Seed) -> Self {
         if self.seed == seed {
             return self;
         }
@@ -155,7 +155,7 @@ where
         }
     }
 
-    fn seed(&self) -> u32 {
+    fn seed(&self) -> Seed {
         self.seed
     }
 }

diff --git a/src/noise_fns/generators/fractals/ridgedmulti.rs b/src/noise_fns/generators/fractals/ridgedmulti.rs
@@ -1,6 +1,7 @@
 use crate::{
     math::vectors::*,
-    noise_fns::{MultiFractal, NoiseFn, Seedable},
+    noise_fns::{MultiFractal, NoiseFn, Seedable, DEFAULT_SEED},
+    Seed,
 };
 use alloc::vec::Vec;
 
@@ -56,7 +57,8 @@ pub struct RidgedMulti<T> {
     /// half the height of the previous.
     pub attenuation: f64,
 
-    seed: u32,
+    seed: Seed,
+
     sources: Vec<T>,
     scale_factor: f64,
 }
@@ -65,15 +67,14 @@ impl<T> RidgedMulti<T>
 where
     T: Default + Seedable,
 {
-    pub const DEFAULT_SEED: u32 = 0;
     pub const DEFAULT_OCTAVE_COUNT: usize = 6;
     pub const DEFAULT_FREQUENCY: f64 = 1.0;
     pub const DEFAULT_LACUNARITY: f64 = core::f64::consts::PI * 2.0 / 3.0;
     pub const DEFAULT_PERSISTENCE: f64 = 1.0;
     pub const DEFAULT_ATTENUATION: f64 = 2.0;
     pub const MAX_OCTAVES: usize = 32;
 
-    pub fn new(seed: u32) -> Self {
+    pub fn new(seed: Seed) -> Self {
         Self {
             seed,
             octaves: Self::DEFAULT_OCTAVE_COUNT,
@@ -130,7 +131,7 @@ where
     T: Default + Seedable,
 {
     fn default() -> Self {
-        Self::new(Self::DEFAULT_SEED)
+        Self::new(DEFAULT_SEED)
     }
 }
 
@@ -173,7 +174,7 @@ impl<T> Seedable for RidgedMulti<T>
 where
     T: Default + Seedable,
 {
-    fn set_seed(self, seed: u32) -> Self {
+    fn set_seed(self, seed: Seed) -> Self {
         if self.seed == seed {
             return self;
         }
@@ -185,7 +186,7 @@ where
         }
     }
 
-    fn seed(&self) -> u32 {
+    fn seed(&self) -> Seed {
         self.seed
     }
 }