Tracking: Give more reasonable error message directly in the interface
[blender.git] / source / blender / python / gpu / gpu_py_api.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  * Experimental Python API, not considered public yet (called '_gpu'),
21  * we may re-expose as public later.
22  *
23  * - Use ``bpygpu_`` for local API.
24  * - Use ``BPyGPU`` for public API.
25  */
26
27 #include <Python.h>
28
29 #include "BLI_utildefines.h"
30
31 #include "../generic/python_utildefines.h"
32
33 #include "GPU_init_exit.h"
34 #include "GPU_primitive.h"
35
36 #include "gpu_py_matrix.h"
37 #include "gpu_py_select.h"
38 #include "gpu_py_types.h"
39
40 #include "gpu_py_api.h" /* own include */
41
42 /* -------------------------------------------------------------------- */
43 /** \name Utils to invalidate functions
44  * \{ */
45
46 bool bpygpu_is_initialized_or_error(void)
47 {
48   if (!GPU_is_initialized()) {
49     PyErr_SetString(PyExc_SystemError,
50                     "GPU functions for drawing are not available in background mode");
51
52     return false;
53   }
54
55   return true;
56 }
57
58 /** \} */
59
60 /* -------------------------------------------------------------------- */
61 /** \name Primitive Type Utils
62  * \{ */
63
64 int bpygpu_ParsePrimType(PyObject *o, void *p)
65 {
66   Py_ssize_t mode_id_len;
67   const char *mode_id = _PyUnicode_AsStringAndSize(o, &mode_id_len);
68   if (mode_id == NULL) {
69     PyErr_Format(PyExc_ValueError, "expected a string, got %s", Py_TYPE(o)->tp_name);
70     return 0;
71   }
72 #define MATCH_ID(id) \
73   if (mode_id_len == strlen(STRINGIFY(id))) { \
74     if (STREQ(mode_id, STRINGIFY(id))) { \
75       mode = GPU_PRIM_##id; \
76       goto success; \
77     } \
78   } \
79   ((void)0)
80
81   GPUPrimType mode;
82   MATCH_ID(POINTS);
83   MATCH_ID(LINES);
84   MATCH_ID(TRIS);
85   MATCH_ID(LINE_STRIP);
86   MATCH_ID(LINE_LOOP);
87   MATCH_ID(TRI_STRIP);
88   MATCH_ID(TRI_FAN);
89   MATCH_ID(LINES_ADJ);
90   MATCH_ID(TRIS_ADJ);
91   MATCH_ID(LINE_STRIP_ADJ);
92
93 #undef MATCH_ID
94   PyErr_Format(PyExc_ValueError, "unknown type literal: '%s'", mode_id);
95   return 0;
96
97 success:
98   (*(GPUPrimType *)p) = mode;
99   return 1;
100 }
101
102 /** \} */
103
104 /* -------------------------------------------------------------------- */
105 /** \name GPU Module
106  * \{ */
107
108 PyDoc_STRVAR(GPU_doc,
109              "This module provides Python wrappers for the GPU implementation in Blender. "
110              "Some higher level functions can be found in the `gpu_extras` module. "
111              "\n\n"
112              "Submodules:\n"
113              "\n"
114              ".. toctree::\n"
115              "   :maxdepth: 1\n"
116              "\n"
117              "   gpu.types.rst\n"
118              "   gpu.shader.rst\n"
119              "   gpu.matrix.rst\n"
120              "   gpu.select.rst\n"
121              "\n");
122 static struct PyModuleDef GPU_module_def = {
123     PyModuleDef_HEAD_INIT,
124     .m_name = "gpu",
125     .m_doc = GPU_doc,
126 };
127
128 PyObject *BPyInit_gpu(void)
129 {
130   PyObject *sys_modules = PyImport_GetModuleDict();
131   PyObject *submodule;
132   PyObject *mod;
133
134   mod = PyModule_Create(&GPU_module_def);
135
136   PyModule_AddObject(mod, "types", (submodule = BPyInit_gpu_types()));
137   PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
138
139   PyModule_AddObject(mod, "matrix", (submodule = BPyInit_gpu_matrix()));
140   PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
141
142   PyModule_AddObject(mod, "select", (submodule = BPyInit_gpu_select()));
143   PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
144
145   PyModule_AddObject(mod, "shader", (submodule = BPyInit_gpu_shader()));
146   PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
147
148   return mod;
149 }
150
151 /** \} */