summaryrefslogtreecommitdiff
path: root/gst/vaapi/gstvaapipostproc.c
diff options
context:
space:
mode:
authorVíctor Manuel Jáquez Leal <victorx.jaquez@intel.com>2016-01-29 20:41:27 +0100
committerVíctor Manuel Jáquez Leal <victorx.jaquez@intel.com>2016-02-03 20:03:47 +0100
commit9b8fb25b8c6ddfa7fd70a7ca79a468dae1376351 (patch)
tree8f6f60f1fb1a43bda3bff0fca681ad9558e9a1ee /gst/vaapi/gstvaapipostproc.c
parentd675816ed0b053077696818253774bd3c55218ec (diff)
downloadgst-vaapi-9b8fb25b8c6ddfa7fd70a7ca79a468dae1376351.tar.gz
docs: update plugin documentation
Update all the documentation of elements of the vaapi plugin. Signed-off-by: Víctor Manuel Jáquez Leal <victorx.jaquez@intel.com>
Diffstat (limited to 'gst/vaapi/gstvaapipostproc.c')
-rw-r--r--gst/vaapi/gstvaapipostproc.c16
1 files changed, 11 insertions, 5 deletions
diff --git a/gst/vaapi/gstvaapipostproc.c b/gst/vaapi/gstvaapipostproc.c
index 9583c27e..7d968a4a 100644
--- a/gst/vaapi/gstvaapipostproc.c
+++ b/gst/vaapi/gstvaapipostproc.c
@@ -21,12 +21,18 @@
*/
/**
- * SECTION:gstvaapipostproc
- * @short_description: A video postprocessing filter
+ * SECTION:element-vaapipostproc
+ * @short_description: A VA-API base video postprocessing filter
*
* vaapipostproc consists in various postprocessing algorithms to be
- * applied to VA surfaces. So far, only basic bob deinterlacing is
- * implemented.
+ * applied to VA surfaces.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 videotestsrc ! vaapipostproc ! video/x-raw width=1920, height=1080 ! vaapisink
+ * ]|
+ * </refsect2>
*/
#include "gstcompat.h"
@@ -39,7 +45,7 @@
#include "gstvaapivideomemory.h"
#define GST_PLUGIN_NAME "vaapipostproc"
-#define GST_PLUGIN_DESC "A video postprocessing filter"
+#define GST_PLUGIN_DESC "A VA-API video postprocessing filter"
GST_DEBUG_CATEGORY_STATIC (gst_debug_vaapipostproc);
#define GST_CAT_DEFAULT gst_debug_vaapipostproc