uvcalc_lightmap would raise an error on meshes with no faces.
[blender.git] / source / blender / render / extern / include / RE_pipeline.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL 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. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2006 Blender Foundation.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef RE_PIPELINE_H
31 #define RE_PIPELINE_H
32
33 #include "DNA_listBase.h"
34 #include "DNA_vec_types.h"
35 #include "BKE_utildefines.h"
36
37 struct Scene;
38 struct RenderData;
39 struct NodeBlurData;
40 struct Object;
41 struct bNodeTree;
42
43 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
44 /* this include is what is exposed of render to outside world */
45 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
46
47
48 #define RE_MAXNAME      32
49
50 /* only used as handle */
51 typedef struct Render Render;
52
53 /* Render Result usage:
54
55 - render engine allocates/frees and delivers raw floating point rects
56 - right now it's full rects, but might become tiles or file 
57 - the display client has to allocate display rects, sort out what to display, 
58   and how it's converted
59 */
60
61 typedef struct RenderPass {
62         struct RenderPass *next, *prev;
63         int passtype, channels;
64         char name[16];          /* amount defined in openexr_multi.h */
65         char chan_id[8];        /* amount defined in openexr_multi.h */
66         float *rect;
67 } RenderPass;
68
69 /* a renderlayer is a full image, but with all passes and samples */
70 /* size of the rects is defined in RenderResult */
71 /* after render, the Combined pass is in rectf, for renderlayers read from files it is a real pass */
72 typedef struct RenderLayer {
73         struct RenderLayer *next, *prev;
74         
75         /* copy of RenderData */
76         char name[RE_MAXNAME];          
77         unsigned int lay, lay_zmask;
78         int layflag, passflag, pass_xor;                
79         
80         struct Material *mat_override;
81         struct Group *light_override;
82         
83         float *rectf;           /* 4 float, standard rgba buffer (read not above!) */
84         float *acolrect;        /* 4 float, optional transparent buffer, needs storage for display updates */
85         float *scolrect;        /* 4 float, optional strand buffer, needs storage for display updates */
86         
87         ListBase passes;
88         
89 } RenderLayer;
90
91 typedef struct RenderResult {
92         struct RenderResult *next, *prev;
93         
94         /* target image size */
95         int rectx, recty;
96         short crop, sample_nr;
97         
98         /* optional, 32 bits version of picture, used for ogl render and image curves */
99         int *rect32;
100         /* if this exists, a copy of one of layers, or result of composited layers */
101         float *rectf;
102         /* if this exists, a copy of one of layers, or result of composited layers */
103         float *rectz;
104         
105         /* coordinates within final image (after cropping) */
106         rcti tilerect;
107         /* offset to apply to get a border render in full image */
108         int xof, yof;
109         
110         /* the main buffers */
111         ListBase layers;
112         
113         /* allowing live updates: */
114         volatile rcti renrect;
115         volatile RenderLayer *renlay;
116         
117         /* optional saved endresult on disk */
118         void *exrhandle;
119         
120         /* for render results in Image, verify validity for sequences */
121         int framenr;
122         
123 } RenderResult;
124
125
126 typedef struct RenderStats {
127         int totface, totvert, totstrand, tothalo, totlamp, totpart;
128         short curfield, curblur, curpart, partsdone, convertdone;
129         double starttime, lastframetime;
130         char *infostr;
131         
132 } RenderStats;
133
134 /* *********************** API ******************** */
135
136 /* the name is used as identifier, so elsewhere in blender the result can retrieved */
137 /* calling a new render with same name, frees automatic existing render */
138 struct Render *RE_NewRender (const char *name);
139 struct Render *RE_GetRender(const char *name);
140
141 /* use free render as signal to do everything over (previews) */
142 void RE_FreeRender (struct Render *re);
143 /* only called on exit */
144 void RE_FreeAllRender (void);
145
146 /* get results and statistics */
147 void RE_FreeRenderResult(struct RenderResult *rr);
148 struct RenderResult *RE_GetResult(struct Render *re);
149 void RE_GetResultImage(struct Render *re, struct RenderResult *rr);
150 struct RenderStats *RE_GetStats(struct Render *re);
151 void RE_ResultGet32(struct Render *re, unsigned int *rect);
152 struct RenderLayer *RE_GetRenderLayer(struct RenderResult *rr, const char *name);
153 float *RE_RenderLayerGetPass(struct RenderLayer *rl, int passtype);
154
155 /* obligatory initialize call, disprect is optional */
156 void RE_InitState (struct Render *re, struct Render *source, struct RenderData *rd, int winx, int winy, rcti *disprect);
157
158 /* use this to change disprect of active render */
159 void RE_SetDispRect (struct Render *re, rcti *disprect);
160
161 /* set up the viewplane/perspective matrix, three choices */
162 void RE_SetCamera(struct Render *re, struct Object *camera);
163 void RE_SetWindow (struct Render *re, rctf *viewplane, float clipsta, float clipend);
164 void RE_SetOrtho (struct Render *re, rctf *viewplane, float clipsta, float clipend);
165 void RE_SetPixelSize(struct Render *re, float pixsize);
166
167 /* option to set viewmatrix before making dbase */
168 void RE_SetView (struct Render *re, float mat[][4]);
169
170 /* make or free the dbase */
171 void RE_Database_FromScene(struct Render *re, struct Scene *scene, int use_camera_view);
172 void RE_Database_Free (struct Render *re);
173
174 /* project dbase again, when viewplane/perspective changed */
175 void RE_DataBase_ApplyWindow(struct Render *re);
176
177 /* override the scene setting for amount threads, commandline */
178 void RE_set_max_threads(int threads);
179
180 /* set the render threads based on the commandline and autothreads setting */
181 void RE_init_threadcount(Render *re);
182
183 /* the main processor, assumes all was set OK! */
184 void RE_TileProcessor(struct Render *re, int firsttile, int threaded);
185
186 /* only RE_NewRender() needed, main Blender render calls */
187 void RE_BlenderFrame(struct Render *re, struct Scene *scene, int frame);
188 void RE_BlenderAnim(struct Render *re, struct Scene *scene, int sfra, int efra);
189
190 void RE_ReadRenderResult(struct Scene *scene, struct Scene *scenode);
191 void RE_WriteRenderResult(RenderResult *rr, char *filename, int compress);
192 struct RenderResult *RE_MultilayerConvert(void *exrhandle, int rectx, int recty);
193
194 /* do a full sample buffer compo */
195 void RE_MergeFullSample(struct Render *re, struct Scene *sce, struct bNodeTree *ntree);
196
197 /* ancient stars function... go away! */
198 void RE_make_stars(struct Render *re, void (*initfunc)(void),
199                                    void (*vertexfunc)(float*),  void (*termfunc)(void));
200
201 /* display and event callbacks */
202 void RE_display_init_cb (struct Render *re, void (*f)(RenderResult *rr));
203 void RE_display_clear_cb(struct Render *re, void (*f)(RenderResult *rr));
204 void RE_display_draw_cb (struct Render *re, void (*f)(RenderResult *rr, volatile struct rcti *rect));
205 void RE_stats_draw_cb   (struct Render *re, void (*f)(RenderStats *rs));
206 void RE_timecursor_cb   (struct Render *re, void (*f)(int));
207 void RE_test_break_cb   (struct Render *re, int (*f)(void));
208 void RE_test_return_cb  (struct Render *re, int (*f)(void));
209 void RE_error_cb                (struct Render *re, void (*f)(char *str));
210
211 /* should move to kernel once... still unsure on how/where */
212 float RE_filter_value(int type, float x);
213 /* vector blur zbuffer method */
214 void RE_zbuf_accumulate_vecblur(struct NodeBlurData *nbd, int xsize, int ysize, float *newrect, float *imgrect, float *vecbufrect, float *zbufrect);
215
216 /* shaded view or baking options */
217 #define RE_BAKE_LIGHT                   0
218 #define RE_BAKE_ALL                             1
219 #define RE_BAKE_AO                              2
220 #define RE_BAKE_NORMALS                 3
221 #define RE_BAKE_TEXTURE                 4
222 #define RE_BAKE_DISPLACEMENT    5
223 void RE_Database_Baking(struct Render *re, struct Scene *scene, int type, struct Object *actob);
224
225 void RE_DataBase_GetView(struct Render *re, float mat[][4]);
226 void RE_GetCameraWindow(struct Render *re, struct Object *camera, int frame, float mat[][4]);
227
228 #endif /* RE_PIPELINE_H */
229