Fix T64623: Freestyle procedural noise not consistent across platforms
[blender.git] / source / blender / blenlib / BLI_rand.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_RAND_H__
21 #define __BLI_RAND_H__
22
23 /** \file
24  * \ingroup bli
25  * \brief Random number functions.
26  */
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 /* RNG is an abstract random number generator type that avoids using globals.
33  * Always use this instead of the global RNG unless you have a good reason,
34  * the global RNG is not thread safe and will not give repeatable results.
35  */
36 struct RNG;
37 typedef struct RNG RNG;
38
39 struct RNG_THREAD_ARRAY;
40 typedef struct RNG_THREAD_ARRAY RNG_THREAD_ARRAY;
41
42 struct RNG *BLI_rng_new(unsigned int seed);
43 struct RNG *BLI_rng_new_srandom(unsigned int seed);
44 struct RNG *BLI_rng_copy(struct RNG *rng) ATTR_NONNULL(1);
45 void BLI_rng_free(struct RNG *rng) ATTR_NONNULL(1);
46
47 void BLI_rng_seed(struct RNG *rng, unsigned int seed) ATTR_NONNULL(1);
48 void BLI_rng_srandom(struct RNG *rng, unsigned int seed) ATTR_NONNULL(1);
49 void BLI_rng_get_char_n(RNG *rng, char *bytes, size_t bytes_len) ATTR_NONNULL(1, 2);
50 int BLI_rng_get_int(struct RNG *rng) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
51 unsigned int BLI_rng_get_uint(struct RNG *rng) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
52 double BLI_rng_get_double(struct RNG *rng) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
53 float BLI_rng_get_float(struct RNG *rng) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
54 void BLI_rng_get_float_unit_v2(struct RNG *rng, float v[2]) ATTR_NONNULL(1, 2);
55 void BLI_rng_get_float_unit_v3(struct RNG *rng, float v[3]) ATTR_NONNULL(1, 2);
56 void BLI_rng_get_tri_sample_float_v2(struct RNG *rng,
57                                      const float v1[2],
58                                      const float v2[2],
59                                      const float v3[2],
60                                      float r_pt[2]) ATTR_NONNULL();
61 void BLI_rng_shuffle_array(struct RNG *rng,
62                            void *data,
63                            unsigned int elem_size_i,
64                            unsigned int elem_tot) ATTR_NONNULL(1, 2);
65
66 /** Note that skipping is as slow as generating n numbers! */
67 void BLI_rng_skip(struct RNG *rng, int n) ATTR_NONNULL(1);
68
69 /* fill an array with random numbers */
70 void BLI_array_frand(float *ar, int count, unsigned int seed);
71
72 /** Return a pseudo-random (hash) float from an integer value */
73 float BLI_hash_frand(unsigned int seed) ATTR_WARN_UNUSED_RESULT;
74
75 /** Shuffle an array randomly using the given seed.
76  * contents. This routine does not use nor modify
77  * the state of the BLI random number generator.
78  */
79 void BLI_array_randomize(void *data,
80                          unsigned int elem_size,
81                          unsigned int elem_tot,
82                          unsigned int seed);
83
84 /** Better seed for the random number generator, using noise.c hash[] */
85 /** Allows up to BLENDER_MAX_THREADS threads to address */
86 void BLI_thread_srandom(int thread, unsigned int seed);
87
88 /** Return a pseudo-random number N where 0<=N<(2^31) */
89 /** Allows up to BLENDER_MAX_THREADS threads to address */
90 int BLI_thread_rand(int thread) ATTR_WARN_UNUSED_RESULT;
91
92 /** Return a pseudo-random number N where 0.0f<=N<1.0f */
93 /** Allows up to BLENDER_MAX_THREADS threads to address */
94 float BLI_thread_frand(int thread) ATTR_WARN_UNUSED_RESULT;
95
96 /** array versions for thread safe random generation */
97 RNG_THREAD_ARRAY *BLI_rng_threaded_new(void);
98 void BLI_rng_threaded_free(struct RNG_THREAD_ARRAY *rngarr) ATTR_NONNULL(1);
99 int BLI_rng_thread_rand(RNG_THREAD_ARRAY *rngarr, int thread) ATTR_WARN_UNUSED_RESULT;
100
101 /* Low-discrepancy sequences. */
102
103 /** Return the _n_th number of the given low-discrepancy sequence. */
104 void BLI_halton_1d(unsigned int prime, double offset, int n, double *r);
105 void BLI_halton_2d(unsigned int prime[2], double offset[2], int n, double *r);
106 void BLI_halton_3d(unsigned int prime[3], double offset[3], int n, double *r);
107 void BLI_hammersley_1d(unsigned int n, double *r);
108
109 /** Return the whole low-discrepancy sequence up to _n_. */
110 void BLI_halton_2d_sequence(unsigned int prime[2], double offset[2], int n, double *r);
111 void BLI_hammersley_2d_sequence(unsigned int n, double *r);
112
113 #ifdef __cplusplus
114 }
115 #endif
116
117 #endif /* __BLI_RAND_H__ */