Blender V5.3
RE_engine.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2006 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "DNA_listBase.h"
12#include "DNA_node_types.h"
13#include "DNA_scene_types.h"
14#include "RE_bake.h"
15#include "RNA_types.hh"
16
17#include "BLI_threads.hh"
18
19namespace blender {
20
21struct BakePixel;
22struct BakeTargets;
23struct bNode;
24struct bNodeTree;
25struct Depsgraph;
26struct GPUContext;
27struct Main;
28struct Object;
29struct Render;
30struct RenderData;
31struct RenderEngine;
32struct RenderEngineType;
33struct RenderLayer;
34struct RenderPass;
35struct RenderResult;
36struct ReportList;
37struct Scene;
38struct ViewLayer;
39struct ViewRender;
40
41/* External Engine */
42
60
77
78extern ListBaseT<RenderEngineType> R_engines;
79
82
83 /* Type info. */
84 char idname[/*BKE_ST_MAXNAME*/ 64];
85 char name[64];
86 int flag;
87
88 void (*update)(struct RenderEngine *engine, struct Main *bmain, struct Depsgraph *depsgraph);
89
90 void (*render)(struct RenderEngine *engine, struct Depsgraph *depsgraph);
91
92 /* Offline rendering is finished - no more view layers will be rendered.
93 *
94 * All the pending data is to be communicated from the engine back to Blender. In a possibly
95 * most memory-efficient manner (engine might free its database before making Blender to allocate
96 * full-frame render result). */
97 void (*render_frame_finish)(struct RenderEngine *engine);
98
99 void (*draw)(struct RenderEngine *engine,
100 const struct bContext *context,
101 struct Depsgraph *depsgraph);
102
103 void (*bake)(struct RenderEngine *engine,
104 struct Depsgraph *depsgraph,
105 struct Object *object,
106 int pass_type,
107 int pass_filter,
108 int width,
109 int height);
110
111 void (*view_update)(struct RenderEngine *engine,
112 const struct bContext *context,
113 struct Depsgraph *depsgraph);
114 void (*view_draw)(struct RenderEngine *engine,
115 const struct bContext *context,
116 struct Depsgraph *depsgraph);
117 void (*view_pause)(struct RenderEngine *engine, const struct bContext *context);
118 void (*view_resume)(struct RenderEngine *engine, const struct bContext *context);
119
120 void (*update_script_node)(struct RenderEngine *engine,
121 struct bNodeTree *ntree,
122 struct bNode *node);
123 void (*update_render_passes)(struct RenderEngine *engine,
124 struct Scene *scene,
125 struct ViewLayer *view_layer);
126 void (*update_custom_camera)(struct RenderEngine *engine, struct Camera *cam);
127
128 /* RNA integration */
130};
131
132using update_render_passes_cb_t = void (*)(void *userdata,
133 struct Scene *scene,
134 struct ViewLayer *view_layer,
135 const char *name,
136 int channels,
137 const char *chanid,
139
143
144 int flag;
146 unsigned int layer_override;
147
148 struct Render *re;
149 ListBaseT<RenderResult> fullresult;
150 char text[/*IMA_MAX_RENDER_TEXT_SIZE*/ 512];
151
153
155
156 struct {
157 const struct BakeTargets *targets;
158 const struct BakePixel *pixels;
159 float *result;
160 int image_id;
161 int object_id;
163
164 /* Depsgraph */
165 struct Depsgraph *depsgraph;
167
168 /* callback for render pass query */
172
173 /* GPU context. */
174 GHOST_IContext *system_gpu_context; /* WindowManager GPU context -> GHOSTContext. */
177 struct GPUContext *blender_gpu_context;
178 /* Whether to restore DRWState after RenderEngine display pass. */
180};
181
183void RE_engine_free(RenderEngine *engine);
184
190 struct RenderLayer *layer, struct ReportList *reports, const char *filepath, int x, int y);
192 struct ReportList *reports,
193 const char *filepath);
194
196 RenderEngine *engine, int x, int y, int w, int h, const char *layername, const char *viewname);
199 const char *name,
200 int channels,
201 const char *chan_id,
202 const char *layername);
204 struct RenderResult *result,
205 bool cancel,
206 bool highlight,
207 bool merge_results);
208struct RenderResult *RE_engine_get_result(struct RenderEngine *engine);
209
211 const char *layer_name,
212 int index);
213
214const char *RE_engine_active_view_get(RenderEngine *engine);
215void RE_engine_active_view_set(RenderEngine *engine, const char *viewname);
217 struct Object *camera,
218 bool use_spherical_stereo);
220 struct Object *camera,
221 bool use_spherical_stereo,
222 float r_modelmat[16]);
224
226void RE_engine_update_stats(RenderEngine *engine, const char *stats, const char *info);
227void RE_engine_update_progress(RenderEngine *engine, float progress);
228void RE_engine_update_memory_stats(RenderEngine *engine, float mem_used, float mem_peak);
229void RE_engine_report(RenderEngine *engine, int type, const char *msg);
230void RE_engine_set_error_message(RenderEngine *engine, const char *msg);
231
232bool RE_engine_render(struct Render *re, bool do_all);
233
234bool RE_engine_is_external(const struct Render *re);
235
236void RE_engine_frame_set(struct RenderEngine *engine, int frame, float subframe);
237
239 struct Scene *scene,
240 struct ViewLayer *view_layer,
242 void *callback_data);
243void RE_engine_register_pass(struct RenderEngine *engine,
244 struct Scene *scene,
245 struct ViewLayer *view_layer,
246 const char *name,
247 int channels,
248 const char *chanid,
250
252
253struct RenderEngine *RE_engine_get(const struct Render *re);
254struct RenderEngine *RE_view_engine_get(const struct ViewRender *view_render);
255
265bool RE_engine_draw_acquire(struct Render *re);
266void RE_engine_draw_release(struct Render *re);
267
273bool RE_engine_gpu_context_create(struct RenderEngine *engine);
275
276bool RE_engine_gpu_context_enable(struct RenderEngine *engine);
278
279void RE_engine_gpu_context_lock(struct RenderEngine *engine);
280void RE_engine_gpu_context_unlock(struct RenderEngine *engine);
281
282void RE_engine_view_pause_set(struct RenderEngine *engine, bool pause);
283bool RE_engine_view_pause_get(const struct RenderEngine *engine);
284void RE_engine_view_auto_pause_set(struct RenderEngine *engine, bool pause);
285bool RE_engine_view_pause_notify(struct RenderEngine *engine, const struct bContext *context);
286
287/* Engine Types */
288
289void RE_engines_init();
290void RE_engines_exit();
291void RE_engines_register(RenderEngineType *render_type);
292
293RenderEngineType *RE_engines_find(const char *idname);
294bool RE_engines_is_registered(const char *idname);
295
296const rcti *RE_engine_get_current_tiles(struct Render *re, int *r_total_tiles);
299 struct Main *bmain,
300 struct Scene *scene);
301
303
305 struct RenderEngine *engine, int x, int y, int width, int height, bool highlight);
307
308} // namespace blender
These structs are the foundation for all linked lists in the library system.
SIMD_FORCE_INLINE const btScalar & w() const
Return the w value.
Definition btQuadWord.h:119
#define layer
void camera(KernelGlobals &kg, const ShadingData &sd, float3 &outview, float &outdepth, float &outdist)
BMesh Iterators.
void RE_engine_view_pause_set(RenderEngine *engine, const bool pause)
void RE_engine_update_stats(RenderEngine *engine, const char *stats, const char *info)
void RE_engine_tile_highlight_set(RenderEngine *engine, int x, int y, int width, int height, bool highlight)
RenderEngine * RE_engine_get(const Render *re)
bool RE_engine_gpu_context_create(RenderEngine *engine)
void RE_engine_view_auto_pause_set(RenderEngine *engine, const bool pause)
void RE_engine_gpu_context_unlock(RenderEngine *engine)
bool RE_engines_is_registered(const char *idname)
void RE_engine_update_result(RenderEngine *engine, RenderResult *result)
void RE_engine_report(RenderEngine *engine, int type, const char *msg)
bool RE_engine_use_persistent_data(RenderEngine *engine)
void RE_engine_gpu_context_disable(RenderEngine *engine)
bool RE_engine_gpu_context_enable(RenderEngine *engine)
RenderEngineTypeFlag
Definition RE_engine.h:44
@ RE_USE_SPHERICAL_STEREO
Definition RE_engine.h:50
@ RE_USE_GPU_CONTEXT
Definition RE_engine.h:52
@ RE_WRITE_VIEWPORT_DEPTH
Definition RE_engine.h:58
@ RE_INTERNAL
Definition RE_engine.h:45
@ RE_USE_MATERIALX
Definition RE_engine.h:55
@ RE_USE_CUSTOM_FREESTYLE
Definition RE_engine.h:53
@ RE_USE_EEVEE_VIEWPORT
Definition RE_engine.h:48
@ RE_USE_POSTPROCESS
Definition RE_engine.h:47
@ RE_USE_SHADING_NODES_CUSTOM
Definition RE_engine.h:49
@ RE_USE_PREVIEW
Definition RE_engine.h:46
@ RE_USE_STEREO_VIEWPORT
Definition RE_engine.h:51
@ RE_USE_NO_IMAGE_SAVE
Definition RE_engine.h:54
void RE_engine_update_render_passes(RenderEngine *engine, Scene *scene, ViewLayer *view_layer, update_render_passes_cb_t callback, void *callback_data)
float RE_engine_get_camera_shift_x(RenderEngine *engine, Object *camera, bool use_spherical_stereo)
void RE_engines_exit()
RenderResult * RE_engine_get_result(RenderEngine *engine)
bool RE_engine_get_spherical_stereo(RenderEngine *engine, Object *camera)
void RE_engine_gpu_context_destroy(RenderEngine *engine)
void RE_engine_free(RenderEngine *engine)
void RE_engine_add_pass(RenderEngine *engine, const char *name, int channels, const char *chan_id, const char *layername)
void RE_engine_update_progress(RenderEngine *engine, float progress)
RenderData * RE_engine_get_render_data(Render *re)
void RE_engine_end_result(RenderEngine *engine, RenderResult *result, bool cancel, bool highlight, bool merge_results)
void RE_engine_register_pass(RenderEngine *engine, Scene *scene, ViewLayer *view_layer, const char *name, int channels, const char *chanid, eNodeSocketDatatype type)
void RE_engines_register(RenderEngineType *render_type)
bool RE_engine_test_break(RenderEngine *engine)
void RE_engines_init()
RenderPass * RE_engine_pass_by_index_get(RenderEngine *engine, const char *layer_name, int index)
bool RE_engine_view_pause_get(const RenderEngine *engine)
const char * RE_engine_active_view_get(RenderEngine *engine)
ListBaseT< RenderEngineType > R_engines
bool RE_engine_is_external(const Render *re)
void RE_engine_frame_set(RenderEngine *engine, int frame, float subframe)
const rcti * RE_engine_get_current_tiles(Render *re, int *r_total_tiles)
void RE_engine_draw_release(Render *re)
RenderEngineType * RE_engines_find(const char *idname)
void RE_engine_get_camera_model_matrix(RenderEngine *engine, Object *camera, bool use_spherical_stereo, float r_modelmat[16])
void RE_result_load_from_file(RenderResult *result, ReportList *reports, const char *filepath)
bool RE_engine_draw_acquire(Render *re)
bool RE_engine_render(Render *re, bool do_all)
void RE_engine_set_error_message(RenderEngine *engine, const char *msg)
void RE_engine_update_memory_stats(RenderEngine *engine, float mem_used, float mem_peak)
RenderEngine * RE_engine_create(RenderEngineType *type)
void RE_layer_load_from_file(RenderLayer *layer, ReportList *reports, const char *filepath, int x, int y)
void RE_engine_free_blender_memory(RenderEngine *engine)
void RE_bake_engine_set_engine_parameters(Render *re, Main *bmain, Scene *scene)
void RE_engine_gpu_context_lock(RenderEngine *engine)
pthread_mutex_t ThreadMutex
RenderEngine * RE_view_engine_get(const ViewRender *view_render)
RenderEngineFlag
Definition RE_engine.h:62
@ RE_ENGINE_ANIMATION
Definition RE_engine.h:63
@ RE_ENGINE_VIEW_PAUSED
Definition RE_engine.h:71
@ RE_ENGINE_RENDERING
Definition RE_engine.h:67
@ RE_ENGINE_DO_DRAW
Definition RE_engine.h:65
@ RE_ENGINE_HIGHLIGHT_TILES
Definition RE_engine.h:68
@ RE_ENGINE_VIEW_PAUSED_AUTO
Definition RE_engine.h:73
@ RE_ENGINE_DO_UPDATE
Definition RE_engine.h:66
@ RE_ENGINE_CAN_DRAW
Definition RE_engine.h:69
@ RE_ENGINE_VIEW_PAUSED_NOTIFIED
Definition RE_engine.h:75
@ RE_ENGINE_PREVIEW
Definition RE_engine.h:64
bool RE_engine_view_pause_notify(RenderEngine *engine, const bContext *context)
void(*)(void *userdata, struct Scene *scene, struct ViewLayer *view_layer, const char *name, int channels, const char *chanid, eNodeSocketDatatype type) update_render_passes_cb_t
Definition RE_engine.h:132
void RE_engine_tile_highlight_clear_all(RenderEngine *engine)
void RE_engine_active_view_set(RenderEngine *engine, const char *viewname)
RenderResult * RE_engine_begin_result(RenderEngine *engine, int x, int y, int w, int h, const char *layername, const char *viewname)
void(*) update_custom_camera(struct RenderEngine *engine, struct Camera *cam)
Definition RE_engine.h:126
struct RenderEngineType * prev
Definition RE_engine.h:81
struct RenderEngineType * next
Definition RE_engine.h:81
void(*) view_resume(struct RenderEngine *engine, const struct bContext *context)
Definition RE_engine.h:118
void(*) view_pause(struct RenderEngine *engine, const struct bContext *context)
Definition RE_engine.h:117
void(*) update_render_passes(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer)
Definition RE_engine.h:123
void(*) view_update(struct RenderEngine *engine, const struct bContext *context, struct Depsgraph *depsgraph)
Definition RE_engine.h:111
void(*) update(struct RenderEngine *engine, struct Main *bmain, struct Depsgraph *depsgraph)
Definition RE_engine.h:88
void(*) render(struct RenderEngine *engine, struct Depsgraph *depsgraph)
Definition RE_engine.h:90
void(*) bake(struct RenderEngine *engine, struct Depsgraph *depsgraph, struct Object *object, int pass_type, int pass_filter, int width, int height)
Definition RE_engine.h:103
void(*) view_draw(struct RenderEngine *engine, const struct bContext *context, struct Depsgraph *depsgraph)
Definition RE_engine.h:114
void(*) render_frame_finish(struct RenderEngine *engine)
Definition RE_engine.h:97
void(*) update_script_node(struct RenderEngine *engine, struct bNodeTree *ntree, struct bNode *node)
Definition RE_engine.h:120
const struct BakeTargets * targets
const struct BakePixel * pixels
ListBaseT< RenderResult > fullresult
Definition RE_engine.h:149
ThreadMutex update_render_passes_mutex
Definition RE_engine.h:169
void * update_render_passes_data
Definition RE_engine.h:171
ThreadMutex blender_gpu_context_mutex
Definition RE_engine.h:175
GHOST_IContext * system_gpu_context
Definition RE_engine.h:174
struct Depsgraph * depsgraph
Definition RE_engine.h:165
RenderEngineType * type
Definition RE_engine.h:141
struct ReportList * reports
Definition RE_engine.h:154
struct GPUContext * blender_gpu_context
Definition RE_engine.h:177
update_render_passes_cb_t update_render_passes_cb
Definition RE_engine.h:170
unsigned int layer_override
Definition RE_engine.h:146
struct Render * re
Definition RE_engine.h:148
struct Object * camera_override
Definition RE_engine.h:145