Fix warning from rB9925606539.
[blender.git] / source / blender / render / 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 #pragma once
25
26 #include "DNA_listBase.h"
27 #include "DNA_node_types.h"
28 #include "DNA_scene_types.h"
29 #include "RE_bake.h"
30 #include "RNA_types.h"
31
32 #include "BLI_threads.h"
33
34 struct BakePixel;
35 struct Depsgraph;
36 struct Main;
37 struct Object;
38 struct Render;
39 struct RenderData;
40 struct RenderEngine;
41 struct RenderEngineType;
42 struct RenderLayer;
43 struct RenderPass;
44 struct RenderResult;
45 struct ReportList;
46 struct Scene;
47 struct ViewLayer;
48 struct bNode;
49 struct bNodeTree;
50
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54
55 /* External Engine */
56
57 /* RenderEngineType.flag */
58 #define RE_INTERNAL 1
59 /* #define RE_FLAG_DEPRECATED   2 */
60 #define RE_USE_PREVIEW 4
61 #define RE_USE_POSTPROCESS 8
62 #define RE_USE_EEVEE_VIEWPORT 16
63 /* #define RE_USE_SAVE_BUFFERS_DEPRECATED 32 */
64 #define RE_USE_SHADING_NODES_CUSTOM 64
65 #define RE_USE_SPHERICAL_STEREO 128
66 #define RE_USE_STEREO_VIEWPORT 256
67 #define RE_USE_GPU_CONTEXT 512
68 #define RE_USE_CUSTOM_FREESTYLE 1024
69 #define RE_USE_NO_IMAGE_SAVE 2048
70 #define RE_USE_ALEMBIC_PROCEDURAL 4096
71
72 /* RenderEngine.flag */
73 #define RE_ENGINE_ANIMATION 1
74 #define RE_ENGINE_PREVIEW 2
75 #define RE_ENGINE_DO_DRAW 4
76 #define RE_ENGINE_DO_UPDATE 8
77 #define RE_ENGINE_RENDERING 16
78 #define RE_ENGINE_HIGHLIGHT_TILES 32
79 #define RE_ENGINE_CAN_DRAW 64
80
81 extern ListBase R_engines;
82
83 typedef struct RenderEngineType {
84   struct RenderEngineType *next, *prev;
85
86   /* type info */
87   char idname[64]; /* best keep the same size as BKE_ST_MAXNAME. */
88   char name[64];
89   int flag;
90
91   void (*update)(struct RenderEngine *engine, struct Main *bmain, struct Depsgraph *depsgraph);
92
93   void (*render)(struct RenderEngine *engine, struct Depsgraph *depsgraph);
94
95   /* Offline rendering is finished - no more view layers will be rendered.
96    *
97    * All the pending data is to be communicated from the engine back to Blender. In a possibly
98    * most memory-efficient manner (engine might free its database before making Blender to allocate
99    * full-frame render result). */
100   void (*render_frame_finish)(struct RenderEngine *engine);
101
102   void (*draw)(struct RenderEngine *engine,
103                const struct bContext *context,
104                struct Depsgraph *depsgraph);
105
106   void (*bake)(struct RenderEngine *engine,
107                struct Depsgraph *depsgraph,
108                struct Object *object,
109                int pass_type,
110                int pass_filter,
111                int width,
112                int height);
113
114   void (*view_update)(struct RenderEngine *engine,
115                       const struct bContext *context,
116                       struct Depsgraph *depsgraph);
117   void (*view_draw)(struct RenderEngine *engine,
118                     const struct bContext *context,
119                     struct Depsgraph *depsgraph);
120
121   void (*update_script_node)(struct RenderEngine *engine,
122                              struct bNodeTree *ntree,
123                              struct bNode *node);
124   void (*update_render_passes)(struct RenderEngine *engine,
125                                struct Scene *scene,
126                                struct ViewLayer *view_layer);
127
128   struct DrawEngineType *draw_engine;
129
130   /* RNA integration */
131   ExtensionRNA rna_ext;
132 } RenderEngineType;
133
134 typedef void (*update_render_passes_cb_t)(void *userdata,
135                                           struct Scene *scene,
136                                           struct ViewLayer *view_layer,
137                                           const char *name,
138                                           int channels,
139                                           const char *chanid,
140                                           eNodeSocketDatatype type);
141
142 typedef struct RenderEngine {
143   RenderEngineType *type;
144   void *py_instance;
145
146   int flag;
147   struct Object *camera_override;
148   unsigned int layer_override;
149
150   struct Render *re;
151   ListBase fullresult;
152   char text[512]; /* IMA_MAX_RENDER_TEXT */
153
154   int resolution_x, resolution_y;
155
156   struct ReportList *reports;
157
158   struct {
159     const struct BakePixel *pixels;
160     float *result;
161     int width, height, depth;
162     int object_id;
163   } bake;
164
165   /* Depsgraph */
166   struct Depsgraph *depsgraph;
167   bool has_grease_pencil;
168
169   /* callback for render pass query */
170   ThreadMutex update_render_passes_mutex;
171   update_render_passes_cb_t update_render_passes_cb;
172   void *update_render_passes_data;
173
174   rctf last_viewplane;
175   rcti last_disprect;
176   float last_viewmat[4][4];
177   int last_winx, last_winy;
178 } RenderEngine;
179
180 RenderEngine *RE_engine_create(RenderEngineType *type);
181 void RE_engine_free(RenderEngine *engine);
182
183 /**
184  * Loads in image into a result, size must match
185  * x/y offsets are only used on a partial copy when dimensions don't match.
186  */
187 void RE_layer_load_from_file(
188     struct RenderLayer *layer, struct ReportList *reports, const char *filename, int x, int y);
189 void RE_result_load_from_file(struct RenderResult *result,
190                               struct ReportList *reports,
191                               const char *filename);
192
193 struct RenderResult *RE_engine_begin_result(
194     RenderEngine *engine, int x, int y, int w, int h, const char *layername, const char *viewname);
195 void RE_engine_update_result(RenderEngine *engine, struct RenderResult *result);
196 void RE_engine_add_pass(RenderEngine *engine,
197                         const char *name,
198                         int channels,
199                         const char *chan_id,
200                         const char *layername);
201 void RE_engine_end_result(RenderEngine *engine,
202                           struct RenderResult *result,
203                           bool cancel,
204                           bool highlight,
205                           bool merge_results);
206 struct RenderResult *RE_engine_get_result(struct RenderEngine *engine);
207
208 struct RenderPass *RE_engine_pass_by_index_get(struct RenderEngine *engine,
209                                                const char *layer_name,
210                                                int index);
211
212 const char *RE_engine_active_view_get(RenderEngine *engine);
213 void RE_engine_active_view_set(RenderEngine *engine, const char *viewname);
214 float RE_engine_get_camera_shift_x(RenderEngine *engine,
215                                    struct Object *camera,
216                                    bool use_spherical_stereo);
217 void RE_engine_get_camera_model_matrix(RenderEngine *engine,
218                                        struct Object *camera,
219                                        bool use_spherical_stereo,
220                                        float r_modelmat[16]);
221 bool RE_engine_get_spherical_stereo(RenderEngine *engine, struct Object *camera);
222
223 bool RE_engine_test_break(RenderEngine *engine);
224 void RE_engine_update_stats(RenderEngine *engine, const char *stats, const char *info);
225 void RE_engine_update_progress(RenderEngine *engine, float progress);
226 void RE_engine_update_memory_stats(RenderEngine *engine, float mem_used, float mem_peak);
227 void RE_engine_report(RenderEngine *engine, int type, const char *msg);
228 void RE_engine_set_error_message(RenderEngine *engine, const char *msg);
229
230 bool RE_engine_render(struct Render *re, bool do_all);
231
232 bool RE_engine_is_external(const struct Render *re);
233
234 void RE_engine_frame_set(struct RenderEngine *engine, int frame, float subframe);
235
236 void RE_engine_update_render_passes(struct RenderEngine *engine,
237                                     struct Scene *scene,
238                                     struct ViewLayer *view_layer,
239                                     update_render_passes_cb_t callback,
240                                     void *callback_data);
241 void RE_engine_register_pass(struct RenderEngine *engine,
242                              struct Scene *scene,
243                              struct ViewLayer *view_layer,
244                              const char *name,
245                              int channels,
246                              const char *chanid,
247                              eNodeSocketDatatype type);
248
249 bool RE_engine_use_persistent_data(struct RenderEngine *engine);
250
251 struct RenderEngine *RE_engine_get(const struct Render *re);
252
253 /* Acquire render engine for drawing via its `draw()` callback.
254  *
255  * If drawing is not possible false is returned. If drawing is possible then the engine is
256  * "acquired" so that it can not be freed by the render pipeline.
257  *
258  * Drawing is possible if the engine has the `draw()` callback and it is in its `render()`
259  * callback. */
260 bool RE_engine_draw_acquire(struct Render *re);
261 void RE_engine_draw_release(struct Render *re);
262
263 /* NOTE: Only used for Cycles's BLenderGPUDisplay integration with the draw manager. A subject
264  * for re-consideration. Do not use this functionality. */
265 bool RE_engine_has_render_context(struct RenderEngine *engine);
266 void RE_engine_render_context_enable(struct RenderEngine *engine);
267 void RE_engine_render_context_disable(struct RenderEngine *engine);
268
269 /* Engine Types */
270
271 void RE_engines_init(void);
272 void RE_engines_exit(void);
273 void RE_engines_register(RenderEngineType *render_type);
274
275 bool RE_engine_is_opengl(RenderEngineType *render_type);
276
277 /**
278  * Return true if the RenderEngineType has native support for direct loading of Alembic data. For
279  * Cycles, this also checks that the experimental feature set is enabled.
280  */
281 bool RE_engine_supports_alembic_procedural(const RenderEngineType *render_type, Scene *scene);
282
283 RenderEngineType *RE_engines_find(const char *idname);
284
285 rcti *RE_engine_get_current_tiles(struct Render *re, int *r_total_tiles, bool *r_needs_free);
286 struct RenderData *RE_engine_get_render_data(struct Render *re);
287 void RE_bake_engine_set_engine_parameters(struct Render *re,
288                                           struct Main *bmain,
289                                           struct Scene *scene);
290
291 void RE_engine_free_blender_memory(struct RenderEngine *engine);
292
293 void RE_engine_tile_highlight_set(
294     struct RenderEngine *engine, int x, int y, int width, int height, bool highlight);
295 void RE_engine_tile_highlight_clear_all(struct RenderEngine *engine);
296
297 #ifdef __cplusplus
298 }
299 #endif