noise-functions 0.8.4

A collection of fast and lightweight noise functions.
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

use crate::{
    base::impl_noise,
    math::{floor, lerp},
};

#[cfg(feature = "nightly-simd")]
use core::simd::{f32x2, f32x4};

/// 2/3/4 dimensional Perlin noise.
#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
pub struct Perlin;

impl_noise!(234 Perlin);

impl Perlin {
    #[inline]
    fn gen2(self, [x, y]: [f32; 2], seed: i32) -> f32 {
        // implementation from FastNoiseLite
        use crate::from_fast_noise_lite::{floor_to_int, grad2, interp_quintic, PRIME_X, PRIME_Y};

        let mut x0 = floor_to_int(x);
        let mut y0 = floor_to_int(y);

        let xd0 = x - x0 as f32;
        let yd0 = y - y0 as f32;

        let xd1 = xd0 - 1.0;
        let yd1 = yd0 - 1.0;

        let xs = interp_quintic(xd0);
        let ys = interp_quintic(yd0);

        x0 = x0.wrapping_mul(PRIME_X);
        y0 = y0.wrapping_mul(PRIME_Y);

        let x1 = x0.wrapping_add(PRIME_X);
        let y1 = y0.wrapping_add(PRIME_Y);

        let xf0 = lerp(grad2(seed, x0, y0, xd0, yd0), grad2(seed, x1, y0, xd1, yd0), xs);
        let xf1 = lerp(grad2(seed, x0, y1, xd0, yd1), grad2(seed, x1, y1, xd1, yd1), xs);

        lerp(xf0, xf1, ys) * 1.4247691104677813
    }

    #[inline]
    fn gen3(self, [x, y, z]: [f32; 3], seed: i32) -> f32 {
        // implementation from FastNoiseLite
        use crate::from_fast_noise_lite::{floor_to_int, grad3, interp_quintic, PRIME_X, PRIME_Y, PRIME_Z};

        let mut x0 = floor_to_int(x);
        let mut y0 = floor_to_int(y);
        let mut z0 = floor_to_int(z);

        let xd0 = x - x0 as f32;
        let yd0 = y - y0 as f32;
        let zd0 = z - z0 as f32;

        let xd1 = xd0 - 1.0;
        let yd1 = yd0 - 1.0;
        let zd1 = zd0 - 1.0;

        let xs = interp_quintic(xd0);
        let ys = interp_quintic(yd0);
        let zs = interp_quintic(zd0);

        x0 = x0.wrapping_mul(PRIME_X);
        y0 = y0.wrapping_mul(PRIME_Y);
        z0 = z0.wrapping_mul(PRIME_Z);

        let x1 = x0.wrapping_add(PRIME_X);
        let y1 = y0.wrapping_add(PRIME_Y);
        let z1 = z0.wrapping_add(PRIME_Z);

        let xf00 = lerp(grad3(seed, x0, y0, z0, xd0, yd0, zd0), grad3(seed, x1, y0, z0, xd1, yd0, zd0), xs);
        let xf10 = lerp(grad3(seed, x0, y1, z0, xd0, yd1, zd0), grad3(seed, x1, y1, z0, xd1, yd1, zd0), xs);
        let xf01 = lerp(grad3(seed, x0, y0, z1, xd0, yd0, zd1), grad3(seed, x1, y0, z1, xd1, yd0, zd1), xs);
        let xf11 = lerp(grad3(seed, x0, y1, z1, xd0, yd1, zd1), grad3(seed, x1, y1, z1, xd1, yd1, zd1), xs);

        let yf0 = lerp(xf00, xf10, ys);
        let yf1 = lerp(xf01, xf11, ys);

        lerp(yf0, yf1, zs) * 0.964921414852142333984375
    }

    #[inline]
    fn gen4(self, [x, y, z, w]: [f32; 4], seed: i32) -> f32 {
        // implementation from FastNoise2
        use crate::from_fast_noise_2::{gradient_dot4, hash_primes4, interp_quintic, primes};

        let xs = floor(x);
        let ys = floor(y);
        let zs = floor(z);
        let ws = floor(w);

        let x0 = (xs as i32).wrapping_mul(primes::X);
        let y0 = (ys as i32).wrapping_mul(primes::Y);
        let z0 = (zs as i32).wrapping_mul(primes::Z);
        let w0 = (ws as i32).wrapping_mul(primes::W);
        let x1 = x0.wrapping_add(primes::X);
        let y1 = y0.wrapping_add(primes::Y);
        let z1 = z0.wrapping_add(primes::Z);
        let w1 = w0.wrapping_add(primes::W);

        let xf0 = x - xs;
        let yf0 = y - ys;
        let zf0 = z - zs;
        let wf0 = w - ws;
        let xf1 = xf0 - 1.0;
        let yf1 = yf0 - 1.0;
        let zf1 = zf0 - 1.0;
        let wf1 = wf0 - 1.0;

        let xs = interp_quintic(xf0);
        let ys = interp_quintic(yf0);
        let zs = interp_quintic(zf0);
        let ws = interp_quintic(wf0);

        0.964921414852142333984375f32
            * lerp(
                lerp(
                    lerp(
                        lerp(
                            gradient_dot4(hash_primes4(seed, x0, y0, z0, w0), xf0, yf0, zf0, wf0),
                            gradient_dot4(hash_primes4(seed, x1, y0, z0, w0), xf1, yf0, zf0, wf0),
                            xs,
                        ),
                        lerp(
                            gradient_dot4(hash_primes4(seed, x0, y1, z0, w0), xf0, yf1, zf0, wf0),
                            gradient_dot4(hash_primes4(seed, x1, y1, z0, w0), xf1, yf1, zf0, wf0),
                            xs,
                        ),
                        ys,
                    ),
                    lerp(
                        lerp(
                            gradient_dot4(hash_primes4(seed, x0, y0, z1, w0), xf0, yf0, zf1, wf0),
                            gradient_dot4(hash_primes4(seed, x1, y0, z1, w0), xf1, yf0, zf1, wf0),
                            xs,
                        ),
                        lerp(
                            gradient_dot4(hash_primes4(seed, x0, y1, z1, w0), xf0, yf1, zf1, wf0),
                            gradient_dot4(hash_primes4(seed, x1, y1, z1, w0), xf1, yf1, zf1, wf0),
                            xs,
                        ),
                        ys,
                    ),
                    zs,
                ),
                lerp(
                    lerp(
                        lerp(
                            gradient_dot4(hash_primes4(seed, x0, y0, z0, w1), xf0, yf0, zf0, wf1),
                            gradient_dot4(hash_primes4(seed, x1, y0, z0, w1), xf1, yf0, zf0, wf1),
                            xs,
                        ),
                        lerp(
                            gradient_dot4(hash_primes4(seed, x0, y1, z0, w1), xf0, yf1, zf0, wf1),
                            gradient_dot4(hash_primes4(seed, x1, y1, z0, w1), xf1, yf1, zf0, wf1),
                            xs,
                        ),
                        ys,
                    ),
                    lerp(
                        lerp(
                            gradient_dot4(hash_primes4(seed, x0, y0, z1, w1), xf0, yf0, zf1, wf1),
                            gradient_dot4(hash_primes4(seed, x1, y0, z1, w1), xf1, yf0, zf1, wf1),
                            xs,
                        ),
                        lerp(
                            gradient_dot4(hash_primes4(seed, x0, y1, z1, w1), xf0, yf1, zf1, wf1),
                            gradient_dot4(hash_primes4(seed, x1, y1, z1, w1), xf1, yf1, zf1, wf1),
                            xs,
                        ),
                        ys,
                    ),
                    zs,
                ),
                ws,
            )
    }

    #[inline]
    #[cfg(feature = "nightly-simd")]
    fn gen2a(self, point: f32x2, seed: i32) -> f32 {
        // based on the implementation from FastNoiseLite
        use crate::from_fast_noise_lite::{floor_to_int, grad2, interp_quintic, splat, PRIME_XY};

        use core::simd::num::SimdInt;

        let v0 = floor_to_int(point);
        let d0 = point - v0.cast::<f32>();
        let d1 = d0 - splat(1.0);
        let vs = interp_quintic(d0);
        let v0 = v0 * PRIME_XY;
        let v1 = v0 + PRIME_XY;

        let xf0 = lerp(grad2(seed, v0[0], v0[1], d0[0], d0[1]), grad2(seed, v1[0], v0[1], d1[0], d0[1]), vs[0]);
        let xf1 = lerp(grad2(seed, v0[0], v1[1], d0[0], d1[1]), grad2(seed, v1[0], v1[1], d1[0], d1[1]), vs[0]);

        lerp(xf0, xf1, vs[1]) * 1.4247691104677813
    }

    #[inline]
    #[cfg(feature = "nightly-simd")]
    fn gen3a(self, point: f32x4, seed: i32) -> f32 {
        // based on the implementation from FastNoiseLite
        use core::simd::{i32x4, num::SimdInt};

        use crate::from_fast_noise_lite::{floor_to_int, grad3_with_hash, interp_quintic, Index4x4, PRIME_XYZ};

        #[inline(always)]
        fn create_hash(mut hash: i32x4) -> Index4x4<64> {
            hash *= i32x4::splat(0x27d4eb2d);
            hash ^= hash >> i32x4::splat(15);
            Index4x4::new(hash)
        }

        let mut v0 = floor_to_int(point);
        let d0 = point - v0.cast::<f32>();
        let d1 = d0 - f32x4::splat(1.0);
        let vs = interp_quintic(d0);
        v0 *= PRIME_XYZ;
        let v1 = v0 + PRIME_XYZ;

        let hs = i32x4::from_array([v0[1] ^ v0[2], v1[1] ^ v0[2], v0[1] ^ v1[2], v1[1] ^ v1[2]]);

        let h = create_hash(hs ^ i32x4::splat(v0[0] ^ seed));

        let t0 = f32x4::from_array([
            grad3_with_hash(h[0], d0[0], d0[1], d0[2]),
            grad3_with_hash(h[1], d0[0], d1[1], d0[2]),
            grad3_with_hash(h[2], d0[0], d0[1], d1[2]),
            grad3_with_hash(h[3], d0[0], d1[1], d1[2]),
        ]);

        let h = create_hash(hs ^ i32x4::splat(v1[0] ^ seed));

        let t1 = f32x4::from_array([
            grad3_with_hash(h[0], d1[0], d0[1], d0[2]),
            grad3_with_hash(h[1], d1[0], d1[1], d0[2]),
            grad3_with_hash(h[2], d1[0], d0[1], d1[2]),
            grad3_with_hash(h[3], d1[0], d1[1], d1[2]),
        ]);

        let vfx = lerp(t0, t1, f32x4::splat(vs[0]));

        let yf0: f32 = lerp(vfx[0], vfx[1], vs[1]);
        let yf1: f32 = lerp(vfx[2], vfx[3], vs[1]);

        lerp(yf0, yf1, vs[2]) * 0.964921414852142333984375
    }

    #[inline]
    #[cfg(feature = "nightly-simd")]
    fn gen4a(self, point: f32x4, seed: i32) -> f32 {
        self.gen4(point.into(), seed)
    }
}