Campbell Barton
c3a400b73f
While doxygen supports both, conform to our style guide. Note that single back-tick's are already used in a majority of comments.
89 lines
2.4 KiB
C
89 lines
2.4 KiB
C
/*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup bpygpu
|
|
*
|
|
* This file defines the gpu.select API.
|
|
*
|
|
* \note Currently only used for gizmo selection,
|
|
* will need to add begin/end and a way to access the hits.
|
|
*
|
|
* - Use `bpygpu_` for local API.
|
|
* - Use `BPyGPU` for public API.
|
|
*/
|
|
|
|
#include <Python.h>
|
|
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "../generic/py_capi_utils.h"
|
|
|
|
#include "GPU_select.h"
|
|
|
|
#include "gpu_py_select.h" /* own include */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Methods
|
|
* \{ */
|
|
|
|
PyDoc_STRVAR(pygpu_select_load_id_doc,
|
|
".. function:: load_id(id)\n"
|
|
"\n"
|
|
" Set the selection ID.\n"
|
|
"\n"
|
|
" :param id: Number (32-bit uint).\n"
|
|
" :type select: int\n");
|
|
static PyObject *pygpu_select_load_id(PyObject *UNUSED(self), PyObject *value)
|
|
{
|
|
uint id;
|
|
if ((id = PyC_Long_AsU32(value)) == (uint)-1) {
|
|
return NULL;
|
|
}
|
|
GPU_select_load_id(id);
|
|
Py_RETURN_NONE;
|
|
}
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Module
|
|
* \{ */
|
|
|
|
static struct PyMethodDef pygpu_select__tp_methods[] = {
|
|
/* Manage Stack */
|
|
{"load_id", (PyCFunction)pygpu_select_load_id, METH_O, pygpu_select_load_id_doc},
|
|
{NULL, NULL, 0, NULL},
|
|
};
|
|
|
|
PyDoc_STRVAR(pygpu_select__tp_doc, "This module provides access to selection.");
|
|
static PyModuleDef pygpu_select_module_def = {
|
|
PyModuleDef_HEAD_INIT,
|
|
.m_name = "gpu.select",
|
|
.m_doc = pygpu_select__tp_doc,
|
|
.m_methods = pygpu_select__tp_methods,
|
|
};
|
|
|
|
PyObject *bpygpu_select_init(void)
|
|
{
|
|
PyObject *submodule;
|
|
|
|
submodule = PyModule_Create(&pygpu_select_module_def);
|
|
|
|
return submodule;
|
|
}
|
|
|
|
/** \} */
|