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