diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-02 09:24:04 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-02 14:53:44 +0300 |
commit | 42a6b2fd06e4fefe1bdb283d9e568d7f7dca178e (patch) | |
tree | 8006ad82c7b331eccb1433f8cda10d7372f44b3a /source/blender/python/gpu/gpu_py_buffer.h | |
parent | 17665494186816cebb9e8304199e40f9ee033990 (diff) |
Cleanup: move public doc-strings into headers for 'python'
Diffstat (limited to 'source/blender/python/gpu/gpu_py_buffer.h')
-rw-r--r-- | source/blender/python/gpu/gpu_py_buffer.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/source/blender/python/gpu/gpu_py_buffer.h b/source/blender/python/gpu/gpu_py_buffer.h index 9df22e9b780..cbc46339628 100644 --- a/source/blender/python/gpu/gpu_py_buffer.h +++ b/source/blender/python/gpu/gpu_py_buffer.h @@ -48,6 +48,13 @@ typedef struct BPyGPUBuffer { } BPyGPUBuffer; size_t bpygpu_Buffer_size(BPyGPUBuffer *buffer); +/** + * Create a buffer object + * + * \param shape: An array of `shape_len` integers representing the size of each dimension. + * \param buffer: When not NULL holds a contiguous buffer + * with the correct format from which the buffer will be initialized + */ BPyGPUBuffer *BPyGPU_Buffer_CreatePyObject(const int format, const Py_ssize_t *shape, const int shape_len, |