diff options
author | Sebastian Dröge <sebastian.droege@collabora.co.uk> | 2009-06-16 20:38:42 +0200 |
---|---|---|
committer | Sebastian Dröge <sebastian.droege@collabora.co.uk> | 2009-06-16 20:38:42 +0200 |
commit | 55535c7fe636ecce465190a0de436b99891155cb (patch) | |
tree | 6434ba872bbb70aa7c452bb4cce7d01f65e6ced4 /gst/effectv/gstdice.c | |
parent | 757f80b23e034465f34dff436c5248963365a285 (diff) |
effectv: Add basic documentation for the effectv elements
Diffstat (limited to 'gst/effectv/gstdice.c')
-rw-r--r-- | gst/effectv/gstdice.c | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/gst/effectv/gstdice.c b/gst/effectv/gstdice.c index 1c4a392d..b46aab8e 100644 --- a/gst/effectv/gstdice.c +++ b/gst/effectv/gstdice.c @@ -26,6 +26,24 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-dicetv + * + * DiceTV 'dices' the screen up into many small squares, each defaulting + * to a size of 16 pixels by 16 pixels.. Each square is rotated randomly + * in one of four directions: up (no change), down (180 degrees, or + * upside down), right (90 degrees clockwise), or left (90 degrees + * counterclockwise). The direction of each square normally remains + * consistent between each frame. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch -v videotestsrc ! dicetv ! ffmpegcolorspace ! autovideosink + * ]| This pipeline shows the effect of dicetv on a test stream. + * </refsect2> + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif |