Fix to enable copying of the vertex group field for the Curve, Lattice,
[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
41 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
42 /* this include is what is exposed of render to outside world */
43 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
44
45
46 #define RE_MAXNAME      32
47
48 /* only used as handle */
49 typedef struct Render Render;
50
51 /* Render Result usage:
52
53 - render engine allocates/frees and delivers raw floating point rects
54 - right now it's full rects, but might become tiles or file 
55 - the display client has to allocate display rects, sort out what to display, 
56   and how it's converted
57 */
58
59 typedef struct RenderPass {
60         struct RenderPass *next, *prev;
61         int passtype, channels;
62         float *rect;
63 } RenderPass;
64
65 /* a renderlayer is a full image, but with all passes and samples */
66 /* size of the rects is defined in RenderResult */
67 typedef struct RenderLayer {
68         struct RenderLayer *next, *prev;
69         
70         /* copy of RenderData */
71         char name[RE_MAXNAME];          
72         unsigned int lay;                       
73         int layflag, passflag;          
74         
75         float *rectf;           /* 4 float, standard rgba buffer */
76         float *acolrect;        /* 4 float, optional transparent buffer, needs storage for display updates */
77         
78         ListBase passes;
79         
80 } RenderLayer;
81
82 typedef struct RenderResult {
83         
84         /* target image size */
85         int rectx, recty;
86         short crop, pad;
87         
88         /* optional, 32 bits version of picture, used for ogl render and image curves */
89         int *rect32;
90         /* if this exists, a copy of one of layers, or result of composited layers */
91         float *rectf;
92         /* if this exists, a copy of one of layers, or result of composited layers */
93         float *rectz;
94         
95         /* coordinates within final image (after cropping) */
96         rcti tilerect;
97         /* offset to apply to get a border render in full image */
98         int xof, yof;
99         
100         /* the main buffers */
101         ListBase layers;
102         
103         /* allowing live updates: */
104         volatile rcti renrect;
105         volatile RenderLayer *renlay;
106         
107         /* optional saved endresult on disk */
108         char exrfile[FILE_MAXDIR];
109         void *exrhandle;
110         
111 } RenderResult;
112
113 typedef struct RenderStats {
114         int totface, totvert, tothalo, totlamp, totpart;
115         short curfield, curblur, curpart, partsdone, convertdone;
116         double starttime, lastframetime;
117         char *infostr;
118         
119 } RenderStats;
120
121 /* *********************** API ******************** */
122
123 /* the name is used as identifier, so elsewhere in blender the result can retrieved */
124 /* calling a new render with same name, frees automatic existing render */
125 struct Render *RE_NewRender (const char *name);
126 struct Render *RE_GetRender(const char *name);
127
128 /* use free render as signal to do everything over (previews) */
129 void RE_FreeRender (struct Render *re);
130 /* only called on exit */
131 void RE_FreeAllRender (void);
132
133 /* get results and statistics */
134 struct RenderResult *RE_GetResult(struct Render *re);
135 void RE_GetResultImage(struct Render *re, struct RenderResult *rr);
136 struct RenderStats *RE_GetStats(struct Render *re);
137 void RE_ResultGet32(struct Render *re, unsigned int *rect);
138 struct RenderLayer *RE_GetRenderLayer(struct RenderResult *rr, const char *name);
139 float *RE_RenderLayerGetPass(struct RenderLayer *rl, int passtype);
140
141 /* obligatory initialize call, disprect is optional */
142 void RE_InitState (struct Render *re, struct RenderData *rd, int winx, int winy, rcti *disprect);
143
144 /* use this to change disprect of active render */
145 void RE_SetDispRect (struct Render *re, rcti *disprect);
146
147 /* set up the viewplane/perspective matrix, three choices */
148 void RE_SetCamera(struct Render *re, struct Object *camera);
149 void RE_SetWindow (struct Render *re, rctf *viewplane, float clipsta, float clipend);
150 void RE_SetOrtho (struct Render *re, rctf *viewplane, float clipsta, float clipend);
151
152 /* option to set viewmatrix before making dbase */
153 void RE_SetView (struct Render *re, float mat[][4]);
154
155 /* make or free the dbase */
156 void RE_Database_FromScene(struct Render *re, struct Scene *scene, int use_camera_view);
157 void RE_Database_Free (struct Render *re);
158
159 /* project dbase again, when viewplane/perspective changed */
160 void RE_DataBase_ApplyWindow(struct Render *re);
161
162 /* the main processor, assumes all was set OK! */
163 void RE_TileProcessor(struct Render *re, int firsttile);
164
165 /* only RE_NewRender() needed, main Blender render calls */
166 void RE_BlenderFrame(struct Render *re, struct Scene *scene, int frame);
167 void RE_BlenderAnim(struct Render *re, struct Scene *scene, int sfra, int efra);
168
169 void RE_ReadRenderResult(struct Scene *scene, struct Scene *scenode);
170
171 /* ancient stars function... go away! */
172 void RE_make_stars(struct Render *re, void (*initfunc)(void),
173                                    void (*vertexfunc)(float*),  void (*termfunc)(void));
174
175 /* display and event callbacks */
176 void RE_display_init_cb (struct Render *re, void (*f)(RenderResult *rr));
177 void RE_display_clear_cb(struct Render *re, void (*f)(RenderResult *rr));
178 void RE_display_draw_cb (struct Render *re, void (*f)(RenderResult *rr, volatile struct rcti *rect));
179 void RE_stats_draw_cb   (struct Render *re, void (*f)(RenderStats *rs));
180 void RE_timecursor_cb   (struct Render *re, void (*f)(int));
181 void RE_test_break_cb   (struct Render *re, int (*f)(void));
182 void RE_test_return_cb  (struct Render *re, int (*f)(void));
183 void RE_error_cb                (struct Render *re, void (*f)(char *str));
184
185 /* should move to kernel once... still unsure on how/where */
186 float RE_filter_value(int type, float x);
187 /* vector blur zbuffer method */
188 void RE_zbuf_accumulate_vecblur(struct NodeBlurData *nbd, int xsize, int ysize, float *newrect, float *imgrect, float *vecbufrect, float *zbufrect);
189
190 /* shaded view options */
191 void RE_Database_Shaded(struct Render *re, struct Scene *scene);
192 void RE_DataBase_GetView(struct Render *re, float mat[][4]);
193
194 #endif /* RE_PIPELINE_H */
195