Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2015-07-24 09:58:43 +0300
committerCampbell Barton <ideasman42@gmail.com>2015-07-24 09:59:39 +0300
commitdc6153453aa3cbd7b68c89f28e56d7717ab9003a (patch)
treef7129ebd7604c53d87044f23667ce66a515c2150
parent7f326011596723ef2959f0715e345f9a4b8e76ad (diff)
Cleanup: comments (remove outdated & update)
-rw-r--r--source/blender/python/generic/bgl.c8
-rw-r--r--source/blender/python/generic/bgl.h22
2 files changed, 14 insertions, 16 deletions
diff --git a/source/blender/python/generic/bgl.c b/source/blender/python/generic/bgl.c
index e597855168e..6dc606f3dca 100644
--- a/source/blender/python/generic/bgl.c
+++ b/source/blender/python/generic/bgl.c
@@ -636,7 +636,13 @@ PyTypeObject BGL_bufferType = {
NULL /*tp_del*/
};
-
+/**
+ * Create a buffer object
+ *
+ * \param dimensions: An array of ndimensions integers representing the size of each dimension.
+ * \param initbuffer: When not NULL holds a contiguous buffer
+ * with the correct format from which the buffer will be initialized
+ */
Buffer *BGL_MakeBuffer(int type, int ndimensions, int *dimensions, void *initbuffer)
{
Buffer *buffer;
diff --git a/source/blender/python/generic/bgl.h b/source/blender/python/generic/bgl.h
index f148c127956..b27a4d6a0a4 100644
--- a/source/blender/python/generic/bgl.h
+++ b/source/blender/python/generic/bgl.h
@@ -24,28 +24,20 @@
* \ingroup pygen
*/
-
-/* This is the Blender.BGL part of opy_draw.c, from the old bpython/intern
- * dir, with minor changes to adapt it to the new Python implementation.
- * The BGL submodule "wraps" OpenGL functions and constants, allowing script
- * writers to make OpenGL calls in their Python scripts for Blender. The
- * more important original comments are marked with an @ symbol. */
-
#ifndef __BGL_H__
#define __BGL_H__
PyObject *BPyInit_bgl(void);
-/*@ Create a buffer object */
-/*@ dimensions is an array of ndimensions integers representing the size of each dimension */
-/*@ initbuffer if not NULL holds a contiguous buffer with the correct format from which the buffer will be initialized */
struct _Buffer *BGL_MakeBuffer(int type, int ndimensions, int *dimensions, void *initbuffer);
-/*@ Return the size of buffer element, type must be one of GL_BYTE, GL_SHORT, GL_INT, GL_FLOAT or GL_DOUBLE */
-/*@ returns -1 otherwise */
+
int BGL_typeSize(int type);
-/*@ Buffer Object */
-/*@ For Python access to OpenGL functions requiring a pointer. */
+/**
+ * Buffer Object
+ *
+ * For Python access to OpenGL functions requiring a pointer.
+ */
typedef struct _Buffer {
PyObject_VAR_HEAD
PyObject *parent;
@@ -65,7 +57,7 @@ typedef struct _Buffer {
} buf;
} Buffer;
-/*@ The type object */
+/** The type object */
extern PyTypeObject BGL_bufferType;
#endif /* __BGL_H__ */