d39532046782e54313ccbdc175b0217e40886d8e
[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 /* fix for OSA and defmaterial extern */
44 #include "BKE_osa_types.h"
45 #include "DNA_material_types.h"
46
47 #ifdef __cplusplus
48 extern "C" { 
49 #endif
50
51 /* For #undefs of stupid windows defines */
52 #ifdef WIN32
53 #include "BLI_winstuff.h"
54 #endif
55
56 /* ------------------------------------------------------------------------- */
57 /* Types                                                                     */
58 /* Both external and internal types can be placed here. Make sure there are  */
59 /* no dirty extras in the type files so they can be included without         */
60 /* problems. If possible, make a note why the include is needed.             */
61 /* ------------------------------------------------------------------------- */
62
63 #include "render_types.h"
64
65 /* ------------------------------------------------------------------------- */
66 /* Global variables                                                          */
67 /* These variable are global to the render module, and also externally       */
68 /* visible. The file where they are defined must be added.                   */
69 /* ------------------------------------------------------------------------- */
70
71 extern RE_Render         R;           /* rendercore.c */
72 extern Osa               O;           /* rendercore.c */
73 extern Material          defmaterial; /* initrender.c */
74 extern unsigned short   *igamtab1;    /* initrender.c */
75 extern unsigned short   *gamtab;      /* initrender.c */
76
77 struct View3D;
78
79 /* ------------------------------------------------------------------------- */
80 /* Function definitions                                                      */
81 /*                                                                           */
82 /* All functions that need to be externally visible must be declared here.   */
83 /* Currently, this interface contains 29 functions and 11 callbacks.         */
84 /* ------------------------------------------------------------------------- */
85
86
87 /* ------------------------------------------------------------------------- */
88 /* shadbuf.c (1)                                                           */
89 /* ------------------------------------------------------------------------- */
90
91 void RE_initshadowbuf(struct LampRen *lar, float mat[][4]);
92
93
94 /* ------------------------------------------------------------------------- */
95 /* initrender (14)                                                           */
96 /* ------------------------------------------------------------------------- */
97
98 struct View3D;
99
100 /**
101  * Guarded call to frame renderer? Tests several limits and boundary
102  * conditions. 
103  * 
104  * @param ogl_render_area The View3D area to use for OpenGL rendering
105  * (can be NULL unless render R_OGL flag is set)
106  */
107 void    RE_initrender(struct View3D *ogl_render_view3d);
108
109 /**
110  *
111  */
112 void    RE_setwindowclip(int mode, int jmode);
113
114 /*
115  * @param ogl_render_area The View3D area to use for OpenGL rendering
116  * (can be NULL unless render R_OGL flag is set)
117  */
118 void    RE_animrender(struct View3D *ogl_render_view3d);
119 void    RE_free_render_data(void);
120 void    RE_free_filt_mask(void);
121 void    RE_init_filt_mask(void);
122 void    RE_init_render_data(void);
123 void    RE_jitterate1(float *jit1, float *jit2, int num, float rad1);
124 void    RE_jitterate2(float *jit1, float *jit2, int num, float rad2);
125 void    RE_make_existing_file(char *name);
126
127 /* ------------------------------------------------------------------------- */
128 /* zbuf (2)                                                                  */
129 /* ------------------------------------------------------------------------- */
130
131 /**
132  * Converts a world coordinate into a homogenous coordinate in view
133  * coordinates. (WCS -> HCS)
134  * Also called in: shadbuf.c render.c radfactors.c
135  *                 initrender.c envmap.c editmesh.c
136  * @param v1  [3 floats] the world coordinate
137  * @param adr [4 floats] the homogenous view coordinate
138  */
139 void    RE_projectverto(float *v1,float *adr);
140
141 /**
142  * Something about doing radiosity z buffering?
143  * (called in radfactors.c), hope the RadView is defined already... 
144  * Also called in: radfactors.c
145  * Note: Uses globals.
146  * @param radview radiosity view definition
147  */
148         struct RadView;
149         struct RNode;
150 void    RE_zbufferall_radio(struct RadView *vw, struct RNode **rg_elem, int rg_totelem);
151
152
153 /* ------------------------------------------------------------------------- */
154 /* texture                                                                    */
155 /* ------------------------------------------------------------------------- */
156 struct MTex;
157 struct Tex;
158
159 void init_render_textures(void);
160 void end_render_textures(void);
161 void init_render_texture(struct Tex *tex);
162 void end_render_texture(struct Tex *tex);
163
164 void tubemap(float x, float y, float z, float *adr1, float *adr2);
165 void spheremap(float x, float y, float z, float *adr1, float *adr2);
166
167 void do_material_tex(ShadeInput *shi);
168 void externtex(struct MTex *mtex, float *vec);
169 void externtexcol(struct MTex *mtex, float *orco, char *col);
170 void do_lamp_tex(struct LampRen *la, float *lavec, ShadeInput *shi);
171 void do_sky_tex(float *);
172
173 int multitex(struct Tex *tex, float *texvec, float *dxt, float *dyt, int osatex);
174
175
176 /* ------------------------------------------------------------------------- */
177 /* envmap (4)                                                                   */
178 /* ------------------------------------------------------------------------- */
179 struct EnvMap;
180 struct Tex;
181
182 void    RE_free_envmapdata(struct EnvMap *env);
183 void    RE_free_envmap(struct EnvMap *env);
184 struct EnvMap *RE_add_envmap(void);
185 /* these two maybe not external? yes, they are, for texture.c */
186 struct EnvMap *RE_copy_envmap(struct EnvMap *env);
187
188 /* --------------------------------------------------------------------- */
189 /* rendercore (2)                                                        */
190 /* --------------------------------------------------------------------- */
191 float Phong_Spec(float *n, float *l, float *v, int hard);
192 float CookTorr_Spec(float *n, float *l, float *v, int hard);
193 float Blinn_Spec(float *n, float *l, float *v, float refrac, float spec_power);
194 float Toon_Spec( float *n, float *l, float *v, float size, float smooth);
195 float OrenNayar_Diff(float *n, float *l, float *v, float rough);
196 float Toon_Diff( float *n, float *l, float *v, float size, float smooth);
197 void add_to_diffuse(float *diff, ShadeInput *shi, float is, float r, float g, float b);
198 void ramp_diffuse_result(float *diff, ShadeInput *shi);
199 void do_specular_ramp(ShadeInput *shi, float is, float t, float *spec);
200 void ramp_spec_result(float *specr, float *specg, float *specb, ShadeInput *shi);
201
202
203 /* --------------------------------------------------------------------- */
204 /* renderdatabase (3)                                                    */
205 /* --------------------------------------------------------------------- */
206 struct VlakRen *RE_findOrAddVlak(int nr);
207 struct VertRen *RE_findOrAddVert(int nr);
208 struct HaloRen *RE_findOrAddHalo(int nr);
209 HaloRen *RE_inithalo(Material *ma, float *vec, float *vec1, float *orco, float hasize, 
210                                         float vectsize);
211
212
213 /**
214         * callbacks (11):
215         *
216         * If the callbacks aren't set, rendering will still proceed as
217         * desired, but the concerning functionality will not be enabled.
218         *
219         * There need to be better uncoupling between the renderer and
220         * these functions still!
221         * */
222
223 void RE_set_test_break_callback(int (*f)(void));
224
225 void RE_set_timecursor_callback(void (*f)(int));
226
227 void RE_set_renderdisplay_callback(void (*f)(int, int, int, int, unsigned int *));
228 void RE_set_initrenderdisplay_callback(void (*f)(void));
229 void RE_set_clearrenderdisplay_callback(void (*f)(short));
230
231 void RE_set_printrenderinfo_callback(void (*f)(double,int));
232
233 void RE_set_getrenderdata_callback(void (*f)(void));
234 void RE_set_freerenderdata_callback(void (*f)(void));
235
236
237 /*from renderhelp, should disappear!!! */ 
238 /** Recalculate all normals on renderdata. */
239 void set_normalflags(void);
240 /**
241         * On loan from zbuf.h:
242         * Tests whether the first three coordinates should be clipped
243         * wrt. the fourth component. Bits 1 and 2 test on x, 3 and 4 test on
244         * y, 5 and 6 test on z:
245         * xyz >  test => set first bit   (01),
246         * xyz < -test => set second bit  (10),
247         * xyz == test => reset both bits (00).
248         * Note: functionality is duplicated from an internal function
249         * Also called in: initrender.c, radfactors.c
250         * @param  v [4 floats] a coordinate 
251         * @return a vector of bitfields
252         */
253 int RE_testclip(float *v); 
254
255 /* patch for the external if, to support the split for the ui */
256 void RE_addalphaAddfac(char *doel, char *bron, char addfac);
257 void RE_sky_char(float *view, char *col); 
258 void RE_sky(float *view, float *col); 
259 void RE_renderflare(struct HaloRen *har); 
260 /**
261         * Shade the pixel at xn, yn for halo har, and write the result to col. 
262         * Also called in: previewrender.c
263         * @param har    The halo to be rendered on this location
264         * @param col    [unsigned int 3] The destination colour vector 
265         * @param zz     Some kind of distance
266         * @param dist   Square of the distance of this coordinate to the halo's center
267         * @param x      [f] Pixel x relative to center
268         * @param y      [f] Pixel y relative to center
269         * @param flarec Flare counter? Always har->flarec...
270         */
271 void RE_shadehalo(struct HaloRen *har,
272                                 char *col,
273                                 unsigned int zz,
274                                 float dist,
275                                 float x,
276                                 float y,
277                                 short flarec); 
278
279 /***/
280
281 /* haloren->type: flags */
282
283 #define HA_ONLYSKY              1
284 #define HA_VECT                 2
285 #define HA_XALPHA               4
286 #define HA_FLARECIRC    8
287
288 #ifdef __cplusplus
289 }
290 #endif
291
292 #endif /* RENDER_H */
293