Render: new material preview
[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_SHADING_NODES_CUSTOM     256
62 #define RE_USE_SPHERICAL_STEREO 512
63
64 /* RenderEngine.flag */
65 #define RE_ENGINE_ANIMATION             1
66 #define RE_ENGINE_PREVIEW               2
67 #define RE_ENGINE_DO_DRAW               4
68 #define RE_ENGINE_DO_UPDATE             8
69 #define RE_ENGINE_RENDERING             16
70 #define RE_ENGINE_HIGHLIGHT_TILES       32
71 #define RE_ENGINE_USED_FOR_VIEWPORT     64
72
73 extern ListBase R_engines;
74
75 typedef struct RenderEngineType {
76         struct RenderEngineType *next, *prev;
77
78         /* type info */
79         char idname[64]; // best keep the same size as BKE_ST_MAXNAME
80         char name[64];
81         int flag;
82
83         void (*update)(struct RenderEngine *engine, struct Main *bmain, struct Depsgraph *depsgraph);
84         void (*render)(struct RenderEngine *engine, struct Depsgraph *depsgraph);
85         void (*bake)(struct RenderEngine *engine, struct Depsgraph *depsgraph,
86                      struct Object *object, const int pass_type,
87                      const int pass_filter, const int object_id, const struct BakePixel *pixel_array, const int num_pixels,
88                      const int depth, void *result);
89
90         void (*view_update)(struct RenderEngine *engine, const struct bContext *context);
91         void (*view_draw)(struct RenderEngine *engine, const struct bContext *context);
92
93         void (*update_script_node)(struct RenderEngine *engine, struct bNodeTree *ntree, struct bNode *node);
94         void (*update_render_passes)(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer);
95
96         struct DrawEngineType *draw_engine;
97
98         /* RNA integration */
99         ExtensionRNA ext;
100 } RenderEngineType;
101
102 typedef void (*update_render_passes_cb_t)(void *userdata, struct Scene *scene, struct ViewLayer *view_layer,
103                                           const char *name, int channels, const char *chanid, int type);
104
105 typedef struct RenderEngine {
106         RenderEngineType *type;
107         void *py_instance;
108
109         int flag;
110         struct Object *camera_override;
111         unsigned int layer_override;
112
113         int tile_x;
114         int tile_y;
115
116         struct Render *re;
117         ListBase fullresult;
118         char text[512]; /* IMA_MAX_RENDER_TEXT */
119
120         int resolution_x, resolution_y;
121
122         struct ReportList *reports;
123
124         /* Depsgraph */
125         struct Depsgraph *depsgraph;
126
127         /* callback for render pass query */
128         ThreadMutex update_render_passes_mutex;
129         update_render_passes_cb_t update_render_passes_cb;
130         void *update_render_passes_data;
131
132         rctf last_viewplane;
133         rcti last_disprect;
134         float last_viewmat[4][4];
135         int last_winx, last_winy;
136 } RenderEngine;
137
138 RenderEngine *RE_engine_create(RenderEngineType *type);
139 RenderEngine *RE_engine_create_ex(RenderEngineType *type, bool use_for_viewport);
140 void RE_engine_free(RenderEngine *engine);
141
142 void RE_layer_load_from_file(struct RenderLayer *layer, struct ReportList *reports, const char *filename, int x, int y);
143 void RE_result_load_from_file(struct RenderResult *result, struct ReportList *reports, const char *filename);
144
145 struct RenderResult *RE_engine_begin_result(RenderEngine *engine, int x, int y, int w, int h, const char *layername, const char *viewname);
146 void RE_engine_update_result(RenderEngine *engine, struct RenderResult *result);
147 void RE_engine_add_pass(RenderEngine *engine, const char *name, int channels, const char *chan_id, const char *layername);
148 void RE_engine_end_result(RenderEngine *engine, struct RenderResult *result, bool cancel, bool highlight, bool merge_results);
149 struct RenderResult *RE_engine_get_result(struct RenderEngine *engine);
150
151 const char *RE_engine_active_view_get(RenderEngine *engine);
152 void RE_engine_active_view_set(RenderEngine *engine, const char *viewname);
153 float RE_engine_get_camera_shift_x(RenderEngine *engine, struct Object *camera, bool use_spherical_stereo);
154 void RE_engine_get_camera_model_matrix(RenderEngine *engine, struct Object *camera, bool use_spherical_stereo, float *r_modelmat);
155 bool RE_engine_get_spherical_stereo(RenderEngine *engine, struct Object *camera);
156
157 bool RE_engine_test_break(RenderEngine *engine);
158 void RE_engine_update_stats(RenderEngine *engine, const char *stats, const char *info);
159 void RE_engine_update_progress(RenderEngine *engine, float progress);
160 void RE_engine_update_memory_stats(RenderEngine *engine, float mem_used, float mem_peak);
161 void RE_engine_report(RenderEngine *engine, int type, const char *msg);
162 void RE_engine_set_error_message(RenderEngine *engine, const char *msg);
163
164 int RE_engine_render(struct Render *re, int do_all);
165
166 bool RE_engine_is_external(struct Render *re);
167
168 void RE_engine_frame_set(struct RenderEngine *engine, int frame, float subframe);
169
170 void RE_engine_update_render_passes(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer,
171                                     update_render_passes_cb_t callback, void *callback_data);
172 void RE_engine_register_pass(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer,
173                              const char *name, int channels, const char *chanid, int type);
174
175 /* Engine Types */
176
177 void RE_engines_init(void);
178 void RE_engines_exit(void);
179 void RE_engines_register(RenderEngineType *render_type);
180
181 bool RE_engine_is_opengl(RenderEngineType *render_type);
182
183 RenderEngineType *RE_engines_find(const char *idname);
184
185 rcti *RE_engine_get_current_tiles(struct Render *re, int *r_total_tiles, bool *r_needs_free);
186 struct RenderData *RE_engine_get_render_data(struct Render *re);
187 void RE_bake_engine_set_engine_parameters(
188         struct Render *re, struct Main *bmain, struct Scene *scene);
189
190 void RE_engine_free_blender_memory(struct RenderEngine *engine);
191
192 #endif /* __RE_ENGINE_H__ */