Biiig commit! Thanks to 2-3 weeks of cvs freeze...
[blender.git] / source / blender / render / extern / include / render.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * Interface to transform the Blender scene into renderable data.
32  */
33
34 #ifndef RENDER_H
35 #define RENDER_H "$Id$"
36
37 /* ------------------------------------------------------------------------- */
38 /* This little preamble might be moved to a separate include. It contains    */
39 /* some defines that should become functions, and some platform dependency   */
40 /* fixes. I think it is risky to always include it...                        */
41 /* ------------------------------------------------------------------------- */
42
43
44 #ifdef __cplusplus
45 extern "C" { 
46 #endif
47
48 /* For #undefs of stupid windows defines */
49 #ifdef WIN32
50 #include "BLI_winstuff.h"
51 #endif
52
53 /* ------------------------------------------------------------------------- */
54 /* Types                                                                     */
55 /* Both external and internal types can be placed here. Make sure there are  */
56 /* no dirty extras in the type files so they can be included without         */
57 /* problems. If possible, make a note why the include is needed.             */
58 /* ------------------------------------------------------------------------- */
59
60 #include "render_types.h"
61
62 /* ------------------------------------------------------------------------- */
63 /* Global variables                                                          */
64 /* These variable are global to the render module, and also externally       */
65 /* visible. The file where they are defined must be added.                   */
66 /* ------------------------------------------------------------------------- */
67
68 extern RE_Render         R;           /* rendercore.c */
69 extern unsigned short   *igamtab1;    /* initrender.c */
70 extern unsigned short   *gamtab;      /* initrender.c */
71
72 struct View3D;
73
74 /* ------------------------------------------------------------------------- */
75 /* Function definitions                                                      */
76 /*                                                                           */
77 /* All functions that need to be externally visible must be declared here.   */
78 /* Currently, this interface contains 38 functions and 11 callbacks.         */
79 /* ------------------------------------------------------------------------- */
80
81
82 /* ------------------------------------------------------------------------- */
83 /* shadbuf.c (1)                                                           */
84 /* ------------------------------------------------------------------------- */
85
86 /* only for renderconvertor */
87 void RE_initshadowbuf(struct LampRen *lar, float mat[][4]);
88
89
90 /* ------------------------------------------------------------------------- */
91 /* initrender (9)                                                           */
92 /* ------------------------------------------------------------------------- */
93
94 struct View3D;
95
96 /**
97  * Guarded call to frame renderer? Tests several limits and boundary
98  * conditions. 
99  * 
100  * @param ogl_render_area The View3D area to use for OpenGL rendering
101  * (can be NULL unless render R_OGL flag is set)
102  */
103 void    RE_initrender(struct View3D *ogl_render_view3d);
104
105 /**
106  * only for renderconvertor
107  */
108 void    RE_setwindowclip(int mode, int jmode);
109
110 /*
111  * @param ogl_render_area The View3D area to use for OpenGL rendering
112  * (can be NULL unless render R_OGL flag is set)
113  */
114 void    RE_animrender(struct View3D *ogl_render_view3d);
115 void    RE_free_render_data(void);
116 void    RE_init_render_data(void);
117                 /* jitterate is used by blenkernel effect */
118 void    RE_jitterate1(float *jit1, float *jit2, int num, float rad1);
119 void    RE_jitterate2(float *jit1, float *jit2, int num, float rad2);
120 void    RE_make_existing_file(char *name);
121 void    RE_floatbuffer_to_output(void);
122
123 /* ------------------------------------------------------------------------- */
124 /* zbuf (2)                                                                  */
125 /* ------------------------------------------------------------------------- */
126
127 /**
128  * Converts a world coordinate into a homogenous coordinate in view
129  * coordinates. (WCS -> HCS)
130  * Also called in: shadbuf.c render.c radfactors.c
131  *                 initrender.c envmap.c editmesh.c
132  * @param v1  [3 floats] the world coordinate
133  * @param adr [4 floats] the homogenous view coordinate
134  */
135 void    RE_projectverto(float *v1,float *adr);
136
137 /**
138  * Something about doing radiosity z buffering?
139  * (called in radfactors.c), hope the RadView is defined already... 
140  * Also called in: radfactors.c
141  * Note: Uses globals.
142  * @param radview radiosity view definition
143  */
144         struct RadView;
145         struct RNode;
146 void    RE_zbufferall_radio(struct RadView *vw, struct RNode **rg_elem, int rg_totelem);
147
148
149 /* ------------------------------------------------------------------------- */
150 /* texture  (9)                                                                  */
151 /* ------------------------------------------------------------------------- */
152 struct MTex;
153 struct Tex;
154
155 void init_render_textures(void);
156 void end_render_textures(void);
157 void init_render_texture(struct Tex *tex);
158 void end_render_texture(struct Tex *tex);
159
160 void do_material_tex(ShadeInput *shi);
161 void do_lamp_tex(struct LampRen *la, float *lavec, ShadeInput *shi, float *fcol);
162
163 int multitex_ext(struct Tex *tex, float *texvec, float *tin, float *tr, float *tg, float *tb, float *ta);
164 void externtex(struct MTex *mtex, float *vec, float *tin, float *tr, float *tg, float *tb, float *ta);
165
166 /* ------------------------------------------------------------------------- */
167 /* envmap (4)                                                                   */
168 /* ------------------------------------------------------------------------- */
169 struct EnvMap;
170 struct Tex;
171
172 void    RE_free_envmapdata(struct EnvMap *env);
173 void    RE_free_envmap(struct EnvMap *env);
174 struct EnvMap *RE_add_envmap(void);
175 /* these two maybe not external? yes, they are, for texture.c */
176 struct EnvMap *RE_copy_envmap(struct EnvMap *env);
177
178 /* --------------------------------------------------------------------- */
179 /* rendercore (10)                                                        */
180 /* --------------------------------------------------------------------- */
181 float Phong_Spec(float *n, float *l, float *v, int hard);
182 float CookTorr_Spec(float *n, float *l, float *v, int hard);
183 float Blinn_Spec(float *n, float *l, float *v, float refrac, float spec_power);
184 float Toon_Spec( float *n, float *l, float *v, float size, float smooth);
185 float OrenNayar_Diff(float *n, float *l, float *v, float rough);
186 float Toon_Diff( float *n, float *l, float *v, float size, float smooth);
187 void add_to_diffuse(float *diff, ShadeInput *shi, float is, float r, float g, float b);
188 void ramp_diffuse_result(float *diff, ShadeInput *shi);
189 void do_specular_ramp(ShadeInput *shi, float is, float t, float *spec);
190 void ramp_spec_result(float *specr, float *specg, float *specb, ShadeInput *shi);
191
192
193 /* --------------------------------------------------------------------- */
194 /* renderdatabase (3)                                                    */
195 /* --------------------------------------------------------------------- */
196 struct VlakRen *RE_findOrAddVlak(int nr);
197 struct VertRen *RE_findOrAddVert(int nr);
198 struct HaloRen *RE_findOrAddHalo(int nr);
199 HaloRen *RE_inithalo(struct Material *ma, float *vec, float *vec1, float *orco, float hasize, 
200                                         float vectsize, int seed);
201
202 /**
203         * callbacks (11):
204         *
205         * If the callbacks aren't set, rendering will still proceed as
206         * desired, but the concerning functionality will not be enabled.
207         *
208         * There need to be better uncoupling between the renderer and
209         * these functions still!
210         * */
211
212 void RE_set_test_break_callback(int (*f)(void));
213
214 void RE_set_timecursor_callback(void (*f)(int));
215
216 void RE_set_renderdisplay_callback(void (*f)(int, int, int, int, unsigned int *));
217 void RE_set_initrenderdisplay_callback(void (*f)(void));
218 void RE_set_clearrenderdisplay_callback(void (*f)(short));
219
220 void RE_set_printrenderinfo_callback(void (*f)(double,int));
221
222 void RE_set_getrenderdata_callback(void (*f)(void));
223 void RE_set_freerenderdata_callback(void (*f)(void));
224
225
226 /*from renderhelp, should disappear!!! */ 
227 /** Recalculate all normals on renderdata. */
228 void set_normalflags(void);
229 /**
230         * On loan from zbuf.h:
231         * Tests whether the first three coordinates should be clipped
232         * wrt. the fourth component. Bits 1 and 2 test on x, 3 and 4 test on
233         * y, 5 and 6 test on z:
234         * xyz >  test => set first bit   (01),
235         * xyz < -test => set second bit  (10),
236         * xyz == test => reset both bits (00).
237         * Note: functionality is duplicated from an internal function
238         * Also called in: initrender.c, radfactors.c
239         * @param  v [4 floats] a coordinate 
240         * @return a vector of bitfields
241         */
242 int RE_testclip(float *v); 
243
244 /* patch for the external if, to support the split for the ui */
245 void RE_addalphaAddfac(char *doel, char *bron, char addfac);
246 void RE_sky_char(float *view, char *col); 
247 void RE_renderflare(struct HaloRen *har); 
248 /**
249         * Shade the pixel at xn, yn for halo har, and write the result to col. 
250         * Also called in: previewrender.c
251         * @param har    The halo to be rendered on this location
252         * @param col    [char 4] The destination colour vector 
253         * @param colf   [float 4] destination colour vector (need both)
254         * @param zz     Some kind of distance
255         * @param dist   Square of the distance of this coordinate to the halo's center
256         * @param x      [f] Pixel x relative to center
257         * @param y      [f] Pixel y relative to center
258         * @param flarec Flare counter? Always har->flarec...
259         */
260 void RE_shadehalo(struct HaloRen *har,
261                                 char *col, float *colf, 
262                                 unsigned int zz,
263                                 float dist,
264                                 float x,
265                                 float y,
266                                 short flarec); 
267
268 /***/
269
270 /* haloren->type: flags */
271
272 #define HA_ONLYSKY              1
273 #define HA_VECT                 2
274 #define HA_XALPHA               4
275 #define HA_FLARECIRC    8
276
277 #ifdef __cplusplus
278 }
279 #endif
280
281 #endif /* RENDER_H */
282