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