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
17 /** \file
18 * \ingroup RNA
19 */
20
21 #include <stdlib.h>
22
23 #include "DNA_node_types.h"
24 #include "DNA_object_types.h"
25 #include "DNA_scene_types.h"
26
27 #include "BLI_path_util.h"
28 #include "BLI_utildefines.h"
29
30 #ifdef WITH_PYTHON
31 # include "BPY_extern.h"
32 #endif
33
34 #include "DEG_depsgraph.h"
35
36 #include "BKE_image.h"
37 #include "BKE_scene.h"
38
39 #include "RNA_define.h"
40 #include "RNA_enum_types.h"
41
42 #include "rna_internal.h"
43
44 #include "RE_engine.h"
45 #include "RE_pipeline.h"
46
47 #include "ED_render.h"
48
49 /* Deprecated, only provided for API compatibility. */
50 const EnumPropertyItem rna_enum_render_pass_type_items[] = {
51 {SCE_PASS_COMBINED, "COMBINED", 0, "Combined", ""},
52 {SCE_PASS_Z, "Z", 0, "Z", ""},
53 {SCE_PASS_SHADOW, "SHADOW", 0, "Shadow", ""},
54 {SCE_PASS_AO, "AO", 0, "Ambient Occlusion", ""},
55 {SCE_PASS_NORMAL, "NORMAL", 0, "Normal", ""},
56 {SCE_PASS_VECTOR, "VECTOR", 0, "Vector", ""},
57 {SCE_PASS_INDEXOB, "OBJECT_INDEX", 0, "Object Index", ""},
58 {SCE_PASS_UV, "UV", 0, "UV", ""},
59 {SCE_PASS_MIST, "MIST", 0, "Mist", ""},
60 {SCE_PASS_EMIT, "EMIT", 0, "Emit", ""},
61 {SCE_PASS_ENVIRONMENT, "ENVIRONMENT", 0, "Environment", ""},
62 {SCE_PASS_INDEXMA, "MATERIAL_INDEX", 0, "Material Index", ""},
63 {SCE_PASS_DIFFUSE_DIRECT, "DIFFUSE_DIRECT", 0, "Diffuse Direct", ""},
64 {SCE_PASS_DIFFUSE_INDIRECT, "DIFFUSE_INDIRECT", 0, "Diffuse Indirect", ""},
65 {SCE_PASS_DIFFUSE_COLOR, "DIFFUSE_COLOR", 0, "Diffuse Color", ""},
66 {SCE_PASS_GLOSSY_DIRECT, "GLOSSY_DIRECT", 0, "Glossy Direct", ""},
67 {SCE_PASS_GLOSSY_INDIRECT, "GLOSSY_INDIRECT", 0, "Glossy Indirect", ""},
68 {SCE_PASS_GLOSSY_COLOR, "GLOSSY_COLOR", 0, "Glossy Color", ""},
69 {SCE_PASS_TRANSM_DIRECT, "TRANSMISSION_DIRECT", 0, "Transmission Direct", ""},
70 {SCE_PASS_TRANSM_INDIRECT, "TRANSMISSION_INDIRECT", 0, "Transmission Indirect", ""},
71 {SCE_PASS_TRANSM_COLOR, "TRANSMISSION_COLOR", 0, "Transmission Color", ""},
72 {SCE_PASS_SUBSURFACE_DIRECT, "SUBSURFACE_DIRECT", 0, "Subsurface Direct", ""},
73 {SCE_PASS_SUBSURFACE_INDIRECT, "SUBSURFACE_INDIRECT", 0, "Subsurface Indirect", ""},
74 {SCE_PASS_SUBSURFACE_COLOR, "SUBSURFACE_COLOR", 0, "Subsurface Color", ""},
75 #ifdef WITH_CYCLES_DEBUG
76 {SCE_PASS_DEBUG, "DEBUG", 0, "Pass used for render engine debugging", ""},
77 #endif
78 {0, NULL, 0, NULL, NULL},
79 };
80
81 const EnumPropertyItem rna_enum_bake_pass_type_items[] = {
82 {SCE_PASS_COMBINED, "COMBINED", 0, "Combined", ""},
83 {SCE_PASS_AO, "AO", 0, "Ambient Occlusion", ""},
84 {SCE_PASS_SHADOW, "SHADOW", 0, "Shadow", ""},
85 {SCE_PASS_NORMAL, "NORMAL", 0, "Normal", ""},
86 {SCE_PASS_UV, "UV", 0, "UV", ""},
87 {SCE_PASS_ROUGHNESS, "ROUGHNESS", 0, "ROUGHNESS", ""},
88 {SCE_PASS_EMIT, "EMIT", 0, "Emit", ""},
89 {SCE_PASS_ENVIRONMENT, "ENVIRONMENT", 0, "Environment", ""},
90 {SCE_PASS_DIFFUSE_COLOR, "DIFFUSE", 0, "Diffuse", ""},
91 {SCE_PASS_GLOSSY_COLOR, "GLOSSY", 0, "Glossy", ""},
92 {SCE_PASS_TRANSM_COLOR, "TRANSMISSION", 0, "Transmission", ""},
93 {0, NULL, 0, NULL, NULL},
94 };
95
96 #ifdef RNA_RUNTIME
97
98 # include "MEM_guardedalloc.h"
99
100 # include "RNA_access.h"
101
102 # include "BKE_context.h"
103 # include "BKE_report.h"
104
105 # include "GPU_capabilities.h"
106 # include "GPU_shader.h"
107 # include "IMB_colormanagement.h"
108
109 # include "DEG_depsgraph_query.h"
110
111 /* RenderEngine Callbacks */
112
engine_tag_redraw(RenderEngine * engine)113 static void engine_tag_redraw(RenderEngine *engine)
114 {
115 engine->flag |= RE_ENGINE_DO_DRAW;
116 }
117
engine_tag_update(RenderEngine * engine)118 static void engine_tag_update(RenderEngine *engine)
119 {
120 engine->flag |= RE_ENGINE_DO_UPDATE;
121 }
122
engine_support_display_space_shader(RenderEngine * UNUSED (engine),Scene * scene)123 static bool engine_support_display_space_shader(RenderEngine *UNUSED(engine), Scene *scene)
124 {
125 return IMB_colormanagement_support_glsl_draw(&scene->view_settings);
126 }
127
engine_get_preview_pixel_size(RenderEngine * UNUSED (engine),Scene * scene)128 static int engine_get_preview_pixel_size(RenderEngine *UNUSED(engine), Scene *scene)
129 {
130 return BKE_render_preview_pixel_size(&scene->r);
131 }
132
engine_bind_display_space_shader(RenderEngine * UNUSED (engine),Scene * UNUSED (scene))133 static void engine_bind_display_space_shader(RenderEngine *UNUSED(engine), Scene *UNUSED(scene))
134 {
135 GPUShader *shader = GPU_shader_get_builtin_shader(GPU_SHADER_2D_IMAGE);
136 GPU_shader_bind(shader);
137
138 int img_loc = GPU_shader_get_uniform(shader, "image");
139
140 GPU_shader_uniform_int(shader, img_loc, 0);
141 }
142
engine_unbind_display_space_shader(RenderEngine * UNUSED (engine))143 static void engine_unbind_display_space_shader(RenderEngine *UNUSED(engine))
144 {
145 GPU_shader_unbind();
146 }
147
engine_update(RenderEngine * engine,Main * bmain,Depsgraph * depsgraph)148 static void engine_update(RenderEngine *engine, Main *bmain, Depsgraph *depsgraph)
149 {
150 extern FunctionRNA rna_RenderEngine_update_func;
151 PointerRNA ptr;
152 ParameterList list;
153 FunctionRNA *func;
154
155 RNA_pointer_create(NULL, engine->type->rna_ext.srna, engine, &ptr);
156 func = &rna_RenderEngine_update_func;
157
158 RNA_parameter_list_create(&list, &ptr, func);
159 RNA_parameter_set_lookup(&list, "data", &bmain);
160 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
161 engine->type->rna_ext.call(NULL, &ptr, func, &list);
162
163 RNA_parameter_list_free(&list);
164 }
165
engine_render(RenderEngine * engine,Depsgraph * depsgraph)166 static void engine_render(RenderEngine *engine, Depsgraph *depsgraph)
167 {
168 extern FunctionRNA rna_RenderEngine_render_func;
169 PointerRNA ptr;
170 ParameterList list;
171 FunctionRNA *func;
172
173 RNA_pointer_create(NULL, engine->type->rna_ext.srna, engine, &ptr);
174 func = &rna_RenderEngine_render_func;
175
176 RNA_parameter_list_create(&list, &ptr, func);
177 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
178 engine->type->rna_ext.call(NULL, &ptr, func, &list);
179
180 RNA_parameter_list_free(&list);
181 }
182
engine_bake(RenderEngine * engine,struct Depsgraph * depsgraph,struct Object * object,const int pass_type,const int pass_filter,const int width,const int height)183 static void engine_bake(RenderEngine *engine,
184 struct Depsgraph *depsgraph,
185 struct Object *object,
186 const int pass_type,
187 const int pass_filter,
188 const int width,
189 const int height)
190 {
191 extern FunctionRNA rna_RenderEngine_bake_func;
192 PointerRNA ptr;
193 ParameterList list;
194 FunctionRNA *func;
195
196 RNA_pointer_create(NULL, engine->type->rna_ext.srna, engine, &ptr);
197 func = &rna_RenderEngine_bake_func;
198
199 RNA_parameter_list_create(&list, &ptr, func);
200 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
201 RNA_parameter_set_lookup(&list, "object", &object);
202 RNA_parameter_set_lookup(&list, "pass_type", &pass_type);
203 RNA_parameter_set_lookup(&list, "pass_filter", &pass_filter);
204 RNA_parameter_set_lookup(&list, "width", &width);
205 RNA_parameter_set_lookup(&list, "height", &height);
206 engine->type->rna_ext.call(NULL, &ptr, func, &list);
207
208 RNA_parameter_list_free(&list);
209 }
210
engine_view_update(RenderEngine * engine,const struct bContext * context,Depsgraph * depsgraph)211 static void engine_view_update(RenderEngine *engine,
212 const struct bContext *context,
213 Depsgraph *depsgraph)
214 {
215 extern FunctionRNA rna_RenderEngine_view_update_func;
216 PointerRNA ptr;
217 ParameterList list;
218 FunctionRNA *func;
219
220 RNA_pointer_create(NULL, engine->type->rna_ext.srna, engine, &ptr);
221 func = &rna_RenderEngine_view_update_func;
222
223 RNA_parameter_list_create(&list, &ptr, func);
224 RNA_parameter_set_lookup(&list, "context", &context);
225 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
226 engine->type->rna_ext.call(NULL, &ptr, func, &list);
227
228 RNA_parameter_list_free(&list);
229 }
230
engine_view_draw(RenderEngine * engine,const struct bContext * context,Depsgraph * depsgraph)231 static void engine_view_draw(RenderEngine *engine,
232 const struct bContext *context,
233 Depsgraph *depsgraph)
234 {
235 extern FunctionRNA rna_RenderEngine_view_draw_func;
236 PointerRNA ptr;
237 ParameterList list;
238 FunctionRNA *func;
239
240 RNA_pointer_create(NULL, engine->type->rna_ext.srna, engine, &ptr);
241 func = &rna_RenderEngine_view_draw_func;
242
243 RNA_parameter_list_create(&list, &ptr, func);
244 RNA_parameter_set_lookup(&list, "context", &context);
245 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
246 engine->type->rna_ext.call(NULL, &ptr, func, &list);
247
248 RNA_parameter_list_free(&list);
249 }
250
engine_update_script_node(RenderEngine * engine,struct bNodeTree * ntree,struct bNode * node)251 static void engine_update_script_node(RenderEngine *engine,
252 struct bNodeTree *ntree,
253 struct bNode *node)
254 {
255 extern FunctionRNA rna_RenderEngine_update_script_node_func;
256 PointerRNA ptr, nodeptr;
257 ParameterList list;
258 FunctionRNA *func;
259
260 RNA_pointer_create(NULL, engine->type->rna_ext.srna, engine, &ptr);
261 RNA_pointer_create((ID *)ntree, &RNA_Node, node, &nodeptr);
262 func = &rna_RenderEngine_update_script_node_func;
263
264 RNA_parameter_list_create(&list, &ptr, func);
265 RNA_parameter_set_lookup(&list, "node", &nodeptr);
266 engine->type->rna_ext.call(NULL, &ptr, func, &list);
267
268 RNA_parameter_list_free(&list);
269 }
270
engine_update_render_passes(RenderEngine * engine,struct Scene * scene,struct ViewLayer * view_layer)271 static void engine_update_render_passes(RenderEngine *engine,
272 struct Scene *scene,
273 struct ViewLayer *view_layer)
274 {
275 extern FunctionRNA rna_RenderEngine_update_render_passes_func;
276 PointerRNA ptr;
277 ParameterList list;
278 FunctionRNA *func;
279
280 RNA_pointer_create(NULL, engine->type->rna_ext.srna, engine, &ptr);
281 func = &rna_RenderEngine_update_render_passes_func;
282
283 RNA_parameter_list_create(&list, &ptr, func);
284 RNA_parameter_set_lookup(&list, "scene", &scene);
285 RNA_parameter_set_lookup(&list, "renderlayer", &view_layer);
286 engine->type->rna_ext.call(NULL, &ptr, func, &list);
287
288 RNA_parameter_list_free(&list);
289 }
290
291 /* RenderEngine registration */
292
rna_RenderEngine_unregister(Main * bmain,StructRNA * type)293 static void rna_RenderEngine_unregister(Main *bmain, StructRNA *type)
294 {
295 RenderEngineType *et = RNA_struct_blender_type_get(type);
296
297 if (!et) {
298 return;
299 }
300
301 RE_FreeAllPersistentData();
302 RNA_struct_free_extension(type, &et->rna_ext);
303 RNA_struct_free(&BLENDER_RNA, type);
304 BLI_freelinkN(&R_engines, et);
305
306 /* Stop all renders in case we were using this one. */
307 ED_render_engine_changed(bmain, false);
308 }
309
rna_RenderEngine_register(Main * bmain,ReportList * reports,void * data,const char * identifier,StructValidateFunc validate,StructCallbackFunc call,StructFreeFunc free)310 static StructRNA *rna_RenderEngine_register(Main *bmain,
311 ReportList *reports,
312 void *data,
313 const char *identifier,
314 StructValidateFunc validate,
315 StructCallbackFunc call,
316 StructFreeFunc free)
317 {
318 RenderEngineType *et, dummyet = {NULL};
319 RenderEngine dummyengine = {NULL};
320 PointerRNA dummyptr;
321 int have_function[8];
322
323 /* setup dummy engine & engine type to store static properties in */
324 dummyengine.type = &dummyet;
325 dummyet.flag |= RE_USE_SHADING_NODES_CUSTOM;
326 RNA_pointer_create(NULL, &RNA_RenderEngine, &dummyengine, &dummyptr);
327
328 /* validate the python class */
329 if (validate(&dummyptr, data, have_function) != 0) {
330 return NULL;
331 }
332
333 if (strlen(identifier) >= sizeof(dummyet.idname)) {
334 BKE_reportf(reports,
335 RPT_ERROR,
336 "Registering render engine class: '%s' is too long, maximum length is %d",
337 identifier,
338 (int)sizeof(dummyet.idname));
339 return NULL;
340 }
341
342 /* check if we have registered this engine type before, and remove it */
343 for (et = R_engines.first; et; et = et->next) {
344 if (STREQ(et->idname, dummyet.idname)) {
345 if (et->rna_ext.srna) {
346 rna_RenderEngine_unregister(bmain, et->rna_ext.srna);
347 }
348 break;
349 }
350 }
351
352 /* create a new engine type */
353 et = MEM_mallocN(sizeof(RenderEngineType), "python render engine");
354 memcpy(et, &dummyet, sizeof(dummyet));
355
356 et->rna_ext.srna = RNA_def_struct_ptr(&BLENDER_RNA, et->idname, &RNA_RenderEngine);
357 et->rna_ext.data = data;
358 et->rna_ext.call = call;
359 et->rna_ext.free = free;
360 RNA_struct_blender_type_set(et->rna_ext.srna, et);
361
362 et->update = (have_function[0]) ? engine_update : NULL;
363 et->render = (have_function[1]) ? engine_render : NULL;
364 et->bake = (have_function[2]) ? engine_bake : NULL;
365 et->view_update = (have_function[3]) ? engine_view_update : NULL;
366 et->view_draw = (have_function[4]) ? engine_view_draw : NULL;
367 et->update_script_node = (have_function[5]) ? engine_update_script_node : NULL;
368 et->update_render_passes = (have_function[6]) ? engine_update_render_passes : NULL;
369
370 RE_engines_register(et);
371
372 return et->rna_ext.srna;
373 }
374
rna_RenderEngine_instance(PointerRNA * ptr)375 static void **rna_RenderEngine_instance(PointerRNA *ptr)
376 {
377 RenderEngine *engine = ptr->data;
378 return &engine->py_instance;
379 }
380
rna_RenderEngine_refine(PointerRNA * ptr)381 static StructRNA *rna_RenderEngine_refine(PointerRNA *ptr)
382 {
383 RenderEngine *engine = (RenderEngine *)ptr->data;
384 return (engine->type && engine->type->rna_ext.srna) ? engine->type->rna_ext.srna :
385 &RNA_RenderEngine;
386 }
387
rna_RenderEngine_render_get(PointerRNA * ptr)388 static PointerRNA rna_RenderEngine_render_get(PointerRNA *ptr)
389 {
390 RenderEngine *engine = (RenderEngine *)ptr->data;
391
392 if (engine->re) {
393 RenderData *r = RE_engine_get_render_data(engine->re);
394
395 return rna_pointer_inherit_refine(ptr, &RNA_RenderSettings, r);
396 }
397 else {
398 return rna_pointer_inherit_refine(ptr, &RNA_RenderSettings, NULL);
399 }
400 }
401
rna_RenderEngine_camera_override_get(PointerRNA * ptr)402 static PointerRNA rna_RenderEngine_camera_override_get(PointerRNA *ptr)
403 {
404 RenderEngine *engine = (RenderEngine *)ptr->data;
405 /* TODO(sergey): Shouldn't engine point to an evaluated datablocks already? */
406 if (engine->re) {
407 Object *cam = RE_GetCamera(engine->re);
408 Object *cam_eval = DEG_get_evaluated_object(engine->depsgraph, cam);
409 return rna_pointer_inherit_refine(ptr, &RNA_Object, cam_eval);
410 }
411 else {
412 return rna_pointer_inherit_refine(ptr, &RNA_Object, engine->camera_override);
413 }
414 }
415
rna_RenderEngine_engine_frame_set(RenderEngine * engine,int frame,float subframe)416 static void rna_RenderEngine_engine_frame_set(RenderEngine *engine, int frame, float subframe)
417 {
418 # ifdef WITH_PYTHON
419 BPy_BEGIN_ALLOW_THREADS;
420 # endif
421
422 RE_engine_frame_set(engine, frame, subframe);
423
424 # ifdef WITH_PYTHON
425 BPy_END_ALLOW_THREADS;
426 # endif
427 }
428
rna_RenderResult_views_begin(CollectionPropertyIterator * iter,PointerRNA * ptr)429 static void rna_RenderResult_views_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
430 {
431 RenderResult *rr = (RenderResult *)ptr->data;
432 rna_iterator_listbase_begin(iter, &rr->views, NULL);
433 }
434
rna_RenderResult_layers_begin(CollectionPropertyIterator * iter,PointerRNA * ptr)435 static void rna_RenderResult_layers_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
436 {
437 RenderResult *rr = (RenderResult *)ptr->data;
438 rna_iterator_listbase_begin(iter, &rr->layers, NULL);
439 }
440
rna_RenderResult_stamp_data_add_field(RenderResult * rr,const char * field,const char * value)441 static void rna_RenderResult_stamp_data_add_field(RenderResult *rr,
442 const char *field,
443 const char *value)
444 {
445 BKE_render_result_stamp_data(rr, field, value);
446 }
447
rna_RenderLayer_passes_begin(CollectionPropertyIterator * iter,PointerRNA * ptr)448 static void rna_RenderLayer_passes_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
449 {
450 RenderLayer *rl = (RenderLayer *)ptr->data;
451 rna_iterator_listbase_begin(iter, &rl->passes, NULL);
452 }
453
rna_RenderPass_rect_get_length(PointerRNA * ptr,int length[RNA_MAX_ARRAY_DIMENSION])454 static int rna_RenderPass_rect_get_length(PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION])
455 {
456 RenderPass *rpass = (RenderPass *)ptr->data;
457
458 length[0] = rpass->rectx * rpass->recty;
459 length[1] = rpass->channels;
460
461 return length[0] * length[1];
462 }
463
rna_RenderPass_rect_get(PointerRNA * ptr,float * values)464 static void rna_RenderPass_rect_get(PointerRNA *ptr, float *values)
465 {
466 RenderPass *rpass = (RenderPass *)ptr->data;
467 memcpy(values, rpass->rect, sizeof(float) * rpass->rectx * rpass->recty * rpass->channels);
468 }
469
rna_RenderPass_rect_set(PointerRNA * ptr,const float * values)470 void rna_RenderPass_rect_set(PointerRNA *ptr, const float *values)
471 {
472 RenderPass *rpass = (RenderPass *)ptr->data;
473 memcpy(rpass->rect, values, sizeof(float) * rpass->rectx * rpass->recty * rpass->channels);
474 }
475
rna_RenderPass_find_by_type(RenderLayer * rl,int passtype,const char * view)476 static RenderPass *rna_RenderPass_find_by_type(RenderLayer *rl, int passtype, const char *view)
477 {
478 return RE_pass_find_by_type(rl, passtype, view);
479 }
480
rna_RenderPass_find_by_name(RenderLayer * rl,const char * name,const char * view)481 static RenderPass *rna_RenderPass_find_by_name(RenderLayer *rl, const char *name, const char *view)
482 {
483 return RE_pass_find_by_name(rl, name, view);
484 }
485
486 #else /* RNA_RUNTIME */
487
rna_def_render_engine(BlenderRNA * brna)488 static void rna_def_render_engine(BlenderRNA *brna)
489 {
490 StructRNA *srna;
491 PropertyRNA *prop;
492
493 FunctionRNA *func;
494 PropertyRNA *parm;
495
496 static const EnumPropertyItem render_pass_type_items[] = {
497 {SOCK_FLOAT, "VALUE", 0, "Value", ""},
498 {SOCK_VECTOR, "VECTOR", 0, "Vector", ""},
499 {SOCK_RGBA, "COLOR", 0, "Color", ""},
500 {0, NULL, 0, NULL, NULL},
501 };
502
503 srna = RNA_def_struct(brna, "RenderEngine", NULL);
504 RNA_def_struct_sdna(srna, "RenderEngine");
505 RNA_def_struct_ui_text(srna, "Render Engine", "Render engine");
506 RNA_def_struct_refine_func(srna, "rna_RenderEngine_refine");
507 RNA_def_struct_register_funcs(srna,
508 "rna_RenderEngine_register",
509 "rna_RenderEngine_unregister",
510 "rna_RenderEngine_instance");
511
512 /* final render callbacks */
513 func = RNA_def_function(srna, "update", NULL);
514 RNA_def_function_ui_description(func, "Export scene data for render");
515 RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
516 RNA_def_pointer(func, "data", "BlendData", "", "");
517 RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "");
518
519 func = RNA_def_function(srna, "render", NULL);
520 RNA_def_function_ui_description(func, "Render scene into an image");
521 RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
522 parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "");
523 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
524
525 func = RNA_def_function(srna, "bake", NULL);
526 RNA_def_function_ui_description(func, "Bake passes");
527 RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
528 parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "");
529 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
530 parm = RNA_def_pointer(func, "object", "Object", "", "");
531 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
532 parm = RNA_def_enum(func, "pass_type", rna_enum_bake_pass_type_items, 0, "Pass", "Pass to bake");
533 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
534 parm = RNA_def_int(func,
535 "pass_filter",
536 0,
537 0,
538 INT_MAX,
539 "Pass Filter",
540 "Filter to combined, diffuse, glossy and transmission passes",
541 0,
542 INT_MAX);
543 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
544 parm = RNA_def_int(func, "width", 0, 0, INT_MAX, "Width", "Image width", 0, INT_MAX);
545 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
546 parm = RNA_def_int(func, "height", 0, 0, INT_MAX, "Height", "Image height", 0, INT_MAX);
547 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
548
549 /* viewport render callbacks */
550 func = RNA_def_function(srna, "view_update", NULL);
551 RNA_def_function_ui_description(func, "Update on data changes for viewport render");
552 RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
553 parm = RNA_def_pointer(func, "context", "Context", "", "");
554 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
555 parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "");
556 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
557
558 func = RNA_def_function(srna, "view_draw", NULL);
559 RNA_def_function_ui_description(func, "Draw viewport render");
560 RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL);
561 parm = RNA_def_pointer(func, "context", "Context", "", "");
562 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
563 parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "");
564 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
565
566 /* shader script callbacks */
567 func = RNA_def_function(srna, "update_script_node", NULL);
568 RNA_def_function_ui_description(func, "Compile shader script node");
569 RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
570 parm = RNA_def_pointer(func, "node", "Node", "", "");
571 RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
572
573 func = RNA_def_function(srna, "update_render_passes", NULL);
574 RNA_def_function_ui_description(func, "Update the render passes that will be generated");
575 RNA_def_function_flag(func, FUNC_REGISTER_OPTIONAL | FUNC_ALLOW_WRITE);
576 parm = RNA_def_pointer(func, "scene", "Scene", "", "");
577 parm = RNA_def_pointer(func, "renderlayer", "ViewLayer", "", "");
578
579 /* tag for redraw */
580 func = RNA_def_function(srna, "tag_redraw", "engine_tag_redraw");
581 RNA_def_function_ui_description(func, "Request redraw for viewport rendering");
582
583 /* tag for update */
584 func = RNA_def_function(srna, "tag_update", "engine_tag_update");
585 RNA_def_function_ui_description(func, "Request update call for viewport rendering");
586
587 func = RNA_def_function(srna, "begin_result", "RE_engine_begin_result");
588 RNA_def_function_ui_description(
589 func, "Create render result to write linear floating point render layers and passes");
590 parm = RNA_def_int(func, "x", 0, 0, INT_MAX, "X", "", 0, INT_MAX);
591 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
592 parm = RNA_def_int(func, "y", 0, 0, INT_MAX, "Y", "", 0, INT_MAX);
593 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
594 parm = RNA_def_int(func, "w", 0, 0, INT_MAX, "Width", "", 0, INT_MAX);
595 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
596 parm = RNA_def_int(func, "h", 0, 0, INT_MAX, "Height", "", 0, INT_MAX);
597 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
598 RNA_def_string(
599 func, "layer", NULL, 0, "Layer", "Single layer to get render result for"); /* NULL ok here */
600 RNA_def_string(
601 func, "view", NULL, 0, "View", "Single view to get render result for"); /* NULL ok here */
602 parm = RNA_def_pointer(func, "result", "RenderResult", "Result", "");
603 RNA_def_function_return(func, parm);
604
605 func = RNA_def_function(srna, "update_result", "RE_engine_update_result");
606 RNA_def_function_ui_description(
607 func, "Signal that pixels have been updated and can be redrawn in the user interface");
608 parm = RNA_def_pointer(func, "result", "RenderResult", "Result", "");
609 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
610
611 func = RNA_def_function(srna, "end_result", "RE_engine_end_result");
612 RNA_def_function_ui_description(func,
613 "All pixels in the render result have been set and are final");
614 parm = RNA_def_pointer(func, "result", "RenderResult", "Result", "");
615 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
616 RNA_def_boolean(
617 func, "cancel", 0, "Cancel", "Don't mark tile as done, don't merge results unless forced");
618 RNA_def_boolean(func, "highlight", 0, "Highlight", "Don't mark tile as done yet");
619 RNA_def_boolean(
620 func, "do_merge_results", 0, "Merge Results", "Merge results even if cancel=true");
621
622 func = RNA_def_function(srna, "add_pass", "RE_engine_add_pass");
623 RNA_def_function_ui_description(func, "Add a pass to the render layer");
624 parm = RNA_def_string(
625 func, "name", NULL, 0, "Name", "Name of the Pass, without view or channel tag");
626 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
627 parm = RNA_def_int(func, "channels", 0, 0, INT_MAX, "Channels", "", 0, INT_MAX);
628 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
629 parm = RNA_def_string(
630 func, "chan_id", NULL, 0, "Channel IDs", "Channel names, one character per channel");
631 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
632 RNA_def_string(
633 func, "layer", NULL, 0, "Layer", "Single layer to add render pass to"); /* NULL ok here */
634
635 func = RNA_def_function(srna, "get_result", "RE_engine_get_result");
636 RNA_def_function_ui_description(func, "Get final result for non-pixel operations");
637 parm = RNA_def_pointer(func, "result", "RenderResult", "Result", "");
638 RNA_def_function_return(func, parm);
639
640 func = RNA_def_function(srna, "test_break", "RE_engine_test_break");
641 RNA_def_function_ui_description(func,
642 "Test if the render operation should been canceled, this is a "
643 "fast call that should be used regularly for responsiveness");
644 parm = RNA_def_boolean(func, "do_break", 0, "Break", "");
645 RNA_def_function_return(func, parm);
646
647 func = RNA_def_function(srna, "active_view_get", "RE_engine_active_view_get");
648 parm = RNA_def_string(func, "view", NULL, 0, "View", "Single view active");
649 RNA_def_function_return(func, parm);
650
651 func = RNA_def_function(srna, "active_view_set", "RE_engine_active_view_set");
652 parm = RNA_def_string(
653 func, "view", NULL, 0, "View", "Single view to set as active"); /* NULL ok here */
654 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
655
656 func = RNA_def_function(srna, "camera_shift_x", "RE_engine_get_camera_shift_x");
657 parm = RNA_def_pointer(func, "camera", "Object", "", "");
658 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
659 RNA_def_boolean(func, "use_spherical_stereo", 0, "Spherical Stereo", "");
660 parm = RNA_def_float(func, "shift_x", 0.0f, 0.0f, FLT_MAX, "Shift X", "", 0.0f, FLT_MAX);
661 RNA_def_function_return(func, parm);
662
663 func = RNA_def_function(srna, "camera_model_matrix", "RE_engine_get_camera_model_matrix");
664 parm = RNA_def_pointer(func, "camera", "Object", "", "");
665 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
666 RNA_def_boolean(func, "use_spherical_stereo", 0, "Spherical Stereo", "");
667 parm = RNA_def_float_matrix(func,
668 "r_model_matrix",
669 4,
670 4,
671 NULL,
672 0.0f,
673 0.0f,
674 "Model Matrix",
675 "Normalized camera model matrix",
676 0.0f,
677 0.0f);
678 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
679 RNA_def_function_output(func, parm);
680
681 func = RNA_def_function(srna, "use_spherical_stereo", "RE_engine_get_spherical_stereo");
682 parm = RNA_def_pointer(func, "camera", "Object", "", "");
683 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
684 parm = RNA_def_boolean(func, "use_spherical_stereo", 0, "Spherical Stereo", "");
685 RNA_def_function_return(func, parm);
686
687 func = RNA_def_function(srna, "update_stats", "RE_engine_update_stats");
688 RNA_def_function_ui_description(func, "Update and signal to redraw render status text");
689 parm = RNA_def_string(func, "stats", NULL, 0, "Stats", "");
690 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
691 parm = RNA_def_string(func, "info", NULL, 0, "Info", "");
692 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
693
694 func = RNA_def_function(srna, "frame_set", "rna_RenderEngine_engine_frame_set");
695 RNA_def_function_ui_description(func, "Evaluate scene at a different frame (for motion blur)");
696 parm = RNA_def_int(func, "frame", 0, INT_MIN, INT_MAX, "Frame", "", INT_MIN, INT_MAX);
697 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
698 parm = RNA_def_float(func, "subframe", 0.0f, 0.0f, 1.0f, "Subframe", "", 0.0f, 1.0f);
699 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
700
701 func = RNA_def_function(srna, "update_progress", "RE_engine_update_progress");
702 RNA_def_function_ui_description(func, "Update progress percentage of render");
703 parm = RNA_def_float(
704 func, "progress", 0, 0.0f, 1.0f, "", "Percentage of render that's done", 0.0f, 1.0f);
705 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
706
707 func = RNA_def_function(srna, "update_memory_stats", "RE_engine_update_memory_stats");
708 RNA_def_function_ui_description(func, "Update memory usage statistics");
709 RNA_def_float(func,
710 "memory_used",
711 0,
712 0.0f,
713 FLT_MAX,
714 "",
715 "Current memory usage in megabytes",
716 0.0f,
717 FLT_MAX);
718 RNA_def_float(
719 func, "memory_peak", 0, 0.0f, FLT_MAX, "", "Peak memory usage in megabytes", 0.0f, FLT_MAX);
720
721 func = RNA_def_function(srna, "report", "RE_engine_report");
722 RNA_def_function_ui_description(func, "Report info, warning or error messages");
723 parm = RNA_def_enum_flag(func, "type", rna_enum_wm_report_items, 0, "Type", "");
724 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
725 parm = RNA_def_string(func, "message", NULL, 0, "Report Message", "");
726 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
727
728 func = RNA_def_function(srna, "error_set", "RE_engine_set_error_message");
729 RNA_def_function_ui_description(func,
730 "Set error message displaying after the render is finished");
731 parm = RNA_def_string(func, "message", NULL, 0, "Report Message", "");
732 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
733
734 func = RNA_def_function(srna, "bind_display_space_shader", "engine_bind_display_space_shader");
735 RNA_def_function_ui_description(func,
736 "Bind GLSL fragment shader that converts linear colors to "
737 "display space colors using scene color management settings");
738 parm = RNA_def_pointer(func, "scene", "Scene", "", "");
739 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
740
741 func = RNA_def_function(
742 srna, "unbind_display_space_shader", "engine_unbind_display_space_shader");
743 RNA_def_function_ui_description(
744 func, "Unbind GLSL display space shader, must always be called after binding the shader");
745
746 func = RNA_def_function(
747 srna, "support_display_space_shader", "engine_support_display_space_shader");
748 RNA_def_function_ui_description(func,
749 "Test if GLSL display space shader is supported for the "
750 "combination of graphics card and scene settings");
751 parm = RNA_def_pointer(func, "scene", "Scene", "", "");
752 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
753 parm = RNA_def_boolean(func, "supported", 0, "Supported", "");
754 RNA_def_function_return(func, parm);
755
756 func = RNA_def_function(srna, "get_preview_pixel_size", "engine_get_preview_pixel_size");
757 RNA_def_function_ui_description(func,
758 "Get the pixel size that should be used for preview rendering");
759 parm = RNA_def_pointer(func, "scene", "Scene", "", "");
760 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
761 parm = RNA_def_int(func, "pixel_size", 0, 1, 8, "Pixel Size", "", 1, 8);
762 RNA_def_function_return(func, parm);
763
764 RNA_def_function(srna, "free_blender_memory", "RE_engine_free_blender_memory");
765 RNA_def_function_ui_description(func, "Free Blender side memory of render engine");
766
767 RNA_define_verify_sdna(0);
768
769 prop = RNA_def_property(srna, "is_animation", PROP_BOOLEAN, PROP_NONE);
770 RNA_def_property_boolean_sdna(prop, NULL, "flag", RE_ENGINE_ANIMATION);
771
772 prop = RNA_def_property(srna, "is_preview", PROP_BOOLEAN, PROP_NONE);
773 RNA_def_property_boolean_sdna(prop, NULL, "flag", RE_ENGINE_PREVIEW);
774
775 prop = RNA_def_property(srna, "camera_override", PROP_POINTER, PROP_NONE);
776 RNA_def_property_pointer_funcs(prop, "rna_RenderEngine_camera_override_get", NULL, NULL, NULL);
777 RNA_def_property_struct_type(prop, "Object");
778
779 prop = RNA_def_property(srna, "layer_override", PROP_BOOLEAN, PROP_LAYER_MEMBER);
780 RNA_def_property_boolean_sdna(prop, NULL, "layer_override", 1);
781 RNA_def_property_array(prop, 20);
782
783 prop = RNA_def_property(srna, "tile_x", PROP_INT, PROP_UNSIGNED);
784 RNA_def_property_int_sdna(prop, NULL, "tile_x");
785 prop = RNA_def_property(srna, "tile_y", PROP_INT, PROP_UNSIGNED);
786 RNA_def_property_int_sdna(prop, NULL, "tile_y");
787
788 prop = RNA_def_property(srna, "resolution_x", PROP_INT, PROP_PIXEL);
789 RNA_def_property_int_sdna(prop, NULL, "resolution_x");
790 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
791
792 prop = RNA_def_property(srna, "resolution_y", PROP_INT, PROP_PIXEL);
793 RNA_def_property_int_sdna(prop, NULL, "resolution_y");
794 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
795
796 /* Render Data */
797 prop = RNA_def_property(srna, "render", PROP_POINTER, PROP_NONE);
798 RNA_def_property_struct_type(prop, "RenderSettings");
799 RNA_def_property_pointer_funcs(prop, "rna_RenderEngine_render_get", NULL, NULL, NULL);
800 RNA_def_property_ui_text(prop, "Render Data", "");
801
802 prop = RNA_def_property(srna, "use_highlight_tiles", PROP_BOOLEAN, PROP_NONE);
803 RNA_def_property_boolean_sdna(prop, NULL, "flag", RE_ENGINE_HIGHLIGHT_TILES);
804
805 func = RNA_def_function(srna, "register_pass", "RE_engine_register_pass");
806 RNA_def_function_ui_description(
807 func, "Register a render pass that will be part of the render with the current settings");
808 parm = RNA_def_pointer(func, "scene", "Scene", "", "");
809 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
810 parm = RNA_def_pointer(func, "view_layer", "ViewLayer", "", "");
811 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
812 parm = RNA_def_string(func, "name", NULL, MAX_NAME, "Name", "");
813 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
814 parm = RNA_def_int(func, "channels", 1, 1, 8, "Channels", "", 1, 4);
815 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
816 parm = RNA_def_string(func, "chanid", NULL, 8, "Channel IDs", "");
817 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
818 parm = RNA_def_enum(func, "type", render_pass_type_items, SOCK_FLOAT, "Type", "");
819 RNA_def_property_enum_native_type(parm, "eNodeSocketDatatype");
820 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
821
822 /* registration */
823
824 prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
825 RNA_def_property_string_sdna(prop, NULL, "type->idname");
826 RNA_def_property_flag(prop, PROP_REGISTER);
827
828 prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
829 RNA_def_property_string_sdna(prop, NULL, "type->name");
830 RNA_def_property_flag(prop, PROP_REGISTER);
831
832 prop = RNA_def_property(srna, "bl_use_preview", PROP_BOOLEAN, PROP_NONE);
833 RNA_def_property_boolean_sdna(prop, NULL, "type->flag", RE_USE_PREVIEW);
834 RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
835 RNA_def_property_ui_text(
836 prop,
837 "Use Preview Render",
838 "Render engine supports being used for rendering previews of materials, lights and worlds");
839
840 prop = RNA_def_property(srna, "bl_use_postprocess", PROP_BOOLEAN, PROP_NONE);
841 RNA_def_property_boolean_negative_sdna(prop, NULL, "type->flag", RE_USE_POSTPROCESS);
842 RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
843 RNA_def_property_ui_text(prop, "Use Post Processing", "Apply compositing on render results");
844
845 prop = RNA_def_property(srna, "bl_use_eevee_viewport", PROP_BOOLEAN, PROP_NONE);
846 RNA_def_property_boolean_sdna(prop, NULL, "type->flag", RE_USE_EEVEE_VIEWPORT);
847 RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
848 RNA_def_property_ui_text(
849 prop, "Use Eevee Viewport", "Uses Eevee for viewport shading in LookDev shading mode");
850
851 prop = RNA_def_property(srna, "bl_use_gpu_context", PROP_BOOLEAN, PROP_NONE);
852 RNA_def_property_boolean_sdna(prop, NULL, "type->flag", RE_USE_GPU_CONTEXT);
853 RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
854 RNA_def_property_ui_text(
855 prop,
856 "Use GPU Context",
857 "Enable OpenGL context for the render method, for engines that render using OpenGL");
858
859 prop = RNA_def_property(srna, "bl_use_shading_nodes_custom", PROP_BOOLEAN, PROP_NONE);
860 RNA_def_property_boolean_sdna(prop, NULL, "type->flag", RE_USE_SHADING_NODES_CUSTOM);
861 RNA_def_property_boolean_default(prop, true);
862 RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
863 RNA_def_property_ui_text(prop,
864 "Use Custom Shading Nodes",
865 "Don't expose Cycles and Eevee shading nodes in the node editor user "
866 "interface, so own nodes can be used instead");
867
868 prop = RNA_def_property(srna, "bl_use_save_buffers", PROP_BOOLEAN, PROP_NONE);
869 RNA_def_property_boolean_sdna(prop, NULL, "type->flag", RE_USE_SAVE_BUFFERS);
870 RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
871 RNA_def_property_ui_text(
872 prop, "Use Save Buffers", "Support render to an on disk buffer during rendering");
873
874 prop = RNA_def_property(srna, "bl_use_spherical_stereo", PROP_BOOLEAN, PROP_NONE);
875 RNA_def_property_boolean_sdna(prop, NULL, "type->flag", RE_USE_SPHERICAL_STEREO);
876 RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
877 RNA_def_property_ui_text(prop, "Use Spherical Stereo", "Support spherical stereo camera models");
878
879 prop = RNA_def_property(srna, "bl_use_stereo_viewport", PROP_BOOLEAN, PROP_NONE);
880 RNA_def_property_boolean_sdna(prop, NULL, "type->flag", RE_USE_STEREO_VIEWPORT);
881 RNA_def_property_flag(prop, PROP_REGISTER_OPTIONAL);
882 RNA_def_property_ui_text(prop, "Use Stereo Viewport", "Support rendering stereo 3D viewport");
883
884 RNA_define_verify_sdna(1);
885 }
886
rna_def_render_result(BlenderRNA * brna)887 static void rna_def_render_result(BlenderRNA *brna)
888 {
889 StructRNA *srna;
890 PropertyRNA *prop;
891
892 FunctionRNA *func;
893 PropertyRNA *parm;
894
895 srna = RNA_def_struct(brna, "RenderResult", NULL);
896 RNA_def_struct_ui_text(
897 srna, "Render Result", "Result of rendering, including all layers and passes");
898
899 func = RNA_def_function(srna, "load_from_file", "RE_result_load_from_file");
900 RNA_def_function_ui_description(func,
901 "Copies the pixels of this render result from an image file");
902 RNA_def_function_flag(func, FUNC_USE_REPORTS);
903 parm = RNA_def_string_file_name(
904 func,
905 "filename",
906 NULL,
907 FILE_MAX,
908 "File Name",
909 "Filename to load into this render tile, must be no smaller than "
910 "the render result");
911 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
912
913 func = RNA_def_function(srna, "stamp_data_add_field", "rna_RenderResult_stamp_data_add_field");
914 RNA_def_function_ui_description(func, "Add engine-specific stamp data to the result");
915 parm = RNA_def_string(func, "field", NULL, 1024, "Field", "Name of the stamp field to add");
916 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
917 parm = RNA_def_string(func, "value", NULL, 0, "Value", "Value of the stamp data");
918 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
919
920 RNA_define_verify_sdna(0);
921
922 prop = RNA_def_property(srna, "resolution_x", PROP_INT, PROP_PIXEL);
923 RNA_def_property_int_sdna(prop, NULL, "rectx");
924 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
925
926 prop = RNA_def_property(srna, "resolution_y", PROP_INT, PROP_PIXEL);
927 RNA_def_property_int_sdna(prop, NULL, "recty");
928 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
929
930 prop = RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
931 RNA_def_property_struct_type(prop, "RenderLayer");
932 RNA_def_property_collection_funcs(prop,
933 "rna_RenderResult_layers_begin",
934 "rna_iterator_listbase_next",
935 "rna_iterator_listbase_end",
936 "rna_iterator_listbase_get",
937 NULL,
938 NULL,
939 NULL,
940 NULL);
941
942 prop = RNA_def_property(srna, "views", PROP_COLLECTION, PROP_NONE);
943 RNA_def_property_struct_type(prop, "RenderView");
944 RNA_def_property_collection_funcs(prop,
945 "rna_RenderResult_views_begin",
946 "rna_iterator_listbase_next",
947 "rna_iterator_listbase_end",
948 "rna_iterator_listbase_get",
949 NULL,
950 NULL,
951 NULL,
952 NULL);
953
954 RNA_define_verify_sdna(1);
955 }
956
rna_def_render_view(BlenderRNA * brna)957 static void rna_def_render_view(BlenderRNA *brna)
958 {
959 StructRNA *srna;
960 PropertyRNA *prop;
961
962 srna = RNA_def_struct(brna, "RenderView", NULL);
963 RNA_def_struct_ui_text(srna, "Render View", "");
964
965 RNA_define_verify_sdna(0);
966
967 prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
968 RNA_def_property_string_sdna(prop, NULL, "name");
969 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
970 RNA_def_struct_name_property(srna, prop);
971
972 RNA_define_verify_sdna(1);
973 }
974
rna_def_render_passes(BlenderRNA * brna,PropertyRNA * cprop)975 static void rna_def_render_passes(BlenderRNA *brna, PropertyRNA *cprop)
976 {
977 StructRNA *srna;
978
979 FunctionRNA *func;
980 PropertyRNA *parm;
981
982 RNA_def_property_srna(cprop, "RenderPasses");
983 srna = RNA_def_struct(brna, "RenderPasses", NULL);
984 RNA_def_struct_sdna(srna, "RenderLayer");
985 RNA_def_struct_ui_text(srna, "Render Passes", "Collection of render passes");
986
987 func = RNA_def_function(srna, "find_by_type", "rna_RenderPass_find_by_type");
988 RNA_def_function_ui_description(func, "Get the render pass for a given type and view");
989 parm = RNA_def_enum(
990 func, "pass_type", rna_enum_render_pass_type_items, SCE_PASS_COMBINED, "Pass", "");
991 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
992 parm = RNA_def_string(
993 func, "view", NULL, 0, "View", "Render view to get pass from"); /* NULL ok here */
994 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
995 parm = RNA_def_pointer(func, "render_pass", "RenderPass", "", "The matching render pass");
996 RNA_def_function_return(func, parm);
997
998 func = RNA_def_function(srna, "find_by_name", "rna_RenderPass_find_by_name");
999 RNA_def_function_ui_description(func, "Get the render pass for a given name and view");
1000 parm = RNA_def_string(func, "name", RE_PASSNAME_COMBINED, 0, "Pass", "");
1001 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1002 parm = RNA_def_string(
1003 func, "view", NULL, 0, "View", "Render view to get pass from"); /* NULL ok here */
1004 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1005 parm = RNA_def_pointer(func, "render_pass", "RenderPass", "", "The matching render pass");
1006 RNA_def_function_return(func, parm);
1007 }
1008
rna_def_render_layer(BlenderRNA * brna)1009 static void rna_def_render_layer(BlenderRNA *brna)
1010 {
1011 StructRNA *srna;
1012 PropertyRNA *prop;
1013
1014 FunctionRNA *func;
1015 PropertyRNA *parm;
1016
1017 srna = RNA_def_struct(brna, "RenderLayer", NULL);
1018 RNA_def_struct_ui_text(srna, "Render Layer", "");
1019
1020 func = RNA_def_function(srna, "load_from_file", "RE_layer_load_from_file");
1021 RNA_def_function_ui_description(func,
1022 "Copies the pixels of this renderlayer from an image file");
1023 RNA_def_function_flag(func, FUNC_USE_REPORTS);
1024 parm = RNA_def_string(
1025 func,
1026 "filename",
1027 NULL,
1028 0,
1029 "Filename",
1030 "Filename to load into this render tile, must be no smaller than the renderlayer");
1031 RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1032 RNA_def_int(func,
1033 "x",
1034 0,
1035 0,
1036 INT_MAX,
1037 "Offset X",
1038 "Offset the position to copy from if the image is larger than the render layer",
1039 0,
1040 INT_MAX);
1041 RNA_def_int(func,
1042 "y",
1043 0,
1044 0,
1045 INT_MAX,
1046 "Offset Y",
1047 "Offset the position to copy from if the image is larger than the render layer",
1048 0,
1049 INT_MAX);
1050
1051 RNA_define_verify_sdna(0);
1052
1053 rna_def_view_layer_common(srna, false);
1054
1055 prop = RNA_def_property(srna, "passes", PROP_COLLECTION, PROP_NONE);
1056 RNA_def_property_struct_type(prop, "RenderPass");
1057 RNA_def_property_collection_funcs(prop,
1058 "rna_RenderLayer_passes_begin",
1059 "rna_iterator_listbase_next",
1060 "rna_iterator_listbase_end",
1061 "rna_iterator_listbase_get",
1062 NULL,
1063 NULL,
1064 NULL,
1065 NULL);
1066 rna_def_render_passes(brna, prop);
1067
1068 RNA_define_verify_sdna(1);
1069 }
1070
rna_def_render_pass(BlenderRNA * brna)1071 static void rna_def_render_pass(BlenderRNA *brna)
1072 {
1073 StructRNA *srna;
1074 PropertyRNA *prop;
1075
1076 srna = RNA_def_struct(brna, "RenderPass", NULL);
1077 RNA_def_struct_ui_text(srna, "Render Pass", "");
1078
1079 RNA_define_verify_sdna(0);
1080
1081 prop = RNA_def_property(srna, "fullname", PROP_STRING, PROP_NONE);
1082 RNA_def_property_string_sdna(prop, NULL, "fullname");
1083 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1084 RNA_def_struct_name_property(srna, prop);
1085
1086 prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
1087 RNA_def_property_string_sdna(prop, NULL, "name");
1088 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1089 RNA_def_struct_name_property(srna, prop);
1090
1091 prop = RNA_def_property(srna, "channel_id", PROP_STRING, PROP_NONE);
1092 RNA_def_property_string_sdna(prop, NULL, "chan_id");
1093 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1094
1095 prop = RNA_def_property(srna, "channels", PROP_INT, PROP_NONE);
1096 RNA_def_property_int_sdna(prop, NULL, "channels");
1097 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1098
1099 prop = RNA_def_property(srna, "rect", PROP_FLOAT, PROP_NONE);
1100 RNA_def_property_flag(prop, PROP_DYNAMIC);
1101 RNA_def_property_multi_array(prop, 2, NULL);
1102 RNA_def_property_dynamic_array_funcs(prop, "rna_RenderPass_rect_get_length");
1103 RNA_def_property_float_funcs(prop, "rna_RenderPass_rect_get", "rna_RenderPass_rect_set", NULL);
1104
1105 prop = RNA_def_property(srna, "view_id", PROP_INT, PROP_NONE);
1106 RNA_def_property_int_sdna(prop, NULL, "view_id");
1107 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1108
1109 RNA_define_verify_sdna(1);
1110 }
1111
RNA_def_render(BlenderRNA * brna)1112 void RNA_def_render(BlenderRNA *brna)
1113 {
1114 rna_def_render_engine(brna);
1115 rna_def_render_result(brna);
1116 rna_def_render_view(brna);
1117 rna_def_render_layer(brna);
1118 rna_def_render_pass(brna);
1119 }
1120
1121 #endif /* RNA_RUNTIME */
1122