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