doxygen: add newline after \file
[blender.git] / source / blender / blenlib / BLI_noise.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_NOISE_H__
21 #define __BLI_NOISE_H__
22
23 /** \file
24  * \ingroup bli
25  */
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 /* noise.h: */
32 float BLI_hnoise(float noisesize, float x, float y, float z);
33 float BLI_hnoisep(float noisesize, float x, float y, float z);
34 float BLI_turbulence(float noisesize, float x, float y, float z, int nr);
35 float BLI_turbulence1(float noisesize, float x, float y, float z, int nr);
36 /* newnoise: generic noise & turbulence functions
37  * to replace the above BLI_hnoise/p & BLI_turbulence/1.
38  * This is done so different noise basis functions can be used */
39 float BLI_gNoise(float noisesize, float x, float y, float z, int hard, int noisebasis);
40 float BLI_gTurbulence(float noisesize, float x, float y, float z, int oct, int hard, int noisebasis);
41 /* newnoise: musgrave functions */
42 float mg_fBm(float x, float y, float z, float H, float lacunarity, float octaves, int noisebasis);
43 float mg_MultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, int noisebasis);
44 float mg_VLNoise(float x, float y, float z, float distortion, int nbas1, int nbas2);
45 float mg_HeteroTerrain(float x, float y, float z, float H, float lacunarity, float octaves, float offset, int noisebasis);
46 float mg_HybridMultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, float offset, float gain, int noisebasis);
47 float mg_RidgedMultiFractal(float x, float y, float z, float H, float lacunarity, float octaves, float offset, float gain, int noisebasis);
48 /* newnoise: voronoi */
49 void voronoi(float x, float y, float z, float *da, float *pa, float me, int dtype);
50 /* newnoise: cellNoise & cellNoiseV (for vector/point/color) */
51 float cellNoise(float x, float y, float z);
52 void cellNoiseV(float x, float y, float z, float r_ca[3]);
53
54 #ifdef __cplusplus
55 }
56 #endif
57
58 #endif