Carefully went over all scanline updating while rendering, to ensure only
[blender-staging.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;
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         
77         ListBase passes;
78         
79 } RenderLayer;
80
81 typedef struct RenderResult {
82         
83         /* target image size */
84         int rectx, recty;
85         short crop, pad;
86         
87         /* optional, 32 bits version of picture, used for ogl render and image curves */
88         int *rect32;
89         /* if this exists, a copy of one of layers, or result of composited layers */
90         float *rectf;
91         /* if this exists, a copy of one of layers, or result of composited layers */
92         float *rectz;
93         
94         /* coordinates within final image (after cropping) */
95         rcti tilerect;
96         
97         /* the main buffers */
98         ListBase layers;
99         
100         /* allowing live updates: */
101         rcti renrect;
102         RenderLayer *renlay;
103         
104         /* optional saved endresult on disk */
105         char exrfile[FILE_MAXDIR];
106         void *exrhandle;
107         
108 } RenderResult;
109
110 typedef struct RenderStats {
111         int totface, totvert, tothalo, totlamp, totpart;
112         short curfield, curblur, curpart, partsdone, convertdone;
113         double starttime, lastframetime;
114         char *infostr;
115         
116 } RenderStats;
117
118 /* *********************** API ******************** */
119
120 /* the name is used as identifier, so elsewhere in blender the result can retrieved */
121 /* calling a new render with same name, frees automatic existing render */
122 struct Render *RE_NewRender (const char *name);
123 struct Render *RE_GetRender(const char *name);
124
125 /* use free render as signal to do everything over (previews) */
126 void RE_FreeRender (struct Render *re);
127 /* only called on exit */
128 void RE_FreeAllRender (void);
129
130 /* get results and statistics */
131 RenderResult *RE_GetResult(struct Render *re);
132 void RE_GetResultImage(struct Render *re, RenderResult *rr);
133 RenderStats *RE_GetStats(struct Render *re);
134 void RE_ResultGet32(struct Render *re, unsigned int *rect);
135 float *RE_RenderLayerGetPass(RenderLayer *rl, int passtype);
136
137 /* obligatory initialize call, disprect is optional */
138 void RE_InitState (struct Render *re, struct RenderData *rd, int winx, int winy, rcti *disprect);
139
140 /* use this to change disprect of active render */
141 void RE_SetDispRect (struct Render *re, rcti *disprect);
142
143 /* set up the viewplane/perspective matrix, three choices */
144 void RE_SetCamera(struct Render *re, struct Object *camera);
145 void RE_SetWindow (struct Render *re, rctf *viewplane, float clipsta, float clipend);
146 void RE_SetOrtho (struct Render *re, rctf *viewplane, float clipsta, float clipend);
147
148 /* option to set viewmatrix before making dbase */
149 void RE_SetView (struct Render *re, float mat[][4]);
150
151 /* make or free the dbase */
152 void RE_Database_FromScene(struct Render *re, struct Scene *scene, int use_camera_view);
153 void RE_Database_Free (struct Render *re);
154
155 /* project dbase again, when viewplane/perspective changed */
156 void RE_DataBase_ApplyWindow(struct Render *re);
157
158 /* the main processor, assumes all was set OK! */
159 void RE_TileProcessor(struct Render *re, int firsttile);
160
161 /* only RE_NewRender() needed, main Blender render calls */
162 void RE_BlenderFrame(struct Render *re, struct Scene *scene, int frame);
163 void RE_BlenderAnim(struct Render *re, struct Scene *scene, int sfra, int efra);
164
165
166 /* display and event callbacks */
167 void RE_display_init_cb (struct Render *re, void (*f)(RenderResult *rr));
168 void RE_display_clear_cb(struct Render *re, void (*f)(RenderResult *rr));
169 void RE_display_draw_cb (struct Render *re, void (*f)(RenderResult *rr, struct rcti *rect));
170 void RE_stats_draw_cb   (struct Render *re, void (*f)(RenderStats *rs));
171 void RE_timecursor_cb   (struct Render *re, void (*f)(int));
172 void RE_test_break_cb   (struct Render *re, int (*f)(void));
173 void RE_test_return_cb  (struct Render *re, int (*f)(void));
174 void RE_error_cb                (struct Render *re, void (*f)(const char *str));
175
176 /* should move to kernel once... still unsure on how/where */
177 float RE_filter_value(int type, float x);
178 /* vector blur zbuffer method */
179 void RE_zbuf_accumulate_vecblur(struct NodeBlurData *nbd, int xsize, int ysize, float *newrect, float *imgrect, float *vecbufrect, float *zbufrect);
180
181 #endif /* RE_PIPELINE_H */
182