diff options
Diffstat (limited to 'source/blender/blenlib/BLI_noise.hh')
| -rw-r--r-- | source/blender/blenlib/BLI_noise.hh | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/source/blender/blenlib/BLI_noise.hh b/source/blender/blenlib/BLI_noise.hh index 7e1655f7864..839bee0f2f4 100644 --- a/source/blender/blenlib/BLI_noise.hh +++ b/source/blender/blenlib/BLI_noise.hh @@ -22,12 +22,12 @@ namespace blender::noise { -/* -------------------------------------------------------------------- - * Hash functions. - +/* -------------------------------------------------------------------- */ +/** \name Hash Functions + * * Create a randomized hash from the given inputs. Contrary to hash functions in `BLI_hash.hh` * these functions produce better randomness but are more expensive to compute. - */ + * \{ */ /* Hash integers to `uint32_t`. */ uint32_t hash(uint32_t kx); @@ -53,9 +53,11 @@ float hash_float_to_float(float2 k); float hash_float_to_float(float3 k); float hash_float_to_float(float4 k); -/* -------------------------------------------------------------------- - * Perlin noise. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Perlin Noise + * \{ */ /* Perlin noise in the range [-1, 1]. */ float perlin_signed(float position); @@ -99,4 +101,6 @@ float3 perlin_float3_fractal_distorted(float4 position, float roughness, float distortion); +/** \} */ + } // namespace blender::noise |