Blender V5.3
rna_render.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstdlib>
10
11#include "DNA_node_types.h"
12#include "DNA_scene_types.h"
13
14#include "BLI_path_utils.hh"
15
16#ifdef WITH_PYTHON
17# include "BPY_extern.hh"
18#endif
19
20#include "RNA_define.hh"
21#include "RNA_enum_types.hh"
22
23#include "rna_internal.hh"
24
25#include "UI_interface_c.hh"
26
27#include "RE_engine.h"
28
29namespace blender {
30
32 {SCE_PASS_COMBINED, "COMBINED", 0, "Combined", ""},
33 {SCE_PASS_AO, "AO", 0, "Ambient Occlusion", ""},
34 {SCE_PASS_SHADOW, "SHADOW", 0, "Shadow", ""},
35 {SCE_PASS_POSITION, "POSITION", 0, "Position", ""},
36 {SCE_PASS_NORMAL, "NORMAL", 0, "Normal", ""},
37 {SCE_PASS_UV, "UV", 0, "UV", ""},
38 {int(SCE_PASS_ROUGHNESS), "ROUGHNESS", 0, "ROUGHNESS", ""},
39 {SCE_PASS_EMIT, "EMIT", 0, "Emission", ""},
40 {SCE_PASS_ENVIRONMENT, "ENVIRONMENT", 0, "Environment", ""},
41 {SCE_PASS_DIFFUSE_COLOR, "DIFFUSE", 0, "Diffuse", ""},
42 {SCE_PASS_GLOSSY_COLOR, "GLOSSY", 0, "Glossy", ""},
43 {SCE_PASS_TRANSM_COLOR, "TRANSMISSION", 0, "Transmission", ""},
44 {0, nullptr, 0, nullptr, nullptr},
45};
46
47}
48
49#ifdef RNA_RUNTIME
50
51# include "MEM_guardedalloc.h"
52
53# include "RNA_access.hh"
54
55# include "BKE_appdir.hh"
56# include "BKE_context.hh"
57# include "BKE_image.hh"
58# include "BKE_report.hh"
59# include "BKE_scene.hh"
60
61# include "GPU_capabilities.hh"
62# include "GPU_shader.hh"
63# include "IMB_colormanagement.hh"
64# include "IMB_imbuf_types.hh"
65
66# include "DEG_depsgraph_query.hh"
67
68# include "ED_render.hh"
69
70namespace blender {
71
72/* RenderEngine Callbacks */
73
74static void engine_tag_redraw(RenderEngine *engine)
75{
76 engine->flag |= RE_ENGINE_DO_DRAW;
77}
78
79static void engine_tag_update(RenderEngine *engine)
80{
81 engine->flag |= RE_ENGINE_DO_UPDATE;
82}
83
84static bool engine_support_display_space_shader(RenderEngine * /*engine*/, Scene * /*scene*/)
85{
86 return true;
87}
88
89static int engine_get_preview_pixel_size(RenderEngine * /*engine*/, Scene *scene)
90{
91 return BKE_render_preview_pixel_size(&scene->r);
92}
93
94static void engine_bind_display_space_shader(RenderEngine * /*engine*/, Scene * /*scene*/)
95{
99}
100
101static void engine_unbind_display_space_shader(RenderEngine * /*engine*/)
102{
104}
105
106static void engine_update(RenderEngine *engine, Main *bmain, Depsgraph *depsgraph)
107{
108 extern FunctionRNA *rna_RenderEngine_update_func;
110 FunctionRNA *func;
111
112 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
113 func = rna_RenderEngine_update_func;
114
115 RNA_parameter_list_create(&list, &ptr, func);
116 RNA_parameter_set_lookup(&list, "data", &bmain);
117 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
118 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
119
121}
122
123static void engine_render(RenderEngine *engine, Depsgraph *depsgraph)
124{
125 extern FunctionRNA *rna_RenderEngine_render_func;
127 FunctionRNA *func;
128
129 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
130 func = rna_RenderEngine_render_func;
131
132 RNA_parameter_list_create(&list, &ptr, func);
133 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
134 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
135
137}
138
139static void engine_render_frame_finish(RenderEngine *engine)
140{
141 extern FunctionRNA *rna_RenderEngine_render_frame_finish_func;
143 FunctionRNA *func;
144
145 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
146 func = rna_RenderEngine_render_frame_finish_func;
147
148 RNA_parameter_list_create(&list, &ptr, func);
149 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
150
152}
153
154static void engine_draw(RenderEngine *engine, const bContext *context, Depsgraph *depsgraph)
155{
156 extern FunctionRNA *rna_RenderEngine_draw_func;
158 FunctionRNA *func;
159
160 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
161 func = rna_RenderEngine_draw_func;
162
163 RNA_parameter_list_create(&list, &ptr, func);
164 RNA_parameter_set_lookup(&list, "context", &context);
165 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
166 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
167
169}
170
171static void engine_bake(RenderEngine *engine,
172 Depsgraph *depsgraph,
173 Object *object,
174 const int pass_type,
175 const int pass_filter,
176 const int width,
177 const int height)
178{
179 extern FunctionRNA *rna_RenderEngine_bake_func;
181 FunctionRNA *func;
182
183 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
184 func = rna_RenderEngine_bake_func;
185
186 RNA_parameter_list_create(&list, &ptr, func);
187 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
188 RNA_parameter_set_lookup(&list, "object", &object);
189 RNA_parameter_set_lookup(&list, "pass_type", &pass_type);
190 RNA_parameter_set_lookup(&list, "pass_filter", &pass_filter);
191 RNA_parameter_set_lookup(&list, "width", &width);
192 RNA_parameter_set_lookup(&list, "height", &height);
193 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
194
196}
197
198static void engine_view_update(RenderEngine *engine, const bContext *context, Depsgraph *depsgraph)
199{
200 extern FunctionRNA *rna_RenderEngine_view_update_func;
202 FunctionRNA *func;
203
204 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
205 func = rna_RenderEngine_view_update_func;
206
207 RNA_parameter_list_create(&list, &ptr, func);
208 RNA_parameter_set_lookup(&list, "context", &context);
209 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
210 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
211
213}
214
215static void engine_view_pause(RenderEngine *engine, const bContext *context)
216{
217 extern FunctionRNA *rna_RenderEngine_view_pause_func;
219 FunctionRNA *func;
220
221 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
222 func = rna_RenderEngine_view_pause_func;
223
224 RNA_parameter_list_create(&list, &ptr, func);
225 RNA_parameter_set_lookup(&list, "context", &context);
226 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
227
229}
230
231static void engine_view_resume(RenderEngine *engine, const bContext *context)
232{
233 extern FunctionRNA *rna_RenderEngine_view_resume_func;
235 FunctionRNA *func;
236
237 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
238 func = rna_RenderEngine_view_resume_func;
239
240 RNA_parameter_list_create(&list, &ptr, func);
241 RNA_parameter_set_lookup(&list, "context", &context);
242 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
243
245}
246
247static void engine_view_draw(RenderEngine *engine, const bContext *context, Depsgraph *depsgraph)
248{
249 extern FunctionRNA *rna_RenderEngine_view_draw_func;
251 FunctionRNA *func;
252
253 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
254 func = rna_RenderEngine_view_draw_func;
255
256 RNA_parameter_list_create(&list, &ptr, func);
257 RNA_parameter_set_lookup(&list, "context", &context);
258 RNA_parameter_set_lookup(&list, "depsgraph", &depsgraph);
259 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
260
262}
263
264static void engine_update_script_node(RenderEngine *engine, bNodeTree *ntree, bNode *node)
265{
266 extern FunctionRNA *rna_RenderEngine_update_script_node_func;
268 FunctionRNA *func;
269
270 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
271 PointerRNA nodeptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_Node, node);
272 func = rna_RenderEngine_update_script_node_func;
273
274 RNA_parameter_list_create(&list, &ptr, func);
275 RNA_parameter_set_lookup(&list, "node", &nodeptr);
276 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
277
279}
280
281static void engine_update_render_passes(RenderEngine *engine, Scene *scene, ViewLayer *view_layer)
282{
283 extern FunctionRNA *rna_RenderEngine_update_render_passes_func;
285 FunctionRNA *func;
286
287 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
288 func = rna_RenderEngine_update_render_passes_func;
289
290 RNA_parameter_list_create(&list, &ptr, func);
291 RNA_parameter_set_lookup(&list, "scene", &scene);
292 RNA_parameter_set_lookup(&list, "renderlayer", &view_layer);
293 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
294
296}
297
298static void engine_update_custom_camera(RenderEngine *engine, Camera *cam)
299{
300 extern FunctionRNA *rna_RenderEngine_update_custom_camera_func;
302 FunctionRNA *func;
303
304 PointerRNA ptr = RNA_pointer_create_discrete(nullptr, engine->type->rna_ext.srna, engine);
305 func = rna_RenderEngine_update_custom_camera_func;
306
307 RNA_parameter_list_create(&list, &ptr, func);
308 RNA_parameter_set_lookup(&list, "cam", &cam);
309 engine->type->rna_ext.call(nullptr, &ptr, func, &list);
310
312}
313
314/* RenderEngine registration */
315
316static bool rna_RenderEngine_unregister(Main *bmain, StructRNA *type)
317{
319
320 if (!et) {
321 return false;
322 }
324
325 /* Stop all renders in case we were using this one. */
326 ED_render_engine_changed(bmain, false);
328
329 RNA_struct_free_extension(type, &et->rna_ext);
332 return true;
333}
334
335static StructRNA *rna_RenderEngine_register(Main *bmain,
336 ReportList *reports,
337 void *data,
338 const char *identifier,
339 StructValidateFunc validate,
342{
343 const char *error_prefix = "Registering render engine class:";
344 RenderEngineType *et, dummy_et = {nullptr};
345 RenderEngine dummy_engine = {nullptr};
346 bool have_function[12];
347
348 /* setup dummy engine & engine type to store static properties in */
349 dummy_engine.type = &dummy_et;
351 PointerRNA dummy_engine_ptr = RNA_pointer_create_discrete(
352 nullptr, RNA_RenderEngine, &dummy_engine);
353
354 /* validate the python class */
355 if (validate(&dummy_engine_ptr, data, have_function) != 0) {
356 return nullptr;
357 }
358
359 if (strlen(identifier) >= sizeof(dummy_et.idname)) {
360 BKE_reportf(reports,
361 RPT_ERROR,
362 "%s '%s' is too long, maximum length is %d",
363 error_prefix,
364 identifier,
365 int(sizeof(dummy_et.idname)));
366 return nullptr;
367 }
368
369 /* Check if we have registered this engine type before, and remove it. */
370 et = static_cast<RenderEngineType *>(
371 BLI_findstring(&R_engines, dummy_et.idname, offsetof(RenderEngineType, idname)));
372 if (et) {
373 BKE_reportf(reports,
374 RPT_INFO,
375 "%s '%s', bl_idname '%s' has been registered before, unregistering previous",
376 error_prefix,
377 identifier,
378 dummy_et.idname);
379
380 StructRNA *srna = et->rna_ext.srna;
381 if (!(srna && rna_RenderEngine_unregister(bmain, srna))) {
382 BKE_reportf(reports,
383 RPT_ERROR,
384 "%s '%s', bl_idname '%s' %s",
385 error_prefix,
386 identifier,
387 dummy_et.idname,
388 srna ? "is built-in" : "could not be unregistered");
389 return nullptr;
390 }
391 }
392
393 /* create a new engine type */
394 et = MEM_new_uninitialized<RenderEngineType>("Python render engine");
395 memcpy(et, &dummy_et, sizeof(dummy_et));
396
397 et->rna_ext.srna = RNA_def_struct_ptr(&RNA_blender_rna_get(), et->idname, RNA_RenderEngine);
398 et->rna_ext.data = data;
399 et->rna_ext.call = call;
400 et->rna_ext.free = free;
401 RNA_struct_blender_type_set(et->rna_ext.srna, et);
402
403 et->update = (have_function[0]) ? engine_update : nullptr;
404 et->render = (have_function[1]) ? engine_render : nullptr;
405 et->render_frame_finish = (have_function[2]) ? engine_render_frame_finish : nullptr;
406 et->draw = (have_function[3]) ? engine_draw : nullptr;
407 et->bake = (have_function[4]) ? engine_bake : nullptr;
408 et->view_update = (have_function[5]) ? engine_view_update : nullptr;
409 et->view_draw = (have_function[6]) ? engine_view_draw : nullptr;
410 et->view_pause = (have_function[7]) ? engine_view_pause : nullptr;
411 et->view_resume = (have_function[8]) ? engine_view_resume : nullptr;
412 et->update_script_node = (have_function[9]) ? engine_update_script_node : nullptr;
413 et->update_render_passes = (have_function[10]) ? engine_update_render_passes : nullptr;
414 et->update_custom_camera = (have_function[11]) ? engine_update_custom_camera : nullptr;
415
417
418 return et->rna_ext.srna;
419}
420
421static void **rna_RenderEngine_instance(PointerRNA *ptr)
422{
423 RenderEngine *engine = static_cast<RenderEngine *>(ptr->data);
424 return &engine->py_instance;
425}
426
427static StructRNA *rna_RenderEngine_refine(PointerRNA *ptr)
428{
429 RenderEngine *engine = static_cast<RenderEngine *>(ptr->data);
430 return (engine->type && engine->type->rna_ext.srna) ? engine->type->rna_ext.srna :
431 RNA_RenderEngine;
432}
433
434static void rna_RenderEngine_tempdir_get(PointerRNA * /*ptr*/, char *value)
435{
436 strcpy(value, BKE_tempdir_session());
437}
438
439static int rna_RenderEngine_tempdir_length(PointerRNA * /*ptr*/)
440{
441 return strlen(BKE_tempdir_session());
442}
443
444static PointerRNA rna_RenderEngine_render_get(PointerRNA *ptr)
445{
446 RenderEngine *engine = static_cast<RenderEngine *>(ptr->data);
447
448 if (engine->re) {
449 RenderData *r = RE_engine_get_render_data(engine->re);
450
451 return RNA_pointer_create_with_parent(*ptr, RNA_RenderSettings, r);
452 }
453 return {};
454}
455
456static PointerRNA rna_RenderEngine_camera_override_get(PointerRNA *ptr)
457{
458 RenderEngine *engine = static_cast<RenderEngine *>(ptr->data);
459 /* TODO(sergey): Shouldn't engine point to an evaluated datablocks already? */
460 if (engine->re) {
461 Object *cam = RE_GetCamera(engine->re);
462 Object *cam_eval = DEG_get_evaluated(engine->depsgraph, cam);
463 return RNA_id_pointer_create(reinterpret_cast<ID *>(cam_eval));
464 }
465 else {
466 return RNA_id_pointer_create(reinterpret_cast<ID *>(engine->camera_override));
467 }
468}
469
470static void rna_RenderEngine_engine_frame_set(RenderEngine *engine, int frame, float subframe)
471{
472# ifdef WITH_PYTHON
474# endif
475
476 RE_engine_frame_set(engine, frame, subframe);
477
478# ifdef WITH_PYTHON
480# endif
481}
482
483static void rna_RenderResult_views_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
484{
485 RenderResult *rr = static_cast<RenderResult *>(ptr->data);
486 rna_iterator_listbase_begin(iter, ptr, &rr->views, nullptr);
487}
488
489static void rna_RenderResult_layers_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
490{
491 RenderResult *rr = static_cast<RenderResult *>(ptr->data);
492 rna_iterator_listbase_begin(iter, ptr, &rr->layers, nullptr);
493}
494
495static void rna_RenderResult_stamp_data_add_field(RenderResult *rr,
496 const char *field,
497 const char *value)
498{
499 BKE_render_result_stamp_data(rr, field, value);
500}
501
502static void rna_RenderLayer_passes_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
503{
504 RenderLayer *rl = static_cast<RenderLayer *>(ptr->data);
505 rna_iterator_listbase_begin(iter, ptr, &rl->passes, nullptr);
506}
507
508static int rna_RenderPass_rect_get_length(const PointerRNA *ptr,
510{
511 const RenderPass *rpass = static_cast<RenderPass *>(ptr->data);
512
513 length[0] = rpass->rectx * rpass->recty;
514 length[1] = rpass->channels;
515
516 return length[0] * length[1];
517}
518
519static void rna_RenderPass_rect_get(PointerRNA *ptr, float *values)
520{
521 RenderPass *rpass = static_cast<RenderPass *>(ptr->data);
522 const size_t size_in_bytes = sizeof(float) * rpass->rectx * rpass->recty * rpass->channels;
523 const float *buffer = rpass->ibuf ? rpass->ibuf->float_data() : nullptr;
524
525 if (!buffer) {
526 /* No float buffer to read from, initialize to all zeroes. */
527 memset(values, 0, size_in_bytes);
528 return;
529 }
530
531 memcpy(values, buffer, size_in_bytes);
532}
533
534void rna_RenderPass_rect_set(PointerRNA *ptr, const float *values)
535{
536 RenderPass *rpass = static_cast<RenderPass *>(ptr->data);
537 float *buffer = rpass->ibuf ? rpass->ibuf->float_data_for_write() : nullptr;
538
539 if (!buffer) {
540 /* Only writing to an already existing buffer is supported. */
541 return;
542 }
543
544 const size_t size_in_bytes = sizeof(float) * rpass->rectx * rpass->recty * rpass->channels;
545 memcpy(buffer, values, size_in_bytes);
546}
547
548static RenderPass *rna_RenderPass_find_by_name(RenderLayer *rl, const char *name, const char *view)
549{
550 return RE_pass_find_by_name(rl, name, view);
551}
552
553} // namespace blender
554
555#else /* RNA_RUNTIME */
556
557namespace blender {
558
560{
561 StructRNA *srna;
562 PropertyRNA *prop;
563
564 FunctionRNA *func;
565 PropertyRNA *parm;
566
567 static const EnumPropertyItem render_pass_type_items[] = {
568 {SOCK_FLOAT, "VALUE", 0, "Value", ""},
569 {SOCK_VECTOR, "VECTOR", 0, "Vector", ""},
570 {SOCK_RGBA, "COLOR", 0, "Color", ""},
571 {0, nullptr, 0, nullptr, nullptr},
572 };
573
574 srna = RNA_def_struct(brna, "RenderEngine", nullptr);
575 RNA_def_struct_sdna(srna, "RenderEngine");
576 RNA_def_struct_ui_text(srna, "Render Engine", "Render engine");
577 RNA_def_struct_refine_func(srna, "rna_RenderEngine_refine");
579 "rna_RenderEngine_register",
580 "rna_RenderEngine_unregister",
581 "rna_RenderEngine_instance");
582
583 /* final render callbacks */
584 func = RNA_def_function(srna, "update", nullptr);
585 RNA_def_function_ui_description(func, "Export scene data for render");
587 RNA_def_pointer(func, "data", "BlendData", "", "");
588 RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "");
589
590 func = RNA_def_function(srna, "render", nullptr);
591 RNA_def_function_ui_description(func, "Render scene into an image");
593 parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "Evaluated dependency graph");
595
596 func = RNA_def_function(srna, "render_frame_finish", nullptr);
598 func, "Perform finishing operations after all view layers in a frame were rendered");
600
601 func = RNA_def_function(srna, "draw", nullptr);
602 RNA_def_function_ui_description(func, "Draw render image");
604 parm = RNA_def_pointer(func, "context", "Context", "", "The context");
606 parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "Evaluated dependency graph");
608
609 func = RNA_def_function(srna, "bake", nullptr);
610 RNA_def_function_ui_description(func, "Bake passes");
612 parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "Evaluated dependency graph");
614 parm = RNA_def_pointer(func, "object", "Object", "", "Object to bake");
616 parm = RNA_def_enum(func, "pass_type", rna_enum_bake_pass_type_items, 0, "Pass", "Pass to bake");
618 parm = RNA_def_int(func,
619 "pass_filter",
620 0,
621 0,
622 INT_MAX,
623 "Pass Filter",
624 "Filter to combined, diffuse, glossy and transmission passes",
625 0,
626 INT_MAX);
628 parm = RNA_def_int(func, "width", 0, 0, INT_MAX, "Width", "Image width", 0, INT_MAX);
630 parm = RNA_def_int(func, "height", 0, 0, INT_MAX, "Height", "Image height", 0, INT_MAX);
632
633 /* viewport render callbacks */
634 func = RNA_def_function(srna, "view_update", nullptr);
635 RNA_def_function_ui_description(func, "Update on data changes for viewport render");
637 parm = RNA_def_pointer(func, "context", "Context", "", "The context");
639 parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "Evaluated dependency graph");
641
642 func = RNA_def_function(srna, "view_draw", nullptr);
643 RNA_def_function_ui_description(func, "Draw viewport render");
645 parm = RNA_def_pointer(func, "context", "Context", "", "The context");
647 parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "", "Evaluated dependency graph");
649
650 func = RNA_def_function(srna, "view_pause", nullptr);
651 RNA_def_function_ui_description(func, "Pause viewport render");
653 parm = RNA_def_pointer(func, "context", "Context", "", "The context");
655
656 func = RNA_def_function(srna, "view_resume", nullptr);
657 RNA_def_function_ui_description(func, "Resume viewport render");
659 parm = RNA_def_pointer(func, "context", "Context", "", "The context");
661
662 /* shader script callbacks */
663 func = RNA_def_function(srna, "update_script_node", nullptr);
664 RNA_def_function_ui_description(func, "Compile shader script node");
666 parm = RNA_def_pointer(func, "node", "Node", "", "");
668
669 func = RNA_def_function(srna, "update_render_passes", nullptr);
670 RNA_def_function_ui_description(func, "Update the render passes that will be generated");
672 parm = RNA_def_pointer(func, "scene", "Scene", "", "");
673 parm = RNA_def_pointer(func, "renderlayer", "ViewLayer", "", "");
674
675 func = RNA_def_function(srna, "update_custom_camera", nullptr);
676 RNA_def_function_ui_description(func, "Compile custom camera");
678 parm = RNA_def_pointer(func, "cam", "Camera", "", "");
679
680 /* tag for redraw */
681 func = RNA_def_function(srna, "tag_redraw", "engine_tag_redraw");
682 RNA_def_function_ui_description(func, "Request redraw for viewport rendering");
683
684 /* tag for update */
685 func = RNA_def_function(srna, "tag_update", "engine_tag_update");
686 RNA_def_function_ui_description(func, "Request update call for viewport rendering");
687
688 func = RNA_def_function(srna, "begin_result", "RE_engine_begin_result");
690 func, "Create render result to write linear floating-point render layers and passes");
691 parm = RNA_def_int(func, "x", 0, 0, INT_MAX, "X", "", 0, INT_MAX);
693 parm = RNA_def_int(func, "y", 0, 0, INT_MAX, "Y", "", 0, INT_MAX);
695 parm = RNA_def_int(func, "w", 0, 0, INT_MAX, "Width", "", 0, INT_MAX);
697 parm = RNA_def_int(func, "h", 0, 0, INT_MAX, "Height", "", 0, INT_MAX);
699 RNA_def_string(func,
700 "layer",
701 nullptr,
702 0,
703 "Layer",
704 "Single layer to get render result for"); /* nullptr ok here */
705 RNA_def_string(func,
706 "view",
707 nullptr,
708 0,
709 "View",
710 "Single view to get render result for"); /* nullptr ok here */
711 parm = RNA_def_pointer(func, "result", "RenderResult", "Result", "");
712 RNA_def_function_return(func, parm);
713
714 func = RNA_def_function(srna, "update_result", "RE_engine_update_result");
716 func, "Signal that pixels have been updated and can be redrawn in the user interface");
717 parm = RNA_def_pointer(func, "result", "RenderResult", "Result", "");
719
720 func = RNA_def_function(srna, "end_result", "RE_engine_end_result");
722 "All pixels in the render result have been set and are final");
723 parm = RNA_def_pointer(func, "result", "RenderResult", "Result", "");
725 RNA_def_boolean(func,
726 "cancel",
727 false,
728 "Cancel",
729 "Don't mark tile as done, don't merge results unless forced");
730 RNA_def_boolean(func, "highlight", false, "Highlight", "Don't mark tile as done yet");
732 func, "do_merge_results", false, "Merge Results", "Merge results even if cancel=true");
733
734 func = RNA_def_function(srna, "add_pass", "RE_engine_add_pass");
735 RNA_def_function_ui_description(func, "Add a pass to the render layer");
736 parm = RNA_def_string(
737 func, "name", nullptr, 0, "Name", "Name of the Pass, without view or channel tag");
739 parm = RNA_def_int(func, "channels", 0, 0, INT_MAX, "Channels", "", 0, INT_MAX);
741 parm = RNA_def_string(
742 func, "chan_id", nullptr, 0, "Channel IDs", "Channel names, one character per channel");
744 RNA_def_string(func,
745 "layer",
746 nullptr,
747 0,
748 "Layer",
749 "Single layer to add render pass to"); /* nullptr ok here */
750
751 func = RNA_def_function(srna, "get_result", "RE_engine_get_result");
752 RNA_def_function_ui_description(func, "Get final result for non-pixel operations");
753 parm = RNA_def_pointer(func, "result", "RenderResult", "Result", "");
754 RNA_def_function_return(func, parm);
755
756 func = RNA_def_function(srna, "test_break", "RE_engine_test_break");
758 "Test if the render operation should been canceled, this is a "
759 "fast call that should be used regularly for responsiveness");
760 parm = RNA_def_boolean(func, "do_break", false, "Break", "");
761 RNA_def_function_return(func, parm);
762
763 func = RNA_def_function(srna, "pass_by_index_get", "RE_engine_pass_by_index_get");
764 parm = RNA_def_string(
765 func, "layer", nullptr, 0, "Layer", "Name of render layer to get pass for");
767 parm = RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "Index of pass to get", 0, INT_MAX);
769 parm = RNA_def_pointer(func, "render_pass", "RenderPass", "Index", "Index of pass to get");
770 RNA_def_function_return(func, parm);
771
772 func = RNA_def_function(srna, "active_view_get", "RE_engine_active_view_get");
773 parm = RNA_def_string(func, "view", nullptr, 0, "View", "Single view active");
774 RNA_def_function_return(func, parm);
775
776 func = RNA_def_function(srna, "active_view_set", "RE_engine_active_view_set");
777 parm = RNA_def_string(
778 func, "view", nullptr, 0, "View", "Single view to set as active"); /* nullptr ok here */
780
781 func = RNA_def_function(srna, "camera_shift_x", "RE_engine_get_camera_shift_x");
782 parm = RNA_def_pointer(func, "camera", "Object", "", "Camera object");
784 RNA_def_boolean(func, "use_spherical_stereo", false, "Spherical Stereo", "");
785 parm = RNA_def_float(func, "shift_x", 0.0f, 0.0f, FLT_MAX, "Shift X", "", 0.0f, FLT_MAX);
786 RNA_def_function_return(func, parm);
787
788 func = RNA_def_function(srna, "camera_model_matrix", "RE_engine_get_camera_model_matrix");
789 parm = RNA_def_pointer(func, "camera", "Object", "", "Camera object");
791 RNA_def_boolean(func, "use_spherical_stereo", false, "Spherical Stereo", "");
792 parm = RNA_def_float_matrix(func,
793 "r_model_matrix",
794 4,
795 4,
796 nullptr,
797 0.0f,
798 0.0f,
799 "Model Matrix",
800 "Normalized camera model matrix",
801 0.0f,
802 0.0f);
804 RNA_def_function_output(func, parm);
805
806 func = RNA_def_function(srna, "use_spherical_stereo", "RE_engine_get_spherical_stereo");
807 parm = RNA_def_pointer(func, "camera", "Object", "", "Camera object");
809 parm = RNA_def_boolean(func, "use_spherical_stereo", false, "Spherical Stereo", "");
810 RNA_def_function_return(func, parm);
811
812 func = RNA_def_function(srna, "update_stats", "RE_engine_update_stats");
813 RNA_def_function_ui_description(func, "Update and signal to redraw render status text");
814 parm = RNA_def_string(func, "stats", nullptr, 0, "Stats", "");
816 parm = RNA_def_string(func, "info", nullptr, 0, "Info", "");
818
819 func = RNA_def_function(srna, "frame_set", "rna_RenderEngine_engine_frame_set");
820 RNA_def_function_ui_description(func, "Evaluate scene at a different frame (for motion blur)");
821 parm = RNA_def_int(func, "frame", 0, INT_MIN, INT_MAX, "Frame", "", INT_MIN, INT_MAX);
823 parm = RNA_def_float(func, "subframe", 0.0f, 0.0f, 1.0f, "Subframe", "", 0.0f, 1.0f);
825
826 func = RNA_def_function(srna, "update_progress", "RE_engine_update_progress");
827 RNA_def_function_ui_description(func, "Update progress percentage of render");
828 parm = RNA_def_float(
829 func, "progress", 0, 0.0f, 1.0f, "", "Percentage of render that's done", 0.0f, 1.0f);
831
832 func = RNA_def_function(srna, "update_memory_stats", "RE_engine_update_memory_stats");
833 RNA_def_function_ui_description(func, "Update memory usage statistics");
834 RNA_def_float(func,
835 "memory_used",
836 0,
837 0.0f,
838 FLT_MAX,
839 "",
840 "Current memory usage in megabytes",
841 0.0f,
842 FLT_MAX);
844 func, "memory_peak", 0, 0.0f, FLT_MAX, "", "Peak memory usage in megabytes", 0.0f, FLT_MAX);
845
846 func = RNA_def_function(srna, "report", "RE_engine_report");
847 RNA_def_function_ui_description(func, "Report info, warning or error messages");
848 parm = RNA_def_enum_flag(func, "type", rna_enum_wm_report_items, 0, "Type", "");
850 parm = RNA_def_string(func, "message", nullptr, 0, "Report Message", "");
852
853 func = RNA_def_function(srna, "error_set", "RE_engine_set_error_message");
855 "Set error message displaying after the render is finished");
856 parm = RNA_def_string(func, "message", nullptr, 0, "Report Message", "");
858
859 func = RNA_def_function(srna, "bind_display_space_shader", "engine_bind_display_space_shader");
861 "Bind GLSL fragment shader that converts linear colors to "
862 "display space colors using scene color management settings");
863 parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene whose color management is used");
865
866 func = RNA_def_function(
867 srna, "unbind_display_space_shader", "engine_unbind_display_space_shader");
869 func, "Unbind GLSL display space shader, must always be called after binding the shader");
870
871 func = RNA_def_function(
872 srna, "support_display_space_shader", "engine_support_display_space_shader");
874 "Test if GLSL display space shader is supported for the "
875 "combination of graphics card and scene settings");
876 parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene whose color management is used");
878 parm = RNA_def_boolean(func, "supported", false, "Supported", "");
879 RNA_def_function_return(func, parm);
880
881 func = RNA_def_function(srna, "get_preview_pixel_size", "engine_get_preview_pixel_size");
883 "Get the pixel size that should be used for preview rendering");
884 parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene whose preview settings are used");
886 parm = RNA_def_int(func, "pixel_size", 0, 1, 8, "Pixel Size", "", 1, 8);
887 RNA_def_function_return(func, parm);
888
889 func = RNA_def_function(srna, "free_blender_memory", "RE_engine_free_blender_memory");
890 RNA_def_function_ui_description(func, "Free Blender side memory of render engine");
891
892 func = RNA_def_function(srna, "tile_highlight_set", "RE_engine_tile_highlight_set");
893 RNA_def_function_ui_description(func, "Set highlighted state of the given tile");
894 parm = RNA_def_int(func, "x", 0, 0, INT_MAX, "X", "", 0, INT_MAX);
896 parm = RNA_def_int(func, "y", 0, 0, INT_MAX, "Y", "", 0, INT_MAX);
898 parm = RNA_def_int(func, "width", 0, 0, INT_MAX, "Width", "", 0, INT_MAX);
900 parm = RNA_def_int(func, "height", 0, 0, INT_MAX, "Height", "", 0, INT_MAX);
902 parm = RNA_def_boolean(func, "highlight", false, "Highlight", "");
904
905 func = RNA_def_function(srna, "tile_highlight_clear_all", "RE_engine_tile_highlight_clear_all");
906 RNA_def_function_ui_description(func, "Clear highlight from all tiles");
907
909
910 prop = RNA_def_property(srna, "is_animation", PROP_BOOLEAN, PROP_NONE);
912
913 prop = RNA_def_property(srna, "is_preview", PROP_BOOLEAN, PROP_NONE);
914 RNA_def_property_boolean_sdna(prop, nullptr, "flag", RE_ENGINE_PREVIEW);
915
916 prop = RNA_def_property(srna, "camera_override", PROP_POINTER, PROP_NONE);
918 prop, "rna_RenderEngine_camera_override_get", nullptr, nullptr, nullptr);
919 RNA_def_property_struct_type(prop, "Object");
920
921 prop = RNA_def_property(srna, "layer_override", PROP_BOOLEAN, PROP_LAYER_MEMBER);
922 RNA_def_property_boolean_sdna(prop, nullptr, "layer_override", 1);
923 RNA_def_property_array(prop, 20);
924
925 prop = RNA_def_property(srna, "resolution_x", PROP_INT, PROP_PIXEL);
926 RNA_def_property_int_sdna(prop, nullptr, "resolution_x");
928
929 prop = RNA_def_property(srna, "resolution_y", PROP_INT, PROP_PIXEL);
930 RNA_def_property_int_sdna(prop, nullptr, "resolution_y");
932
933 prop = RNA_def_property(srna, "temporary_directory", PROP_STRING, PROP_NONE);
934 RNA_def_function_ui_description(func, "The temp directory used by Blender");
936 prop, "rna_RenderEngine_tempdir_get", "rna_RenderEngine_tempdir_length", nullptr);
938
939 /* Render Data */
940 prop = RNA_def_property(srna, "render", PROP_POINTER, PROP_NONE);
941 RNA_def_property_struct_type(prop, "RenderSettings");
942 RNA_def_property_pointer_funcs(prop, "rna_RenderEngine_render_get", nullptr, nullptr, nullptr);
943 RNA_def_property_ui_text(prop, "Render Data", "");
944
945 prop = RNA_def_property(srna, "use_highlight_tiles", PROP_BOOLEAN, PROP_NONE);
947
948 func = RNA_def_function(srna, "register_pass", "RE_engine_register_pass");
950 func, "Register a render pass that will be part of the render with the current settings");
951 parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene the pass is registered for");
953 parm = RNA_def_pointer(func, "view_layer", "ViewLayer", "", "View layer the pass belongs to");
955 parm = RNA_def_string(func, "name", nullptr, MAX_NAME, "Name", "");
957 parm = RNA_def_int(func, "channels", 1, 1, 8, "Channels", "", 1, 4);
959 parm = RNA_def_string(func, "chanid", nullptr, 8, "Channel IDs", "");
961 parm = RNA_def_enum(func, "type", render_pass_type_items, SOCK_FLOAT, "Type", "");
962 RNA_def_property_enum_native_type(parm, "eNodeSocketDatatype");
964
965 /* registration */
966
967 prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
968 RNA_def_property_string_sdna(prop, nullptr, "type->idname");
970
971 prop = RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
972 RNA_def_property_string_sdna(prop, nullptr, "type->name");
974
975 prop = RNA_def_property(srna, "bl_use_preview", PROP_BOOLEAN, PROP_NONE);
976 RNA_def_property_boolean_sdna(prop, nullptr, "type->flag", RE_USE_PREVIEW);
979 prop,
980 "Use Preview Render",
981 "Render engine supports being used for rendering previews of materials, lights and worlds");
982
983 prop = RNA_def_property(srna, "bl_use_postprocess", PROP_BOOLEAN, PROP_NONE);
986 RNA_def_property_ui_text(prop, "Use Post Processing", "Apply compositing on render results");
987
988 prop = RNA_def_property(srna, "bl_use_eevee_viewport", PROP_BOOLEAN, PROP_NONE);
989 RNA_def_property_boolean_sdna(prop, nullptr, "type->flag", RE_USE_EEVEE_VIEWPORT);
992 "Use EEVEE Viewport",
993 "Uses EEVEE for viewport shading in Material Preview shading mode");
994
995 prop = RNA_def_property(srna, "bl_use_custom_freestyle", PROP_BOOLEAN, PROP_NONE);
996 RNA_def_property_boolean_sdna(prop, nullptr, "type->flag", RE_USE_CUSTOM_FREESTYLE);
999 prop,
1000 "Use Custom Freestyle",
1001 "Handles freestyle rendering on its own, instead of delegating it to EEVEE");
1002
1003 prop = RNA_def_property(srna, "bl_use_image_save", PROP_BOOLEAN, PROP_NONE);
1008 prop,
1009 "Use Image Save",
1010 "Save images/movie to disk while rendering an animation. "
1011 "Disabling image saving is only supported when bl_use_postprocess is also disabled.");
1012
1013 prop = RNA_def_property(srna, "bl_use_gpu_context", PROP_BOOLEAN, PROP_NONE);
1014 RNA_def_property_boolean_sdna(prop, nullptr, "type->flag", RE_USE_GPU_CONTEXT);
1017 prop,
1018 "Use GPU Context",
1019 "Enable OpenGL context for the render method, for engines that render using OpenGL");
1020
1021 prop = RNA_def_property(srna, "bl_use_shading_nodes_custom", PROP_BOOLEAN, PROP_NONE);
1022 RNA_def_property_boolean_sdna(prop, nullptr, "type->flag", RE_USE_SHADING_NODES_CUSTOM);
1026 "Use Custom Shading Nodes",
1027 "Don't expose Cycles and EEVEE shading nodes in the node editor user "
1028 "interface, so separate nodes can be used instead");
1029
1030 prop = RNA_def_property(srna, "bl_use_spherical_stereo", PROP_BOOLEAN, PROP_NONE);
1031 RNA_def_property_boolean_sdna(prop, nullptr, "type->flag", RE_USE_SPHERICAL_STEREO);
1033 RNA_def_property_ui_text(prop, "Use Spherical Stereo", "Support spherical stereo camera models");
1034
1035 prop = RNA_def_property(srna, "bl_use_stereo_viewport", PROP_BOOLEAN, PROP_NONE);
1036 RNA_def_property_boolean_sdna(prop, nullptr, "type->flag", RE_USE_STEREO_VIEWPORT);
1038 RNA_def_property_ui_text(prop, "Use Stereo Viewport", "Support rendering stereo 3D viewport");
1039
1040 prop = RNA_def_property(srna, "bl_write_viewport_depth", PROP_BOOLEAN, PROP_NONE);
1041 RNA_def_property_boolean_sdna(prop, nullptr, "type->flag", RE_WRITE_VIEWPORT_DEPTH);
1044 "Write Viewport Depth",
1045 "The render engine writes depth to the viewport framebuffer "
1046 "which should be used as is instead of doing an internal depth pass");
1047
1048 prop = RNA_def_property(srna, "bl_use_materialx", PROP_BOOLEAN, PROP_NONE);
1049 RNA_def_property_boolean_sdna(prop, nullptr, "type->flag", RE_USE_MATERIALX);
1052 prop, "Use MaterialX", "Use MaterialX for exporting materials to Hydra");
1053
1055}
1056
1058{
1059 /* This is implemented in Python. */
1060 StructRNA *srna = RNA_def_struct(brna, "HydraRenderEngine", "RenderEngine");
1061 RNA_def_struct_sdna(srna, "RenderEngine");
1062 RNA_def_struct_ui_text(srna, "Hydra Render Engine", "Base class from USD Hydra based renderers");
1063}
1064
1066{
1067 StructRNA *srna;
1068 PropertyRNA *prop;
1069
1070 FunctionRNA *func;
1071 PropertyRNA *parm;
1072
1073 srna = RNA_def_struct(brna, "RenderResult", nullptr);
1075 srna, "Render Result", "Result of rendering, including all layers and passes");
1076
1077 func = RNA_def_function(srna, "load_from_file", "RE_result_load_from_file");
1079 "Copies the pixels of this render result from an image file");
1082 func,
1083 "filepath",
1084 nullptr,
1085 FILE_MAX,
1086 "File Name",
1087 "Filename to load into this render tile, must be no smaller than "
1088 "the render result");
1090
1091 func = RNA_def_function(srna, "stamp_data_add_field", "rna_RenderResult_stamp_data_add_field");
1092 RNA_def_function_ui_description(func, "Add engine-specific stamp data to the result");
1093 parm = RNA_def_string(func, "field", nullptr, 1024, "Field", "Name of the stamp field to add");
1095 parm = RNA_def_string(func, "value", nullptr, 0, "Value", "Value of the stamp data");
1097
1099
1100 prop = RNA_def_property(srna, "resolution_x", PROP_INT, PROP_PIXEL);
1101 RNA_def_property_int_sdna(prop, nullptr, "rectx");
1103
1104 prop = RNA_def_property(srna, "resolution_y", PROP_INT, PROP_PIXEL);
1105 RNA_def_property_int_sdna(prop, nullptr, "recty");
1107
1108 prop = RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
1109 RNA_def_property_struct_type(prop, "RenderLayer");
1111 "rna_RenderResult_layers_begin",
1112 "rna_iterator_listbase_next",
1113 "rna_iterator_listbase_end",
1114 "rna_iterator_listbase_get",
1115 nullptr,
1116 nullptr,
1117 nullptr,
1118 nullptr);
1119
1120 prop = RNA_def_property(srna, "views", PROP_COLLECTION, PROP_NONE);
1121 RNA_def_property_struct_type(prop, "RenderView");
1123 "rna_RenderResult_views_begin",
1124 "rna_iterator_listbase_next",
1125 "rna_iterator_listbase_end",
1126 "rna_iterator_listbase_get",
1127 nullptr,
1128 nullptr,
1129 nullptr,
1130 nullptr);
1131
1133}
1134
1136{
1137 StructRNA *srna;
1138 PropertyRNA *prop;
1139
1140 srna = RNA_def_struct(brna, "RenderView", nullptr);
1141 RNA_def_struct_ui_text(srna, "Render View", "");
1142
1144
1145 prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
1146 RNA_def_property_string_sdna(prop, nullptr, "name");
1148 RNA_def_struct_name_property(srna, prop);
1149
1151}
1152
1154{
1155 StructRNA *srna;
1156
1157 FunctionRNA *func;
1158 PropertyRNA *parm;
1159
1160 RNA_def_property_srna(cprop, "RenderPasses");
1161 srna = RNA_def_struct(brna, "RenderPasses", nullptr);
1162 RNA_def_struct_sdna(srna, "RenderLayer");
1163 RNA_def_struct_ui_text(srna, "Render Passes", "Collection of render passes");
1164
1165 func = RNA_def_function(srna, "find_by_name", "rna_RenderPass_find_by_name");
1166 RNA_def_function_ui_description(func, "Get the render pass for a given name and view");
1167 parm = RNA_def_string(func, "name", RE_PASSNAME_COMBINED, 0, "Pass", "");
1169 parm = RNA_def_string(
1170 func, "view", nullptr, 0, "View", "Render view to get pass from"); /* nullptr ok here */
1172 parm = RNA_def_pointer(func, "render_pass", "RenderPass", "", "The matching render pass");
1173 RNA_def_function_return(func, parm);
1174}
1175
1177{
1178 StructRNA *srna;
1179 PropertyRNA *prop;
1180
1181 FunctionRNA *func;
1182 PropertyRNA *parm;
1183
1184 srna = RNA_def_struct(brna, "RenderLayer", nullptr);
1185 RNA_def_struct_ui_text(srna, "Render Layer", "");
1186
1187 func = RNA_def_function(srna, "load_from_file", "RE_layer_load_from_file");
1189 "Copies the pixels of this renderlayer from an image file");
1191 parm = RNA_def_string(
1192 func,
1193 "filepath",
1194 nullptr,
1195 0,
1196 "File Path",
1197 "File path to load into this render tile, must be no smaller than the renderlayer");
1199 RNA_def_int(func,
1200 "x",
1201 0,
1202 0,
1203 INT_MAX,
1204 "Offset X",
1205 "Offset the position to copy from if the image is larger than the render layer",
1206 0,
1207 INT_MAX);
1208 RNA_def_int(func,
1209 "y",
1210 0,
1211 0,
1212 INT_MAX,
1213 "Offset Y",
1214 "Offset the position to copy from if the image is larger than the render layer",
1215 0,
1216 INT_MAX);
1217
1219
1220 rna_def_view_layer_common(brna, srna, false);
1221
1222 prop = RNA_def_property(srna, "passes", PROP_COLLECTION, PROP_NONE);
1223 RNA_def_property_struct_type(prop, "RenderPass");
1225 "rna_RenderLayer_passes_begin",
1226 "rna_iterator_listbase_next",
1227 "rna_iterator_listbase_end",
1228 "rna_iterator_listbase_get",
1229 nullptr,
1230 nullptr,
1231 nullptr,
1232 nullptr);
1233 rna_def_render_passes(brna, prop);
1234
1236}
1237
1239{
1240 StructRNA *srna;
1241 PropertyRNA *prop;
1242
1243 srna = RNA_def_struct(brna, "RenderPass", nullptr);
1244 RNA_def_struct_ui_text(srna, "Render Pass", "");
1245
1247
1248 prop = RNA_def_property(srna, "fullname", PROP_STRING, PROP_NONE);
1249 RNA_def_property_string_sdna(prop, nullptr, "fullname");
1251
1252 prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
1253 RNA_def_property_string_sdna(prop, nullptr, "name");
1255 RNA_def_struct_name_property(srna, prop);
1256
1257 prop = RNA_def_property(srna, "channel_id", PROP_STRING, PROP_NONE);
1258 RNA_def_property_string_sdna(prop, nullptr, "chan_id");
1260
1261 prop = RNA_def_property(srna, "channels", PROP_INT, PROP_NONE);
1262 RNA_def_property_int_sdna(prop, nullptr, "channels");
1264
1265 prop = RNA_def_property(srna, "rect", PROP_FLOAT, PROP_NONE);
1267 RNA_def_property_multi_array(prop, 2, nullptr);
1268 RNA_def_property_dynamic_array_funcs(prop, "rna_RenderPass_rect_get_length");
1270 prop, "rna_RenderPass_rect_get", "rna_RenderPass_rect_set", nullptr);
1271
1272 prop = RNA_def_property(srna, "view_id", PROP_INT, PROP_NONE);
1273 RNA_def_property_int_sdna(prop, nullptr, "view_id");
1275
1277}
1278
1280{
1284 rna_def_render_view(brna);
1286 rna_def_render_pass(brna);
1287}
1288
1289} // namespace blender
1290
1291#endif /* RNA_RUNTIME */
#define FILE_MAX
#define BPy_BEGIN_ALLOW_THREADS
Definition BPY_extern.hh:52
#define BPy_END_ALLOW_THREADS
Definition BPY_extern.hh:56
#define MAX_NAME
Definition DNA_defs.h:63
#define RE_PASSNAME_COMBINED
Read Blender memory allocation and freeing.
#define RNA_MAX_ARRAY_DIMENSION
Definition RNA_define.hh:29
SIMD_FORCE_INLINE btScalar length() const
Return the length of the vector.
Definition btVector3.h:257
#define offsetof(t, d)
#define FLT_MAX
#define INT_MAX
void free(Subdiv *subdiv)
Definition subdiv.cc:192
void refresh_for_srna_unregister(Main *bmain, StructRNA *srna_to_unreg)
BMesh Iterators.
void * MEM_new_uninitialized(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
void RNA_def_property_srna(PropertyRNA *prop, const char *type)
void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description)
int BKE_render_preview_pixel_size(const RenderData *r)
Definition scene.cc:3183
static void rna_def_render_result(BlenderRNA *brna)
void RNA_def_property_ui_text(PropertyRNA *prop, const char *name, const char *description)
void RNA_def_property_dynamic_array_funcs(PropertyRNA *prop, const char *getlength)
void RNA_def_property_string_sdna(PropertyRNA *prop, const char *structname, const char *propname)
int(*)(PointerRNA *ptr, void *data, bool *have_function) StructValidateFunc
PropertyRNA * RNA_def_string(StructOrFunctionRNA *cont_, const char *identifier, const char *default_value, const int maxlen, const char *ui_name, const char *ui_description)
void RNA_def_function_output(FunctionRNA *, PropertyRNA *ret)
void RNA_def_property_boolean_negative_sdna(PropertyRNA *prop, const char *structname, const char *propname, int64_t booleanbit)
static void rna_def_render_view(BlenderRNA *brna)
void RNA_def_property_float_funcs(PropertyRNA *prop, const char *get, const char *set, const char *range)
void RNA_def_property_pointer_funcs(PropertyRNA *prop, const char *get, const char *set, const char *type_fn, const char *poll)
static void rna_def_render_engine(BlenderRNA *brna)
PointerRNA RNA_id_pointer_create(ID *id)
void RNA_def_struct_refine_func(StructRNA *srna, const char *refine)
void rna_def_view_layer_common(BlenderRNA *brna, StructRNA *srna, bool scene)
void RNA_def_property_multi_array(PropertyRNA *prop, int dimension, const int length[])
static void rna_def_render_pass(BlenderRNA *brna)
void RNA_def_function_ui_description(FunctionRNA *func, const char *description)
void BKE_render_result_stamp_data(RenderResult *rr, const char *key, const char *value)
@ 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_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
@ FUNC_ALLOW_WRITE
@ FUNC_USE_REPORTS
@ FUNC_REGISTER_OPTIONAL
PropertyRNA * RNA_def_enum(StructOrFunctionRNA *cont_, const char *identifier, const EnumPropertyItem *items, const int default_value, const char *ui_name, const char *ui_description)
void * RNA_struct_blender_type_get(StructRNA *srna)
void * BLI_findstring(const ListBase *listbase, const char *id, int offset) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:615
static void rna_def_render_passes(BlenderRNA *brna, PropertyRNA *cprop)
PropertyRNA * RNA_def_pointer(StructOrFunctionRNA *cont_, const char *identifier, const char *type, const char *ui_name, const char *ui_description)
void RNA_def_property_struct_type(PropertyRNA *prop, const char *type)
const char * BKE_tempdir_session() ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL
Definition appdir.cc:1283
static void rna_def_render_layer(BlenderRNA *brna)
ParameterList * RNA_parameter_list_create(ParameterList *parms, PointerRNA *, FunctionRNA *func)
PropertyRNA * RNA_def_property(StructOrFunctionRNA *cont_, const char *identifier_c_str, int type, int subtype)
@ SCE_PASS_GLOSSY_COLOR
@ SCE_PASS_TRANSM_COLOR
@ SCE_PASS_DIFFUSE_COLOR
RenderData * RE_engine_get_render_data(Render *re)
void RNA_def_struct_sdna(StructRNA *srna, const char *structname)
void RNA_struct_free(BlenderRNA *brna, StructRNA *srna)
@ PROP_BOOLEAN
Definition RNA_types.hh:210
@ PROP_POINTER
Definition RNA_types.hh:215
@ PROP_STRING
Definition RNA_types.hh:213
@ PROP_COLLECTION
Definition RNA_types.hh:216
void rna_RenderPass_rect_set(PointerRNA *ptr, const float *values)
void RNA_def_parameter_flags(PropertyRNA *prop, PropertyFlag flag_property, ParameterFlag flag_parameter)
void ED_render_engine_changed(Main *bmain, bool update_scene_data)
void RE_engines_register(RenderEngineType *render_type)
void RNA_def_property_collection_funcs(PropertyRNA *prop, const char *begin, const char *next, const char *end, const char *get, const char *length, const char *lookupint, const char *lookupstring, const char *assignint)
BMesh const char void * data
T * DEG_get_evaluated(const Depsgraph *depsgraph, T *id)
void GPU_shader_unbind()
void RNA_def_property_boolean_sdna(PropertyRNA *prop, const char *structname, const char *propname, int64_t booleanbit)
const EnumPropertyItem rna_enum_bake_pass_type_items[]
Definition rna_render.cc:31
void BLI_freelinkN(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:277
void RNA_def_function_return(FunctionRNA *func, PropertyRNA *ret)
static void rna_def_hydra_render_engine(BlenderRNA *brna)
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
void GPU_shader_bind(gpu::Shader *shader, const gpu::shader::SpecializationConstants *constants_state=nullptr)
ListBaseT< RenderEngineType > R_engines
FunctionRNA * RNA_def_function(StructRNA *srna, const char *identifier_c_str, const char *call)
void(*)(void *data) StructFreeFunc
void RNA_def_struct_register_funcs(StructRNA *srna, const char *reg, const char *unreg, const char *instance)
void RE_engine_frame_set(RenderEngine *engine, int frame, float subframe)
void RNA_def_property_boolean_default(PropertyRNA *prop, bool value)
void RNA_def_property_clear_flag(PropertyRNA *prop, PropertyFlag flag)
RenderPass * RE_pass_find_by_name(RenderLayer *rl, const char *name, const char *viewname)
gpu::Shader * GPU_shader_get_builtin_shader(GPUBuiltinShader shader)
void RNA_def_function_flag(FunctionRNA *func, FunctionFlag flag)
void RNA_def_property_flag(PropertyRNA *prop, PropertyFlag flag)
PropertyRNA * RNA_def_int(StructOrFunctionRNA *cont_, const char *identifier, const int default_value, const int hardmin, const int hardmax, const char *ui_name, const char *ui_description, const int softmin, const int softmax)
void BKE_reportf(ReportList *reports, eReportType type, const char *format,...) ATTR_PRINTF_FORMAT(3
Definition report.cc:191
void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type)
void RNA_def_property_enum_native_type(PropertyRNA *prop, const char *native_enum_type)
StructRNA * RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from)
@ PROP_EDITABLE
Definition RNA_types.hh:376
@ PROP_DYNAMIC
Definition RNA_types.hh:498
@ PROP_REGISTER_OPTIONAL
Definition RNA_types.hh:482
@ PROP_REGISTER
Definition RNA_types.hh:481
void RNA_def_property_int_sdna(PropertyRNA *prop, const char *structname, const char *propname)
void RNA_parameter_set_lookup(ParameterList *parms, const char *identifier, const void *value)
PropertyRNA * RNA_def_enum_flag(StructOrFunctionRNA *cont_, const char *identifier, const EnumPropertyItem *items, const int default_value, const char *ui_name, const char *ui_description)
const EnumPropertyItem rna_enum_wm_report_items[]
Definition rna_wm.cc:627
PointerRNA RNA_pointer_create_with_parent(const PointerRNA &parent, StructRNA *type, void *data)
@ RE_ENGINE_ANIMATION
Definition RE_engine.h:63
@ RE_ENGINE_DO_DRAW
Definition RE_engine.h:65
@ RE_ENGINE_HIGHLIGHT_TILES
Definition RE_engine.h:68
@ RE_ENGINE_DO_UPDATE
Definition RE_engine.h:66
@ RE_ENGINE_PREVIEW
Definition RE_engine.h:64
PropertyRNA * RNA_def_string_file_name(StructOrFunctionRNA *cont_, const char *identifier, const char *default_value, const int maxlen, const char *ui_name, const char *ui_description)
void RNA_def_property_string_funcs(PropertyRNA *prop, const char *get, const char *length, const char *set)
void RNA_define_verify_sdna(bool verify)
PropertyRNA * RNA_def_boolean(StructOrFunctionRNA *cont_, const char *identifier, const bool default_value, const char *ui_name, const char *ui_description)
PropertyRNA * RNA_def_float_matrix(StructOrFunctionRNA *cont_, const char *identifier, const int rows, const int columns, const float *default_value, const float hardmin, const float hardmax, const char *ui_name, const char *ui_description, const float softmin, const float softmax)
@ PROP_LAYER_MEMBER
Definition RNA_types.hh:335
@ PARM_REQUIRED
Definition RNA_types.hh:631
@ PARM_RNAPTR
Definition RNA_types.hh:633
void rna_iterator_listbase_begin(CollectionPropertyIterator *iter, PointerRNA *ptr, ListBase *lb, IteratorSkipFunc skip)
void RNA_struct_free_extension(StructRNA *srna, ExtensionRNA *rna_ext)
void RNA_def_struct_name_property(StructRNA *srna, PropertyRNA *prop, const bool allow_replace)
PropertyRNA * RNA_def_float(StructOrFunctionRNA *cont_, const char *identifier, const float default_value, const float hardmin, const float hardmax, const char *ui_name, const char *ui_description, const float softmin, const float softmax)
void RNA_def_property_array(PropertyRNA *prop, int length)
int(*)(bContext *C, PointerRNA *ptr, FunctionRNA *func, ParameterList *list) StructCallbackFunc
void RNA_parameter_list_free(ParameterList *parms)
BlenderRNA RNA_blender_rna_get()
void RNA_def_render(BlenderRNA *brna)
Object * RE_GetCamera(Render *re)
Definition initrender.cc:31
StructRNA * RNA_def_struct_ptr(BlenderRNA *brna, const char *identifier, StructRNA *srnafrom)
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
float * float_data_for_write()
Definition allocimbuf.cc:79
RenderEngineType * type
Definition RE_engine.h:141
struct ImBuf * ibuf
Definition RE_pipeline.h:72