Cuda use streams and async to avoid busywaiting
[blender.git] / intern / smoke / extern / smoke_API.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 by Daniel Genrich
19  * All rights reserved.
20  *
21  * Contributor(s): Daniel Genrich
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file smoke/extern/smoke_API.h
27  *  \ingroup smoke
28  */
29
30
31 #ifndef SMOKE_API_H_
32 #define SMOKE_API_H_
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 struct FLUID_3D;
39
40 // low res
41 struct FLUID_3D *smoke_init(int *res, float dx, float dtdef, int use_heat, int use_fire, int use_colors);
42 void smoke_free(struct FLUID_3D *fluid);
43
44 void smoke_initBlenderRNA(struct FLUID_3D *fluid, float *alpha, float *beta, float *dt_factor, float *vorticity, int *border_colli, float *burning_rate,
45                                                   float *flame_smoke, float *flame_smoke_color, float *flame_vorticity, float *flame_ignition_temp, float *flame_max_temp);
46 void smoke_step(struct FLUID_3D *fluid, float gravity[3], float dtSubdiv);
47
48 float *smoke_get_density(struct FLUID_3D *fluid);
49 float *smoke_get_flame(struct FLUID_3D *fluid);
50 float *smoke_get_fuel(struct FLUID_3D *fluid);
51 float *smoke_get_react(struct FLUID_3D *fluid);
52 float *smoke_get_color_r(struct FLUID_3D *fluid);
53 float *smoke_get_color_g(struct FLUID_3D *fluid);
54 float *smoke_get_color_b(struct FLUID_3D *fluid);
55 void smoke_get_rgba(struct FLUID_3D *fluid, float *data, int sequential);
56 void smoke_get_rgba_from_density(struct FLUID_3D *fluid, float color[3], float *data, int sequential);
57 float *smoke_get_heat(struct FLUID_3D *fluid);
58 float *smoke_get_velocity_x(struct FLUID_3D *fluid);
59 float *smoke_get_velocity_y(struct FLUID_3D *fluid);
60 float *smoke_get_velocity_z(struct FLUID_3D *fluid);
61
62 /* Moving obstacle velocity provided by blender */
63 void smoke_get_ob_velocity(struct FLUID_3D *fluid, float **x, float **y, float **z);
64
65 float *smoke_get_force_x(struct FLUID_3D *fluid);
66 float *smoke_get_force_y(struct FLUID_3D *fluid);
67 float *smoke_get_force_z(struct FLUID_3D *fluid);
68
69 unsigned char *smoke_get_obstacle(struct FLUID_3D *fluid);
70
71 size_t smoke_get_index(int x, int max_x, int y, int max_y, int z);
72 size_t smoke_get_index2d(int x, int max_x, int y);
73
74 void smoke_dissolve(struct FLUID_3D *fluid, int speed, int log);
75
76 // wavelet turbulence functions
77 struct WTURBULENCE *smoke_turbulence_init(int *res, int amplify, int noisetype, const char *noisefile_path, int use_fire, int use_colors);
78 void smoke_turbulence_free(struct WTURBULENCE *wt);
79 void smoke_turbulence_step(struct WTURBULENCE *wt, struct FLUID_3D *fluid);
80
81 float *smoke_turbulence_get_density(struct WTURBULENCE *wt);
82 float *smoke_turbulence_get_color_r(struct WTURBULENCE *wt);
83 float *smoke_turbulence_get_color_g(struct WTURBULENCE *wt);
84 float *smoke_turbulence_get_color_b(struct WTURBULENCE *wt);
85 void smoke_turbulence_get_rgba(struct WTURBULENCE *wt, float *data, int sequential);
86 void smoke_turbulence_get_rgba_from_density(struct WTURBULENCE *wt, float color[3], float *data, int sequential);
87 float *smoke_turbulence_get_flame(struct WTURBULENCE *wt);
88 float *smoke_turbulence_get_fuel(struct WTURBULENCE *wt);
89 float *smoke_turbulence_get_react(struct WTURBULENCE *wt);
90 void smoke_turbulence_get_res(struct WTURBULENCE *wt, int *res);
91 int smoke_turbulence_get_cells(struct WTURBULENCE *wt);
92 void smoke_turbulence_set_noise(struct WTURBULENCE *wt, int type, const char *noisefile_path);
93 void smoke_initWaveletBlenderRNA(struct WTURBULENCE *wt, float *strength);
94 void smoke_dissolve_wavelet(struct WTURBULENCE *wt, int speed, int log);
95
96 /* export */
97 void smoke_export(struct FLUID_3D *fluid, float *dt, float *dx, float **dens, float **react, float **flame, float **fuel, float **heat, float **heatold,
98                                   float **vx, float **vy, float **vz, float **r, float **g, float **b, unsigned char **obstacles);
99 void smoke_turbulence_export(struct WTURBULENCE *wt, float **dens, float **react, float **flame, float **fuel,
100                                                          float **r, float **g, float **b, float **tcu, float **tcv, float **tcw);
101
102 /* flame spectrum */
103 void flame_get_spectrum(unsigned char *spec, int width, float t1, float t2);
104
105 /* data fields */
106 int smoke_has_heat(struct FLUID_3D *fluid);
107 int smoke_has_fuel(struct FLUID_3D *fluid);
108 int smoke_has_colors(struct FLUID_3D *fluid);
109 int smoke_turbulence_has_fuel(struct WTURBULENCE *wt);
110 int smoke_turbulence_has_colors(struct WTURBULENCE *wt);
111
112 void smoke_ensure_heat(struct FLUID_3D *fluid);
113 void smoke_ensure_fire(struct FLUID_3D *fluid, struct WTURBULENCE *wt);
114 void smoke_ensure_colors(struct FLUID_3D *fluid, struct WTURBULENCE *wt, float init_r, float init_g, float init_b);
115
116 #ifdef __cplusplus
117 }
118 #endif
119
120 #endif /* SMOKE_API_H_ */