Blender V5.3
gpu_py_api.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
14
15#include <Python.h>
16
18
20#include "gpu_py_compute.hh"
21#include "gpu_py_matrix.hh"
22#include "gpu_py_platform.hh"
23#include "gpu_py_select.hh"
24#include "gpu_py_state.hh"
25#include "gpu_py_types.hh"
26
27#include "BKE_global.hh"
28#include "GPU_context.hh"
29#include "GPU_init_exit.hh"
30#include "WM_api.hh"
31#include "gpu_py_api.hh" /* Own include. */
32
33namespace blender {
34
35/* -------------------------------------------------------------------- */
38
40 /* Wrap. */
41 pygpu_init_doc,
42 ".. function:: init()\n"
43 "\n"
44 " Initializes the GPU module for background use.\n"
45 " If the initialization fails, a SystemError will be raised.\n");
46
47static PyObject *pygpu_init(PyObject * /*self*/)
48{
49 if (!G.background || GPU_is_init()) {
50 /* GPU is already initialized. */
51 Py_RETURN_NONE;
52 }
53
55
56 if (!GPU_backend_supported()) {
57 PyErr_SetString(PyExc_SystemError, "Failed to initialize GPU. GPU backend not supported");
58 return nullptr;
59 }
60
61 /* Cannot use GPU_init() as it requires a GPU context to have been created.
62 * See WM_init_gpu_offscreen implementation. */
64
65 if (!GPU_is_init()) {
66 PyErr_SetString(PyExc_SystemError, "Failed to initialize GPU. Unexpected Error");
67 return nullptr;
68 }
69
70 Py_RETURN_NONE;
71}
72
73#ifdef __GNUC__
74# ifdef __clang__
75# pragma clang diagnostic push
76# pragma clang diagnostic ignored "-Wcast-function-type"
77# else
78# pragma GCC diagnostic push
79# pragma GCC diagnostic ignored "-Wcast-function-type"
80# endif
81#endif
82
83static PyMethodDef pygpu_tp_methods[] = {
84 {"init", reinterpret_cast<PyCFunction>(pygpu_init), METH_NOARGS, pygpu_init_doc},
85 {nullptr, nullptr, 0, nullptr},
86};
87
88#ifdef __GNUC__
89# ifdef __clang__
90# pragma clang diagnostic pop
91# else
92# pragma GCC diagnostic pop
93# endif
94#endif
95
97 /* Wrap. */
98 pygpu_doc,
99 "This module provides Python wrappers for the GPU implementation in Blender.\n"
100 "Some higher level functions can be found in the :mod:`gpu_extras` module.\n");
101static PyModuleDef pygpu_module_def = {
102 /*m_base*/ PyModuleDef_HEAD_INIT,
103 /*m_name*/ "gpu",
104 /*m_doc*/ pygpu_doc,
105 /*m_size*/ 0,
106 /*m_methods*/ pygpu_tp_methods,
107 /*m_slots*/ nullptr,
108 /*m_traverse*/ nullptr,
109 /*m_clear*/ nullptr,
110 /*m_free*/ nullptr,
111};
112
113PyObject *BPyInit_gpu()
114{
115 PyObject *sys_modules = PyImport_GetModuleDict();
116 PyObject *submodule;
117 PyObject *mod;
118
119 mod = PyModule_Create(&pygpu_module_def);
120
121 PyModule_AddObject(mod, "types", (submodule = bpygpu_types_init()));
122 PyC_Module_AddToSysModules(sys_modules, submodule);
123
124 PyModule_AddObject(mod, "capabilities", (submodule = bpygpu_capabilities_init()));
125 PyC_Module_AddToSysModules(sys_modules, submodule);
126
127 PyModule_AddObject(mod, "matrix", (submodule = bpygpu_matrix_init()));
128 PyC_Module_AddToSysModules(sys_modules, submodule);
129
130 PyModule_AddObject(mod, "platform", (submodule = bpygpu_platform_init()));
131 PyC_Module_AddToSysModules(sys_modules, submodule);
132
133 PyModule_AddObject(mod, "select", (submodule = bpygpu_select_init()));
134 PyC_Module_AddToSysModules(sys_modules, submodule);
135
136 PyModule_AddObject(mod, "shader", (submodule = bpygpu_shader_init()));
137 PyC_Module_AddToSysModules(sys_modules, submodule);
138
139 PyModule_AddObject(mod, "state", (submodule = bpygpu_state_init()));
140 PyC_Module_AddToSysModules(sys_modules, submodule);
141
142 PyModule_AddObject(mod, "texture", (submodule = bpygpu_texture_init()));
143 PyC_Module_AddToSysModules(sys_modules, submodule);
144
145 PyModule_AddObject(mod, "compute", (submodule = bpygpu_compute_init()));
146 PyC_Module_AddToSysModules(sys_modules, submodule);
147
148 return mod;
149}
150
152
153} // namespace blender
VecBase< float, D > constexpr mod(VecOp< float, D >, VecOp< float, D >) RET
BMesh Iterators.
PyObject * bpygpu_capabilities_init()
PyObject * bpygpu_state_init()
PyDoc_STRVAR(bpy_bm_new_doc, ".. function:: new(*, use_operators=True)\n" "\n" " :param use_operators: Support calling operators in :mod:`bmesh.ops` (uses some " "extra memory per vert/edge/face).\n" " :type use_operators: bool\n" " :return: Return a new, empty BMesh.\n" " :rtype: :class:`bmesh.types.BMesh`\n")
bool GPU_backend_supported()
PyObject * bpygpu_matrix_init()
Global G
Definition blender.cc:57
void WM_init_gpu_offscreen()
static PyMethodDef pygpu_tp_methods[]
Definition gpu_py_api.cc:83
PyObject * bpygpu_texture_init()
PyObject * BPyInit_gpu()
PyObject * bpygpu_shader_init()
PyObject * bpygpu_select_init()
PyObject * bpygpu_compute_init()
int PyC_Module_AddToSysModules(PyObject *sys_modules, PyObject *module)
PyObject * bpygpu_platform_init()
static PyModuleDef pygpu_module_def
static PyObject * pygpu_init(PyObject *)
Definition gpu_py_api.cc:47
PyObject * bpygpu_types_init()
bool GPU_is_init()
void WM_init_gpu_backend()