Merge branch 'blender2.7'
[blender.git] / source / blender / render / extern / include / RE_engine.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2006 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file RE_engine.h
29  *  \ingroup render
30  */
31
32 #ifndef __RE_ENGINE_H__
33 #define __RE_ENGINE_H__
34
35 #include "DNA_listBase.h"
36 #include "DNA_scene_types.h"
37 #include "RNA_types.h"
38 #include "RE_bake.h"
39
40 #include "BLI_threads.h"
41
42 struct bNode;
43 struct bNodeTree;
44 struct BakePixel;
45 struct Depsgraph;
46 struct IDProperty;
47 struct Main;
48 struct Object;
49 struct Render;
50 struct RenderData;
51 struct RenderEngine;
52 struct RenderEngineType;
53 struct RenderLayer;
54 struct RenderResult;
55 struct ReportList;
56 struct Scene;
57 struct ViewLayer;
58
59 /* External Engine */
60
61 /* RenderEngineType.flag */
62 #define RE_INTERNAL                             1
63 /* #define RE_FLAG_DEPRECATED   2 */
64 #define RE_USE_PREVIEW                  4
65 #define RE_USE_POSTPROCESS              8
66 #define RE_USE_SHADING_NODES    16
67 #define RE_USE_EXCLUDE_LAYERS   32
68 #define RE_USE_SAVE_BUFFERS             64
69 #define RE_USE_TEXTURE_PREVIEW          128
70 #define RE_USE_SHADING_NODES_CUSTOM     256
71 #define RE_USE_SPHERICAL_STEREO 512
72
73 /* RenderEngine.flag */
74 #define RE_ENGINE_ANIMATION             1
75 #define RE_ENGINE_PREVIEW               2
76 #define RE_ENGINE_DO_DRAW               4
77 #define RE_ENGINE_DO_UPDATE             8
78 #define RE_ENGINE_RENDERING             16
79 #define RE_ENGINE_HIGHLIGHT_TILES       32
80 #define RE_ENGINE_USED_FOR_VIEWPORT     64
81
82 /* RenderEngine.update_flag, used by internal now */
83 #define RE_ENGINE_UPDATE_MA                     1
84 #define RE_ENGINE_UPDATE_OTHER          2
85 #define RE_ENGINE_UPDATE_DATABASE       4
86
87 extern ListBase R_engines;
88
89 typedef struct RenderEngineType {
90         struct RenderEngineType *next, *prev;
91
92         /* type info */
93         char idname[64]; // best keep the same size as BKE_ST_MAXNAME
94         char name[64];
95         int flag;
96
97         void (*update)(struct RenderEngine *engine, struct Main *bmain, struct Depsgraph *depsgraph);
98         void (*render)(struct RenderEngine *engine, struct Depsgraph *depsgraph);
99         void (*bake)(struct RenderEngine *engine, struct Depsgraph *depsgraph,
100                      struct Object *object, const int pass_type,
101                      const int pass_filter, const int object_id, const struct BakePixel *pixel_array, const int num_pixels,
102                      const int depth, void *result);
103
104         void (*view_update)(struct RenderEngine *engine, const struct bContext *context);
105         void (*view_draw)(struct RenderEngine *engine, const struct bContext *context);
106
107         void (*update_script_node)(struct RenderEngine *engine, struct bNodeTree *ntree, struct bNode *node);
108         void (*update_render_passes)(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer);
109
110         struct DrawEngineType *draw_engine;
111
112         /* RNA integration */
113         ExtensionRNA ext;
114 } RenderEngineType;
115
116 typedef void (*update_render_passes_cb_t)(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer,
117                                           const char *name, int channels, const char *chanid, int type);
118
119 typedef struct RenderEngine {
120         RenderEngineType *type;
121         void *py_instance;
122
123         int flag;
124         struct Object *camera_override;
125         unsigned int layer_override;
126
127         int tile_x;
128         int tile_y;
129
130         struct Render *re;
131         ListBase fullresult;
132         char text[512]; /* IMA_MAX_RENDER_TEXT */
133
134         int resolution_x, resolution_y;
135
136         struct ReportList *reports;
137
138         /* Depsgraph */
139         struct Depsgraph *depsgraph;
140
141         /* for blender internal only */
142         int update_flag;
143         int job_update_flag;
144
145         /* callback for render pass query */
146         ThreadMutex update_render_passes_mutex;
147         update_render_passes_cb_t update_render_passes_cb;
148
149         rctf last_viewplane;
150         rcti last_disprect;
151         float last_viewmat[4][4];
152         int last_winx, last_winy;
153 } RenderEngine;
154
155 RenderEngine *RE_engine_create(RenderEngineType *type);
156 RenderEngine *RE_engine_create_ex(RenderEngineType *type, bool use_for_viewport);
157 void RE_engine_free(RenderEngine *engine);
158
159 void RE_layer_load_from_file(struct RenderLayer *layer, struct ReportList *reports, const char *filename, int x, int y);
160 void RE_result_load_from_file(struct RenderResult *result, struct ReportList *reports, const char *filename);
161
162 struct RenderResult *RE_engine_begin_result(RenderEngine *engine, int x, int y, int w, int h, const char *layername, const char *viewname);
163 void RE_engine_update_result(RenderEngine *engine, struct RenderResult *result);
164 void RE_engine_add_pass(RenderEngine *engine, const char *name, int channels, const char *chan_id, const char *layername);
165 void RE_engine_end_result(RenderEngine *engine, struct RenderResult *result, bool cancel, bool highlight, bool merge_results);
166 struct RenderResult *RE_engine_get_result(struct RenderEngine *engine);
167
168 const char *RE_engine_active_view_get(RenderEngine *engine);
169 void RE_engine_active_view_set(RenderEngine *engine, const char *viewname);
170 float RE_engine_get_camera_shift_x(RenderEngine *engine, struct Object *camera, bool use_spherical_stereo);
171 void RE_engine_get_camera_model_matrix(RenderEngine *engine, struct Object *camera, bool use_spherical_stereo, float *r_modelmat);
172 bool RE_engine_get_spherical_stereo(RenderEngine *engine, struct Object *camera);
173
174 bool RE_engine_test_break(RenderEngine *engine);
175 void RE_engine_update_stats(RenderEngine *engine, const char *stats, const char *info);
176 void RE_engine_update_progress(RenderEngine *engine, float progress);
177 void RE_engine_update_memory_stats(RenderEngine *engine, float mem_used, float mem_peak);
178 void RE_engine_report(RenderEngine *engine, int type, const char *msg);
179 void RE_engine_set_error_message(RenderEngine *engine, const char *msg);
180
181 int RE_engine_render(struct Render *re, int do_all);
182
183 bool RE_engine_is_external(struct Render *re);
184
185 void RE_engine_frame_set(struct RenderEngine *engine, int frame, float subframe);
186
187 void RE_engine_update_render_passes(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer,
188                                     update_render_passes_cb_t callback);
189 void RE_engine_register_pass(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer,
190                              const char *name, int channels, const char *chanid, int type);
191
192 /* Engine Types */
193
194 void RE_engines_init(void);
195 void RE_engines_exit(void);
196 void RE_engines_register(RenderEngineType *render_type);
197
198 bool RE_engine_is_opengl(RenderEngineType *render_type);
199
200 RenderEngineType *RE_engines_find(const char *idname);
201
202 rcti* RE_engine_get_current_tiles(struct Render *re, int *r_total_tiles, bool *r_needs_free);
203 struct RenderData *RE_engine_get_render_data(struct Render *re);
204 void RE_bake_engine_set_engine_parameters(
205         struct Render *re, struct Main *bmain, struct Scene *scene);
206
207 void RE_engine_free_blender_memory(struct RenderEngine *engine);
208
209 #endif /* __RE_ENGINE_H__ */