summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVíctor Manuel Jáquez Leal <vjaquez@igalia.com>2020-01-14 18:46:49 +0100
committerVíctor Manuel Jáquez Leal <vjaquez@igalia.com>2020-01-14 19:52:18 +0100
commitd0e14ec3089af20f75e12816368f0807b355af93 (patch)
tree3e435170ec2075d7d952fbd13386498d2a3d7ddf
parent81f3a7f02bc4e4d6b38214d2816e65c63a2e3435 (diff)
vaapioverlay: add minimal documentation
-rw-r--r--gst-libs/gst/vaapi/gstvaapiblend.c13
-rw-r--r--gst/vaapi/gstvaapioverlay.c21
2 files changed, 34 insertions, 0 deletions
diff --git a/gst-libs/gst/vaapi/gstvaapiblend.c b/gst-libs/gst/vaapi/gstvaapiblend.c
index 192865e9..57f9fb27 100644
--- a/gst-libs/gst/vaapi/gstvaapiblend.c
+++ b/gst-libs/gst/vaapi/gstvaapiblend.c
@@ -289,6 +289,19 @@ gst_vaapi_blend_process_unlocked (GstVaapiBlend * blend,
return TRUE;
}
+/**
+ * gst_vaapi_blend_process:
+ * @blend: a #GstVaapiBlend instance.
+ * @output: a #GstVaapiSurface to be composed.
+ * @next: a function to fetch the next #GstVaapiBlendSurface to
+ * process.
+ * @data: state storage for @next.
+ *
+ * This function will process all the input surfaces defined through
+ * #GstVaapiBlendSurface and will blend them onto the @output surface.
+ *
+ * Returns: %TRUE if the blend process succeed; otherwise %FALSE.
+ **/
gboolean
gst_vaapi_blend_process (GstVaapiBlend * blend, GstVaapiSurface * output,
GstVaapiBlendSurfaceNextFunc next, gpointer user_data)
diff --git a/gst/vaapi/gstvaapioverlay.c b/gst/vaapi/gstvaapioverlay.c
index 37155ee4..5f3f4541 100644
--- a/gst/vaapi/gstvaapioverlay.c
+++ b/gst/vaapi/gstvaapioverlay.c
@@ -20,6 +20,27 @@
* Boston, MA 02110-1301 USA
*/
+/**
+ * SECTION:element-vaapioverlay
+ * @title: vaapioverlay
+ * @short_description: a VA-API base video compositor
+ *
+ * The vaapioverlay element is similar to the base compositor element
+ * but uses VA-API VPP blend functions to accelerate the
+ * overlay/compositing.
+ *
+ * Currently this element only works with iHD driver.
+ *
+ * ## Example launch line
+ *
+ * |[
+ * gst-launch-1.0 -vf videotestsrc ! vaapipostproc \
+ * ! tee name=testsrc ! queue \
+ * ! vaapioverlay sink_1::xpos=300 sink_1::alpha=0.75 \
+ * name=overlay ! vaapisink testsrc. ! queue ! overlay.
+ * ]|
+ */
+
#include "gstvaapioverlay.h"
#include "gstvaapipluginutil.h"
#include "gstvaapivideobufferpool.h"