Join the python modules `gpu` and `_gpu` into one.
[blender.git] / source / blender / python / gpu / gpu_py_select.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_select.c
22  *  \ingroup bpygpu
23  *
24  * This file defines the gpu.select API.
25  *
26  * \note Currently only used for gizmo selection,
27  * will need to add begin/end and a way to access the hits.
28  *
29  * - Use ``bpygpu_`` for local API.
30  * - Use ``BPyGPU`` for public API.
31  */
32
33 #include <Python.h>
34
35 #include "BLI_utildefines.h"
36
37 #include "../generic/py_capi_utils.h"
38
39 #include "GPU_select.h"
40
41 #include "gpu_py_select.h" /* own include */
42
43 /* -------------------------------------------------------------------- */
44 /** \name Methods
45  * \{ */
46
47 PyDoc_STRVAR(bpygpu_select_load_id_doc,
48 "load_id(id)\n"
49 "\n"
50 "   Set the selection ID.\n"
51 "\n"
52 "   :param id: Number (32-bit unsigned int).\n"
53 "   :type select: int\n"
54 );
55 static PyObject *bpygpu_select_load_id(PyObject *UNUSED(self), PyObject *value)
56 {
57         uint id;
58         if ((id = PyC_Long_AsU32(value)) == (uint)-1) {
59                 return NULL;
60         }
61         GPU_select_load_id(id);
62         Py_RETURN_NONE;
63 }
64 /** \} */
65
66 /* -------------------------------------------------------------------- */
67 /** \name Module
68  * \{ */
69
70 static struct PyMethodDef bpygpu_select_methods[] = {
71         /* Manage Stack */
72         {"load_id", (PyCFunction)bpygpu_select_load_id, METH_O, bpygpu_select_load_id_doc},
73         {NULL, NULL, 0, NULL}
74 };
75
76 PyDoc_STRVAR(bpygpu_select_doc,
77 "This module provides access to selection."
78 );
79 static PyModuleDef BPyGPU_select_module_def = {
80         PyModuleDef_HEAD_INIT,
81         .m_name = "gpu.select",
82         .m_doc = bpygpu_select_doc,
83         .m_methods = bpygpu_select_methods,
84 };
85
86 PyObject *BPyInit_gpu_select(void)
87 {
88         PyObject *submodule;
89
90         submodule = PyModule_Create(&BPyGPU_select_module_def);
91
92         return submodule;
93 }
94
95 /** \} */