summaryrefslogtreecommitdiffstats
path: root/gst/smpte/gstsmptealpha.c
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2009-01-28 12:29:42 +0200
committerStefan Kost <ensonic@users.sf.net>2009-01-28 12:32:59 +0200
commita99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch)
tree4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/smpte/gstsmptealpha.c
parent00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (diff)
Update and add documentation for plugins with no deps (gst).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered.
Diffstat (limited to 'gst/smpte/gstsmptealpha.c')
-rw-r--r--gst/smpte/gstsmptealpha.c32
1 files changed, 14 insertions, 18 deletions
diff --git a/gst/smpte/gstsmptealpha.c b/gst/smpte/gstsmptealpha.c
index 95c8b245..74f27ba2 100644
--- a/gst/smpte/gstsmptealpha.c
+++ b/gst/smpte/gstsmptealpha.c
@@ -19,26 +19,21 @@
/**
* SECTION:element-smptealpha
- * @short_description: Takes a video frames and applies an SMPTE transition
- * effect on it in the alpha channel.
*
- * <refsect2>
- * <para>
* smptealpha can accept an I420 or AYUV video stream. An alpha channel is added
- * using an effect specific SMPTE mask in the I420 input case. In the AYUV case, the
- * alpha channel is modified using the effect specific SMPTE mask.
- * </para>
- * <para>
- * The "position" property is a controllabe double between 0.0 and 1.0 that
- * specifies the position in the transition. 0.0 is the start of the transition
- * with the alpha channel to complete opaque where 1.0 has the alpha channel set
- * to completely transparent.
- * </para>
- * <para>
- * The depth property defines the precision in bits of the mask. A higher
- * presision will create a mask with smoother gradients in order to avoid
- * banding.
- * </para>
+ * using an effect specific SMPTE mask in the I420 input case. In the AYUV case,
+ * the alpha channel is modified using the effect specific SMPTE mask.
+ *
+ * The #GstSmpteAlpha:position property is a controllabe double between 0.0 and
+ * 1.0 that specifies the position in the transition. 0.0 is the start of the
+ * transition with the alpha channel to complete opaque where 1.0 has the alpha
+ * channel set to completely transparent.
+ *
+ * The #GstSmpteAlpha:depth property defines the precision in bits of the mask.
+ * A higher presision will create a mask with smoother gradients in order to
+ * avoid banding.
+ *
+ * <refsect2>
* <title>Sample pipelines</title>
* <para>
* Here is a pipeline to demonstrate the smpte transition :
@@ -432,6 +427,7 @@ gst_smpte_alpha_do_ayuv (GstSMPTEAlpha * smpte, guint8 * in, guint8 * out,
}
}
}
+
static void
gst_smpte_alpha_do_i420 (GstSMPTEAlpha * smpte, guint8 * in, guint8 * out,
GstMask * mask, gint width, gint height, gint border, gint pos)