PyAPI: Iniital gawain API for Python
[blender.git] / source / blender / python / gawain / gwn_py_types.h
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/gawain/gwn_py_types.h
22  *  \ingroup pygawain
23  */
24
25 #ifndef __GWN_PY_TYPES_H__
26 #define __GWN_PY_TYPES_H__
27
28 #include "BLI_compiler_attrs.h"
29
30 #define USE_GWN_PY_REFERENCES
31
32 extern PyTypeObject BPy_Gwn_VertFormat_Type;
33 extern PyTypeObject BPy_Gwn_VertBuf_Type;
34 extern PyTypeObject BPy_Gwn_Batch_Type;
35
36 #define BPy_Gwn_VertFormat_Check(v)     (Py_TYPE(v) == &BPy_Gwn_VertFormat_Type)
37 #define BPy_Gwn_VertBuf_Check(v)        (Py_TYPE(v) == &BPy_Gwn_VertBuf_Type)
38 #define BPy_Gwn_Batch_Check(v)          (Py_TYPE(v) == &BPy_Gwn_Batch_Type)
39
40 typedef struct BPy_Gwn_VertFormat {
41         PyObject_VAR_HEAD
42         struct Gwn_VertFormat fmt;
43 } BPy_Gwn_VertFormat;
44
45 typedef struct BPy_Gwn_VertBuf {
46         PyObject_VAR_HEAD
47         /* The buf is owned, we may support thin wrapped batches later. */
48         struct Gwn_VertBuf *buf;
49 } BPy_Gwn_VertBuf;
50
51 typedef struct BPy_Gwn_Batch {
52         PyObject_VAR_HEAD
53         /* The batch is owned, we may support thin wrapped batches later. */
54         struct Gwn_Batch *batch;
55 #ifdef USE_GWN_PY_REFERENCES
56         /* Just to keep a user to prevent freeing buf's we're using */
57         PyObject *references;
58 #endif
59 } BPy_Gwn_Batch;
60
61 PyObject *BPyInit_gawain_types(void);
62
63 PyObject *BPy_Gwn_VertFormat_CreatePyObject(struct Gwn_VertFormat *fmt);
64 PyObject *BPy_Gwn_VertBuf_CreatePyObject(struct Gwn_VertBuf *vbo) ATTR_NONNULL(1);
65 PyObject *BPy_Gwn_Batch_CreatePyObject(struct Gwn_Batch *batch) ATTR_NONNULL(1);
66
67 #endif /* __GWN_PY_TYPES_H__ */