Code cleanup: use r_ prefix for return args
[blender.git] / source / blender / makesrna / intern / rna_texture_api.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): Tom Edwards
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_texture_api.c
24  *  \ingroup RNA
25  */
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <string.h>
30
31 #include "BLI_utildefines.h"
32 #include "BLI_path_util.h"
33
34 #include "RNA_define.h"
35
36 #include "rna_internal.h"  /* own include */
37
38 #ifdef RNA_RUNTIME
39
40 #include "IMB_imbuf.h"
41 #include "IMB_imbuf_types.h"
42 #include "DNA_scene_types.h"
43 #include "BKE_context.h"
44 #include "BKE_global.h"
45 #include "RE_pipeline.h"
46 #include "RE_shader_ext.h"
47
48 static void save_envmap(struct EnvMap *env, bContext *C, ReportList *reports, const char *filepath,
49                         struct Scene *scene, float layout[12])
50 {
51         if (scene == NULL) {
52                 scene = CTX_data_scene(C);
53         }
54
55         RE_WriteEnvmapResult(reports, scene, env, filepath, scene->r.im_format.imtype, layout);
56 }
57
58 static void clear_envmap(struct EnvMap *env, bContext *C)
59 {
60         Main *bmain = CTX_data_main(C);
61         Tex *tex;
62
63         BKE_free_envmapdata(env);
64         
65         for (tex = bmain->tex.first; tex; tex = tex->id.next)
66                 if (tex->env == env) {
67                         WM_event_add_notifier(C, NC_TEXTURE | NA_EDITED, tex);
68                         break;
69                 }
70 }
71
72 static void texture_evaluate(struct Tex *tex, float value[3], float r_color[4])
73 {
74         TexResult texres = {0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0, NULL};
75
76         /* TODO(sergey): always use color management now.  */
77         multitex_ext(tex, value, NULL, NULL, 1, &texres, NULL, true);
78
79         r_color[0] = texres.tr;
80         r_color[1] = texres.tg;
81         r_color[2] = texres.tb;
82         r_color[3] = texres.tin;
83 }
84
85 #else
86
87 void RNA_api_texture(StructRNA *srna)
88 {
89         FunctionRNA *func;
90         PropertyRNA *parm;
91
92         func = RNA_def_function(srna, "evaluate", "texture_evaluate");
93         RNA_def_function_ui_description(func, "Evaluate the texture at the coordinates given");
94
95         parm = RNA_def_float_vector(func, "value", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
96         RNA_def_property_flag(parm, PROP_REQUIRED);
97
98         /* return location and normal */
99         parm = RNA_def_float_vector(func, "result", 4, NULL, -FLT_MAX, FLT_MAX, "Result", NULL, -1e4, 1e4);
100         RNA_def_property_flag(parm, PROP_THICK_WRAP);
101         RNA_def_function_output(func, parm);
102
103 }
104
105 void RNA_api_environment_map(StructRNA *srna)
106 {
107         FunctionRNA *func;
108         PropertyRNA *parm;
109
110         static const float default_layout[] = {0, 0, 1, 0, 2, 0, 0, 1, 1, 1, 2, 1};
111
112         func = RNA_def_function(srna, "clear", "clear_envmap");
113         RNA_def_function_ui_description(func, "Discard the environment map and free it from memory");
114         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
115
116
117         func = RNA_def_function(srna, "save", "save_envmap");
118         RNA_def_function_ui_description(func, "Save the environment map to disc using the scene render settings");
119         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
120
121         parm = RNA_def_string_file_name(func, "filepath", NULL, FILE_MAX, "File path", "Location of the output file");
122         RNA_def_property_flag(parm, PROP_REQUIRED);
123
124         RNA_def_pointer(func, "scene", "Scene", "", "Overrides the scene from which image parameters are taken");
125
126         RNA_def_float_array(func, "layout", 12, default_layout, 0.0f, 1000.0f, "File layout",
127                             "Flat array describing the X,Y position of each cube face in the "
128                             "output image, where 1 is the size of a face - order is [+Z -Z +Y -X -Y +X] "
129                             "(use -1 to skip a face)", 0.0f, 1000.0f);
130 }
131
132 #endif