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