From 232596356f941c727e79d88785c162f19b7166f8 Mon Sep 17 00:00:00 2001
From: gb <gb@5584edef-b1fe-4b99-b61b-dd2bab72e969>
Date: Tue, 23 Mar 2010 15:22:47 +0000
Subject: [PATCH] Document vaapiconvert & vaapisink plugins.

---
 sys/vaapiconvert/gstvaapiconvert.c | 27 +++++++++++++++++++++++++++
 sys/vaapisink/gstvaapisink.c       |  9 +++++++++
 2 files changed, 36 insertions(+)

diff --git a/sys/vaapiconvert/gstvaapiconvert.c b/sys/vaapiconvert/gstvaapiconvert.c
index c61660b3c3..e579eb3672 100644
--- a/sys/vaapiconvert/gstvaapiconvert.c
+++ b/sys/vaapiconvert/gstvaapiconvert.c
@@ -18,6 +18,14 @@
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  */
 
+/**
+ * SECTION:gstvaapiconvert
+ * @short_description: A VA-API based video pixels format converter
+ *
+ * vaapiconvert converts from raw YUV pixels to surfaces suitable for
+ * the vaapisink element.
+ */
+
 #include "config.h"
 #include <gst/gst.h>
 #include <gst/video/video.h>
@@ -231,6 +239,25 @@ gst_vaapiconvert_class_init(GstVaapiConvertClass *klass)
     trans_class->get_unit_size  = gst_vaapiconvert_get_unit_size;
     trans_class->prepare_output_buffer = gst_vaapiconvert_prepare_output_buffer;
 
+    /**
+     * GstVaapiConvert:direct-rendering:
+     *
+     * Selects the direct rendering level.
+     * <orderedlist>
+     * <listitem override="0">
+     *   Disables direct rendering.
+     * </listitem>
+     * <listitem>
+     *   Enables direct rendering to the output buffer. i.e. this
+     *   tries to use a single buffer for both sink and src pads.
+     * </listitem>
+     * <listitem>
+     *   Enables direct rendering to the underlying surface. i.e. with
+     *   drivers supporting vaDeriveImage(), the output surface pixels
+     *   will be modified directly.
+     * </listitem>
+     * </orderedlist>
+     */
     g_object_class_install_property
         (object_class,
          PROP_DIRECT_RENDERING,
diff --git a/sys/vaapisink/gstvaapisink.c b/sys/vaapisink/gstvaapisink.c
index a4bd7e7137..ed8e407c46 100644
--- a/sys/vaapisink/gstvaapisink.c
+++ b/sys/vaapisink/gstvaapisink.c
@@ -18,6 +18,15 @@
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  */
 
+/**
+ * SECTION:gstvaapisink
+ * @short_description: A VA-API based videosink
+ *
+ * vaapisink renders video frames to a drawable (X #Window) on a local
+ * display using the Video Acceleration (VA) API. The element will
+ * create its own internal window and render into it.
+ */
+
 #include "config.h"
 #include <gst/gst.h>
 #include <gst/video/video.h>