From d60e28093f8b3145d099ca696e0ddc2d0c9850ed Mon Sep 17 00:00:00 2001 From: nutti Date: Tue, 17 Aug 2021 14:44:28 +1000 Subject: Docs: add API docs for gpu.platform Adds Python API documentations for gpu.platform module. Ref D12222 --- source/blender/python/gpu/gpu_py_platform.c | 30 ++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) (limited to 'source/blender/python') diff --git a/source/blender/python/gpu/gpu_py_platform.c b/source/blender/python/gpu/gpu_py_platform.c index 132052b6f1d..7d10f0e9b43 100644 --- a/source/blender/python/gpu/gpu_py_platform.c +++ b/source/blender/python/gpu/gpu_py_platform.c @@ -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}, }; -- cgit v1.2.3