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