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