blender
/
blender
129
398
Fork 572
Code Issues 6.2k Pull Requests 748 Projects 19 Wiki Activity

PyAPI: expose imbuf.types.ImBuf, include in API docs 

Without this, the ImBuf type wasn't part of documentation.
This commit is contained in:
Campbell Barton 2021-02-25 12:00:45 +11:00
parent 17260c9b9a
commit c47990f41c
2 changed files with 47 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/python_api/sphinx_doc_gen.py
View File

@ -228,6 +228,7 @@ else:
"blf",
"bl_math",
"imbuf",
"imbuf.types",
"bmesh",
"bmesh.ops",
"bmesh.types",
@ -1976,6 +1977,7 @@ def write_rst_importable_modules(basepath):
"aud": "Audio System",
"blf": "Font Drawing",
"imbuf": "Image Buffer",
"imbuf.types": "Image Buffer Types",
"gpu": "GPU Shader Module",
"gpu.types": "GPU Types",
"gpu.matrix": "GPU Matrix",

48
source/blender/python/generic/imbuf_py_api.c
View File

@ -40,6 +40,8 @@
#include <errno.h>
#include <fcntl.h>
static PyObject *BPyInit_imbuf_types(void);
static PyObject *Py_ImBuf_CreatePyObject(ImBuf *ibuf);
/* -------------------------------------------------------------------- */
@ -522,7 +524,7 @@ static PyObject *M_imbuf_write(PyObject *UNUSED(self), PyObject *args, PyObject
/** \} */
/* -------------------------------------------------------------------- */
/** \name Module Definition
/** \name Module Definition (`imbuf`)
* \{ */
static PyMethodDef IMB_methods[] = {
@ -547,11 +549,51 @@ static struct PyModuleDef IMB_module_def = {
PyObject *BPyInit_imbuf(void)
{
PyObject *mod;
PyObject *submodule;
PyObject *sys_modules = PyImport_GetModuleDict();
submodule = PyModule_Create(&IMB_module_def);
mod = PyModule_Create(&IMB_module_def);
PyType_Ready(&Py_ImBuf_Type);
/* `imbuf.types` */
PyModule_AddObject(mod, "types", (submodule = BPyInit_imbuf_types()));
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
return mod;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Module Definition (`imbuf.types`)
*
* `imbuf.types` module, only include this to expose access to `imbuf.types.ImBuf`
* for docs and the ability to use with built-ins such as `isinstance`, `issubclass`.
* \{ */
PyDoc_STRVAR(IMB_types_doc, "This module provides access to image buffer types.");
static struct PyModuleDef IMB_types_module_def = {
PyModuleDef_HEAD_INIT,
"imbuf.types", /* m_name */
IMB_types_doc, /* m_doc */
0, /* m_size */
NULL, /* m_methods */
NULL, /* m_reload */
NULL, /* m_traverse */
NULL, /* m_clear */
NULL, /* m_free */
};
PyObject *BPyInit_imbuf_types(void)
{
PyObject *submodule = PyModule_Create(&IMB_types_module_def);
if (PyType_Ready(&Py_ImBuf_Type) < 0) {
return NULL;
}
PyModule_AddType(submodule, &Py_ImBuf_Type);
return submodule;
}