eglglessink: Documentation: GstEglGlesBuffer struct (DRAFT)

diff --git a/ext/eglgles/gsteglglessink.h b/ext/eglgles/gsteglglessink.h
index 4baeba5280dcc50a55a7e4e1817d91eee173474f..a35c13fc7766878cda3d9382a8f5c8eaa6acc2b7 100644 (file)
--- a/ext/eglgles/gsteglglessink.h
+++ b/ext/eglgles/gsteglglessink.h
@@ -168,9 +168,23 @@ struct _GstEglGlesImageFmt
   GstCaps *caps;                /* Matching caps for the attribs */
 };
 
-/* XXX: Maybe use GstVideoRectangle for the image data? */
+/*
+ * GstEglGlesBuffer:
+ * @buffer: GST buffer
+ * @eglglessink: Pointer to the eglglessink instance this buffer belongs to
+ * @image: Pointer to the EGL image data
+ * @format: Image's picture format
+ * @width: Image's pixel width
+ * @height: Image's pixel height
+ * @size: Image's data size
+ *
+ * This struct holds the internal representation of the sink's custom
+ * buffer. This implementation is just a draft and only makes sense for
+ * the fast rendering path logic.
+ */
 struct _GstEglGlesBuffer
 {
+  /* XXX: Maybe use GstVideoRectangle for the image data? */
   GstBuffer buffer;
   GstEglGlesSink *eglglessink;