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