summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.com>2014-02-21 19:28:55 +0000
committerTim-Philipp Müller <tim@centricular.com>2014-02-23 14:42:12 +0000
commit6442e76e9ff3b5ee031d410c3d9f3f3f576149a0 (patch)
tree8362c344a31966bd5ad47612cb3f78613dcaf358
parent2df1e56bb7240e158373313d2dfa577c40f10766 (diff)
docs: add GstVideoPool to docs
-rw-r--r--docs/libs/gst-plugins-base-libs-docs.sgml1
-rw-r--r--docs/libs/gst-plugins-base-libs-sections.txt1
-rw-r--r--gst-libs/gst/video/gstvideopool.c12
3 files changed, 14 insertions, 0 deletions
diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml
index 734c46a48..fedb377c5 100644
--- a/docs/libs/gst-plugins-base-libs-docs.sgml
+++ b/docs/libs/gst-plugins-base-libs-docs.sgml
@@ -195,6 +195,7 @@
<xi:include href="xml/gstvideooverlay.xml" />
<xi:include href="xml/gstvideodecoder.xml" />
<xi:include href="xml/gstvideoencoder.xml" />
+ <xi:include href="xml/gstvideopool.xml" />
<xi:include href="xml/gstvideoutils.xml" />
</chapter>
</part>
diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index d8498a445..4ddd44bf8 100644
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -2337,6 +2337,7 @@ GST_TYPE_NAVIGATION_EVENT_TYPE
<SECTION>
<FILE>gstvideopool</FILE>
+<TITLE>GstVideoPool</TITLE>
<INCLUDE>gst/video/gstvideopool.h</INCLUDE>
GstVideoBufferPool
GstVideoBufferPoolClass
diff --git a/gst-libs/gst/video/gstvideopool.c b/gst-libs/gst/video/gstvideopool.c
index 63d2a2c24..4475f45a4 100644
--- a/gst-libs/gst/video/gstvideopool.c
+++ b/gst-libs/gst/video/gstvideopool.c
@@ -21,6 +21,18 @@
#include "gst/video/gstvideopool.h"
/**
+ * SECTION:gstvideopool
+ * @short_description: GstBufferPool for raw video buffers
+ * @see_also: #GstBufferPool
+ *
+ * Special GstBufferPool subclass for raw video buffers.
+ *
+ * Allows configuration of video-specific requirements such as
+ * stride alignments or pixel padding, and can also be configured
+ * to automatically add #GstVideoMeta to the buffers.
+ */
+
+/**
* gst_buffer_pool_config_set_video_alignment:
* @config: a #GstStructure
* @align: a #GstVideoAlignment