archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Docs: add API docs for gpu.platform

Browse Source 
Adds Python API documentations for gpu.platform module.

Ref D12222
This commit is contained in:
nutti
2021-08-17 14:44:28 +10:00
committed by Campbell Barton
parent 869b84452a
commit d60e28093f
2 changed files with 29 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
source/blender/python/gpu/gpu_py_platform.c
View File

@@ -33,16 +33,37 @@
/** \name Functions
* \{ */
PyDoc_STRVAR(pygpu_platform_vendor_get_doc,
".. function:: vendor_get()\n"
"\n"
" Get GPU vendor.\n"
"\n"
" :return: Vendor name.\n"
" :rtype: str\n");
static PyObject *pygpu_platform_vendor_get(PyObject *UNUSED(self))
{
return PyUnicode_FromString(GPU_platform_vendor());
}
PyDoc_STRVAR(pygpu_platform_renderer_get_doc,
".. function:: renderer_get()\n"
"\n"
" Get GPU to be used for rendering.\n"
"\n"
" :return: GPU name.\n"
" :rtype: str\n");
static PyObject *pygpu_platform_renderer_get(PyObject *UNUSED(self))
{
return PyUnicode_FromString(GPU_platform_renderer());
}
PyDoc_STRVAR(pygpu_platform_version_get_doc,
".. function:: version_get()\n"
"\n"
" Get GPU driver version.\n"
"\n"
" :return: Driver version.\n"
" :rtype: str\n");
static PyObject *pygpu_platform_version_get(PyObject *UNUSED(self))
{
return PyUnicode_FromString(GPU_platform_version());
@@ -55,9 +76,12 @@ static PyObject *pygpu_platform_version_get(PyObject *UNUSED(self))
* \{ */
static struct PyMethodDef pygpu_platform__tp_methods[] = {
{"vendor_get", (PyCFunction)pygpu_platform_vendor_get, METH_NOARGS, NULL},
{"renderer_get", (PyCFunction)pygpu_platform_renderer_get, METH_NOARGS, NULL},
{"version_get", (PyCFunction)pygpu_platform_version_get, METH_NOARGS, NULL},
{"vendor_get", (PyCFunction)pygpu_platform_vendor_get, METH_NOARGS,
pygpu_platform_vendor_get_doc},
{"renderer_get", (PyCFunction)pygpu_platform_renderer_get, METH_NOARGS,
pygpu_platform_renderer_get_doc},
{"version_get", (PyCFunction)pygpu_platform_version_get, METH_NOARGS,
pygpu_platform_version_get_doc},
{NULL, NULL, 0, NULL},
};