Merge branch 'blender2.7'
[blender.git] / source / blender / python / gpu / gpu_py_vertex_format.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup bpygpu
19  *
20  * - Use ``bpygpu_`` for local API.
21  * - Use ``BPyGPU`` for public API.
22  */
23
24 #include <Python.h>
25
26 #include "BLI_math.h"
27
28 #include "MEM_guardedalloc.h"
29
30 #include "../generic/py_capi_utils.h"
31 #include "../generic/python_utildefines.h"
32
33 #include "gpu_py_vertex_format.h" /* own include */
34
35 #ifdef __BIG_ENDIAN__
36    /* big endian */
37 #  define MAKE_ID2(c, d)  ((c) << 8 | (d))
38 #  define MAKE_ID3(a, b, c) ( (int)(a) << 24 | (int)(b) << 16 | (c) << 8 )
39 #  define MAKE_ID4(a, b, c, d) ( (int)(a) << 24 | (int)(b) << 16 | (c) << 8 | (d) )
40 #else
41    /* little endian  */
42 #  define MAKE_ID2(c, d)  ((d) << 8 | (c))
43 #  define MAKE_ID3(a, b, c) ( (int)(c) << 16 | (b) << 8 | (a) )
44 #  define MAKE_ID4(a, b, c, d) ( (int)(d) << 24 | (int)(c) << 16 | (b) << 8 | (a) )
45 #endif
46
47 /* -------------------------------------------------------------------- */
48 /** \name Enum Conversion
49  *
50  * Use with PyArg_ParseTuple's "O&" formatting.
51  * \{ */
52
53 static int bpygpu_parse_component_type(const char *str, int length)
54 {
55         if (length == 2) {
56                 switch (*((ushort *)str)) {
57                         case MAKE_ID2('I', '8'): return GPU_COMP_I8;
58                         case MAKE_ID2('U', '8'): return GPU_COMP_U8;
59                         default: break;
60                 }
61         }
62         else if (length == 3) {
63                 switch (*((uint *)str)) {
64                         case MAKE_ID3('I', '1', '6'): return GPU_COMP_I16;
65                         case MAKE_ID3('U', '1', '6'): return GPU_COMP_U16;
66                         case MAKE_ID3('I', '3', '2'): return GPU_COMP_I32;
67                         case MAKE_ID3('U', '3', '2'): return GPU_COMP_U32;
68                         case MAKE_ID3('F', '3', '2'): return GPU_COMP_F32;
69                         case MAKE_ID3('I', '1', '0'): return GPU_COMP_I10;
70                         default: break;
71                 }
72         }
73         return -1;
74 }
75
76 static int bpygpu_parse_fetch_mode(const char *str, int length)
77 {
78 #define MATCH_ID(id) \
79         if (length == strlen(STRINGIFY(id))) { \
80                 if (STREQ(str, STRINGIFY(id))) { \
81                         return GPU_FETCH_##id; \
82                 } \
83         } ((void)0)
84
85         MATCH_ID(FLOAT);
86         MATCH_ID(INT);
87         MATCH_ID(INT_TO_FLOAT_UNIT);
88         MATCH_ID(INT_TO_FLOAT);
89 #undef MATCH_ID
90
91         return -1;
92 }
93
94 static int bpygpu_ParseVertCompType(PyObject *o, void *p)
95 {
96         Py_ssize_t length;
97         const char *str = _PyUnicode_AsStringAndSize(o, &length);
98
99         if (str == NULL) {
100                 PyErr_Format(PyExc_ValueError,
101                              "expected a string, got %s",
102                              Py_TYPE(o)->tp_name);
103                 return 0;
104         }
105
106         int comp_type = bpygpu_parse_component_type(str, length);
107         if (comp_type == -1) {
108                 PyErr_Format(PyExc_ValueError,
109                              "unkown component type: '%s",
110                              str);
111                 return 0;
112         }
113
114         *((GPUVertCompType *)p) = comp_type;
115         return 1;
116 }
117
118 static int bpygpu_ParseVertFetchMode(PyObject *o, void *p)
119 {
120         Py_ssize_t length;
121         const char *str = _PyUnicode_AsStringAndSize(o, &length);
122
123         if (str == NULL) {
124                 PyErr_Format(PyExc_ValueError,
125                              "expected a string, got %s",
126                              Py_TYPE(o)->tp_name);
127                 return 0;
128         }
129
130         int fetch_mode = bpygpu_parse_fetch_mode(str, length);
131         if (fetch_mode == -1) {
132                 PyErr_Format(PyExc_ValueError,
133                              "unknown type literal: '%s'",
134                              str);
135                 return 0;
136         }
137
138         (*(GPUVertFetchMode *)p) = fetch_mode;
139         return 1;
140 }
141
142 /** \} */
143
144
145 /* -------------------------------------------------------------------- */
146 /** \name VertFormat Type
147  * \{ */
148
149 static PyObject *bpygpu_VertFormat_new(PyTypeObject *UNUSED(type), PyObject *args, PyObject *kwds)
150 {
151         if (PyTuple_GET_SIZE(args) || (kwds && PyDict_Size(kwds))) {
152                 PyErr_SetString(PyExc_ValueError, "This function takes no arguments");
153                 return NULL;
154         }
155         return BPyGPUVertFormat_CreatePyObject(NULL);
156 }
157
158 PyDoc_STRVAR(bpygpu_VertFormat_attr_add_doc,
159 ".. method:: attr_add(id, comp_type, len, fetch_mode)\n"
160 "\n"
161 "   Add a new attribute to the format.\n"
162 "\n"
163 "   :param id: Name the attribute. Often `position`, `normal`, ...\n"
164 "   :type id: str\n"
165 "   :param comp_type: The data type that will be used store the value in memory.\n"
166 "      Possible values are `I8`, `U8`, `I16`, `U16`, `I32`, `U32`, `F32` and `I10`.\n"
167 "   :type comp_type: `str`\n"
168 "   :param len: How many individual values the attribute consists of (e.g. 2 for uv coordinates).\n"
169 "   :type len: int\n"
170 "   :param fetch_mode: How values from memory will be converted when used in the shader.\n"
171 "      This is mainly useful for memory optimizations when you want to store values with reduced precision.\n"
172 "      E.g. you can store a float in only 1 byte but it will be converted to a normal 4 byte float when used.\n"
173 "      Possible values are `FLOAT`, `INT`, `INT_TO_FLOAT_UNIT` and `INT_TO_FLOAT`.\n"
174 "   :type fetch_mode: `str`\n"
175 );
176 static PyObject *bpygpu_VertFormat_attr_add(BPyGPUVertFormat *self, PyObject *args, PyObject *kwds)
177 {
178         struct {
179                 const char *id;
180                 GPUVertCompType comp_type;
181                 uint len;
182                 GPUVertFetchMode fetch_mode;
183         } params;
184
185         if (self->fmt.attr_len == GPU_VERT_ATTR_MAX_LEN) {
186                 PyErr_SetString(PyExc_ValueError, "Maxumum attr reached " STRINGIFY(GPU_VERT_ATTR_MAX_LEN));
187                 return NULL;
188         }
189
190         static const char *_keywords[] = {"id", "comp_type", "len", "fetch_mode", NULL};
191         static _PyArg_Parser _parser = {"$sO&IO&:attr_add", _keywords, 0};
192         if (!_PyArg_ParseTupleAndKeywordsFast(
193                 args, kwds, &_parser,
194                 &params.id,
195                 bpygpu_ParseVertCompType, &params.comp_type,
196                 &params.len,
197                 bpygpu_ParseVertFetchMode, &params.fetch_mode))
198         {
199                 return NULL;
200         }
201
202         uint attr_id = GPU_vertformat_attr_add(&self->fmt, params.id, params.comp_type, params.len, params.fetch_mode);
203         return PyLong_FromLong(attr_id);
204 }
205
206 static struct PyMethodDef bpygpu_VertFormat_methods[] = {
207         {"attr_add", (PyCFunction)bpygpu_VertFormat_attr_add,
208          METH_VARARGS | METH_KEYWORDS, bpygpu_VertFormat_attr_add_doc},
209         {NULL, NULL, 0, NULL},
210 };
211
212
213 static void bpygpu_VertFormat_dealloc(BPyGPUVertFormat *self)
214 {
215         Py_TYPE(self)->tp_free(self);
216 }
217
218 PyDoc_STRVAR(bpygpu_VertFormat_doc,
219 ".. class:: GPUVertFormat()\n"
220 "\n"
221 "   This object contains information about the structure of a vertex buffer.\n"
222 );
223 PyTypeObject BPyGPUVertFormat_Type = {
224         PyVarObject_HEAD_INIT(NULL, 0)
225         .tp_name = "GPUVertFormat",
226         .tp_basicsize = sizeof(BPyGPUVertFormat),
227         .tp_dealloc = (destructor)bpygpu_VertFormat_dealloc,
228         .tp_flags = Py_TPFLAGS_DEFAULT,
229         .tp_doc = bpygpu_VertFormat_doc,
230         .tp_methods = bpygpu_VertFormat_methods,
231         .tp_new = bpygpu_VertFormat_new,
232 };
233
234 /** \} */
235
236
237 /* -------------------------------------------------------------------- */
238 /** \name Public API
239  * \{ */
240
241 PyObject *BPyGPUVertFormat_CreatePyObject(GPUVertFormat *fmt)
242 {
243         BPyGPUVertFormat *self;
244
245         self = PyObject_New(BPyGPUVertFormat, &BPyGPUVertFormat_Type);
246         if (fmt) {
247                 self->fmt = *fmt;
248         }
249         else {
250                 memset(&self->fmt, 0, sizeof(self->fmt));
251         }
252
253         return (PyObject *)self;
254 }
255
256 /** \} */