fastnoise2 0.4.0

A safe Rust wrapper for FastNoise2, a node-based noise generation library optimized with SIMD.
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
use std::sync::Arc;

use crate::{FastNoiseError, Node, OutputMinMax};

/// Unlike [`Node`], this structure is safe to use because it is built from typed nodes
/// that implement the [`Generator`][`crate::generator::Generator`] trait, or built by an encoded node tree produced by the [Node Editor](https://github.com/Auburn/FastNoise2?tab=readme-ov-file#node-editor).
///
/// You can create and test node trees using the [Web WASM Node Editor](https://auburn.github.io/fastnoise2nodeeditor/) or download desktop binaries from [FastNoise2 Releases](https://github.com/Auburn/FastNoise2/releases/latest).
///
/// You can see how to use it in the [`generator`][`crate::generator`] module.
#[derive(Debug, Clone)]
pub struct SafeNode(pub(crate) Arc<Node>);

unsafe impl Send for SafeNode {}
unsafe impl Sync for SafeNode {}

impl SafeNode {
    /// Creates a [`SafeNode`] instance from an encoded node tree.
    ///
    /// # Errors
    /// Returns an error if the encoded node tree is invalid or if creation fails.
    pub fn from_encoded_node_tree(encoded_node_tree: &str) -> Result<Self, FastNoiseError> {
        Node::from_encoded_node_tree(encoded_node_tree)
            .map(Arc::new)
            .map(Self)
    }

    pub fn get_simd_level(&self) -> u32 {
        self.0.get_simd_level()
    }

    /// # Panics
    /// Panics if `noise_out.len() < x_count * y_count`.
    pub fn gen_uniform_grid_2d(
        &self,
        noise_out: &mut [f32],
        x_offset: f32,
        y_offset: f32,
        x_count: i32,
        y_count: i32,
        x_step_size: f32,
        y_step_size: f32,
        seed: i32,
    ) -> OutputMinMax {
        assert!(noise_out.len() >= (x_count * y_count) as usize);

        unsafe {
            self.0.gen_uniform_grid_2d_unchecked(
                noise_out,
                x_offset,
                y_offset,
                x_count,
                y_count,
                x_step_size,
                y_step_size,
                seed,
            )
        }
    }

    /// # Panics
    /// Panics if `noise_out.len() < x_count * y_count * z_count`.
    pub fn gen_uniform_grid_3d(
        &self,
        noise_out: &mut [f32],
        x_offset: f32,
        y_offset: f32,
        z_offset: f32,
        x_count: i32,
        y_count: i32,
        z_count: i32,
        x_step_size: f32,
        y_step_size: f32,
        z_step_size: f32,
        seed: i32,
    ) -> OutputMinMax {
        assert!(noise_out.len() >= (x_count * y_count * z_count) as usize);

        unsafe {
            self.0.gen_uniform_grid_3d_unchecked(
                noise_out,
                x_offset,
                y_offset,
                z_offset,
                x_count,
                y_count,
                z_count,
                x_step_size,
                y_step_size,
                z_step_size,
                seed,
            )
        }
    }

    /// # Panics
    /// Panics if `noise_out.len() < x_count * y_count * z_count * w_count`.
    pub fn gen_uniform_grid_4d(
        &self,
        noise_out: &mut [f32],
        x_offset: f32,
        y_offset: f32,
        z_offset: f32,
        w_offset: f32,
        x_count: i32,
        y_count: i32,
        z_count: i32,
        w_count: i32,
        x_step_size: f32,
        y_step_size: f32,
        z_step_size: f32,
        w_step_size: f32,
        seed: i32,
    ) -> OutputMinMax {
        assert!(noise_out.len() >= (x_count * y_count * z_count * w_count) as usize);

        unsafe {
            self.0.gen_uniform_grid_4d_unchecked(
                noise_out,
                x_offset,
                y_offset,
                z_offset,
                w_offset,
                x_count,
                y_count,
                z_count,
                w_count,
                x_step_size,
                y_step_size,
                z_step_size,
                w_step_size,
                seed,
            )
        }
    }

    /// # Panics
    /// Panics if `noise_out`, `x_pos_array`, and `y_pos_array` do not have the same length.
    pub fn gen_position_array_2d(
        &self,
        noise_out: &mut [f32],
        x_pos_array: &[f32],
        y_pos_array: &[f32],
        x_offset: f32,
        y_offset: f32,
        seed: i32,
    ) -> OutputMinMax {
        assert!(noise_out.len() == x_pos_array.len() && x_pos_array.len() == y_pos_array.len());

        unsafe {
            self.0.gen_position_array_2d_unchecked(
                noise_out,
                x_pos_array,
                y_pos_array,
                x_offset,
                y_offset,
                seed,
            )
        }
    }

    /// # Panics
    /// Panics if `noise_out`, `x_pos_array`, `y_pos_array`, and `z_pos_array` do not have the same length.
    pub fn gen_position_array_3d(
        &self,
        noise_out: &mut [f32],
        x_pos_array: &[f32],
        y_pos_array: &[f32],
        z_pos_array: &[f32],
        x_offset: f32,
        y_offset: f32,
        z_offset: f32,
        seed: i32,
    ) -> OutputMinMax {
        assert!(
            noise_out.len() == x_pos_array.len()
                && x_pos_array.len() == y_pos_array.len()
                && y_pos_array.len() == z_pos_array.len()
        );

        unsafe {
            self.0.gen_position_array_3d_unchecked(
                noise_out,
                x_pos_array,
                y_pos_array,
                z_pos_array,
                x_offset,
                y_offset,
                z_offset,
                seed,
            )
        }
    }

    /// # Panics
    /// Panics if `noise_out`, `x_pos_array`, `y_pos_array`, `z_pos_array` and `w_pos_array` do not have the same length.
    pub fn gen_position_array_4d(
        &self,
        noise_out: &mut [f32],
        x_pos_array: &[f32],
        y_pos_array: &[f32],
        z_pos_array: &[f32],
        w_pos_array: &[f32],
        x_offset: f32,
        y_offset: f32,
        z_offset: f32,
        w_offset: f32,
        seed: i32,
    ) -> OutputMinMax {
        assert!(
            noise_out.len() == x_pos_array.len()
                && x_pos_array.len() == y_pos_array.len()
                && y_pos_array.len() == z_pos_array.len()
        );

        unsafe {
            self.0.gen_position_array_4d_unchecked(
                noise_out,
                x_pos_array,
                y_pos_array,
                z_pos_array,
                w_pos_array,
                x_offset,
                y_offset,
                z_offset,
                w_offset,
                seed,
            )
        }
    }

    /// # Panics
    /// Panics if `noise_out.len() < x_size * y_size`.
    pub fn gen_tileable_2d(
        &self,
        noise_out: &mut [f32],
        x_size: i32,
        y_size: i32,
        x_step_size: f32,
        y_step_size: f32,
        seed: i32,
    ) -> OutputMinMax {
        assert!(noise_out.len() >= (x_size * y_size) as usize);

        unsafe {
            self.0.gen_tileable_2d_unchecked(
                noise_out,
                x_size,
                y_size,
                x_step_size,
                y_step_size,
                seed,
            )
        }
    }

    pub fn gen_single_2d(&self, x: f32, y: f32, seed: i32) -> f32 {
        unsafe { self.0.gen_single_2d_unchecked(x, y, seed) }
    }

    pub fn gen_single_3d(&self, x: f32, y: f32, z: f32, seed: i32) -> f32 {
        unsafe { self.0.gen_single_3d_unchecked(x, y, z, seed) }
    }

    pub fn gen_single_4d(&self, x: f32, y: f32, z: f32, w: f32, seed: i32) -> f32 {
        unsafe { self.0.gen_single_4d_unchecked(x, y, z, w, seed) }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        generator::{perlin::perlin, Generator},
        test_utils::*,
    };

    #[test]
    fn test_encoded_node_tree() {
        let encoded = "DQAFAAAAAAAAQAgAAAAAAD8="; // Simple Perlin
        let node = SafeNode::from_encoded_node_tree(encoded);
        // This might fail if the encoded string is invalid
        if let Ok(node) = node {
            test_generator_produces_output(node);
        }
    }

    #[test]
    fn test_gen_single_2d() {
        let node = perlin().build();
        let value = node.0.gen_single_2d(0.5, 0.5, 1337);
        assert!(value.is_finite());
        assert!(value >= -1.5 && value <= 1.5); // Perlin should be roughly -1 to 1
    }

    #[test]
    fn test_gen_single_3d() {
        let node = perlin().build();
        let value = node.0.gen_single_3d(0.5, 0.5, 0.5, 1337);
        assert!(value.is_finite());
    }

    #[test]
    fn test_gen_uniform_grid_3d() {
        let node = perlin().build();
        let mut output = [0.0f32; 64]; // 4x4x4
        let min_max =
            node.0
                .gen_uniform_grid_3d(&mut output, 0.0, 0.0, 0.0, 4, 4, 4, 0.1, 0.1, 0.1, 1337);
        assert!(min_max.min.is_finite());
        assert!(min_max.max.is_finite());
        assert!(output.iter().any(|&v| v != output[0]));
    }

    #[test]
    fn test_gen_uniform_grid_4d() {
        let node = perlin().build();
        let mut output = [0.0f32; 16]; // 2x2x2x2
        let min_max = node.0.gen_uniform_grid_4d(
            &mut output,
            0.0,
            0.0,
            0.0,
            0.0,
            2,
            2,
            2,
            2,
            0.1,
            0.1,
            0.1,
            0.1,
            1337,
        );
        assert!(min_max.min.is_finite());
        assert!(min_max.max.is_finite());
        assert!(output.iter().any(|&v| v != output[0]));
    }

    #[test]
    fn test_gen_position_array_2d() {
        let node = perlin().build();
        let x_pos = [0.0, 0.1, 0.2, 0.3];
        let y_pos = [0.0, 0.1, 0.2, 0.3];
        let mut output = [0.0f32; 4];
        let min_max = node
            .0
            .gen_position_array_2d(&mut output, &x_pos, &y_pos, 0.0, 0.0, 1337);
        assert!(min_max.min.is_finite());
        assert!(min_max.max.is_finite());
        assert!(output.iter().all(|&v| v.is_finite()));
    }

    #[test]
    fn test_gen_position_array_3d() {
        let node = perlin().build();
        let x_pos = [0.0, 0.1, 0.2, 0.3];
        let y_pos = [0.0, 0.1, 0.2, 0.3];
        let z_pos = [0.0, 0.1, 0.2, 0.3];
        let mut output = [0.0f32; 4];
        let min_max =
            node.0
                .gen_position_array_3d(&mut output, &x_pos, &y_pos, &z_pos, 0.0, 0.0, 0.0, 1337);
        assert!(min_max.min.is_finite());
        assert!(min_max.max.is_finite());
        assert!(output.iter().all(|&v| v.is_finite()));
    }

    #[test]
    fn test_gen_position_array_4d() {
        let node = perlin().build();
        let x_pos = [0.0, 0.1, 0.2, 0.3];
        let y_pos = [0.0, 0.1, 0.2, 0.3];
        let z_pos = [0.0, 0.1, 0.2, 0.3];
        let w_pos = [0.0, 0.1, 0.2, 0.3];
        let mut output = [0.0f32; 4];
        let min_max = node.0.gen_position_array_4d(
            &mut output,
            &x_pos,
            &y_pos,
            &z_pos,
            &w_pos,
            0.0,
            0.0,
            0.0,
            0.0,
            1337,
        );
        assert!(min_max.min.is_finite());
        assert!(min_max.max.is_finite());
        assert!(output.iter().all(|&v| v.is_finite()));
    }

    #[test]
    fn test_gen_tileable_2d() {
        let node = perlin().build();
        let mut output = [0.0f32; 16]; // 4x4
        let min_max = node.0.gen_tileable_2d(&mut output, 4, 4, 0.1, 0.1, 1337);
        assert!(min_max.min.is_finite());
        assert!(min_max.max.is_finite());
        assert!(output.iter().any(|&v| v != output[0]));
    }

    #[test]
    fn test_gen_single_4d() {
        let node = perlin().build();
        let value = node.0.gen_single_4d(0.5, 0.5, 0.5, 0.5, 1337);
        assert!(value.is_finite());
    }

    #[test]
    fn test_get_simd_level() {
        let node = perlin().build();
        let simd_level = node.0.get_simd_level();
        // Just verify we can get a SIMD level - the actual value depends on the system
        // SIMD levels: 0=Scalar, 1=SSE, 2=SSE2, 3=SSE3, 4=SSSE3, 5=SSE41, 6=SSE42,
        //              7=AVX, 8=AVX2, 9=AVX512
        // On systems with AVX-512 this will be higher
        assert!(simd_level < u32::MAX); // Just verify it's a valid number
    }
}