From 8997a6e82bc18aaf3148ba89f97b0f002822f2a8 Mon Sep 17 00:00:00 2001 From: Julien Isorce Date: Thu, 15 Jan 2009 18:39:48 +0100 Subject: [PATCH] [293/906] minimal gtk doc --- gst/gl/gstglbumper.c | 2 +- gst/gl/gstgldifferencematte.c | 14 ++++++++++++++ gst/gl/gstgldownload.c | 2 +- gst/gl/gstgleffects.c | 14 ++++++++++++++ gst/gl/gstglfilterblur.c | 14 ++++++++++++++ gst/gl/gstglfilterlaplacian.c | 14 ++++++++++++++ gst/gl/gstglfiltersobel.c | 14 ++++++++++++++ gst/gl/gstglpixbufoverlay.c | 14 ++++++++++++++ 8 files changed, 86 insertions(+), 2 deletions(-) diff --git a/gst/gl/gstglbumper.c b/gst/gl/gstglbumper.c index 61fd4f49aa..0d93c42f43 100644 --- a/gst/gl/gstglbumper.c +++ b/gst/gl/gstglbumper.c @@ -29,7 +29,7 @@ * |[ * gst-launch -v videotestsrc ! glupload ! glbumper location=normalmap.bmp ! glimagesink * ]| A pipeline to test normal mapping. - * FBO and GLSL are required. + * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. * */ diff --git a/gst/gl/gstgldifferencematte.c b/gst/gl/gstgldifferencematte.c index a291fe6716..103ca1c6cb 100644 --- a/gst/gl/gstgldifferencematte.c +++ b/gst/gl/gstgldifferencematte.c @@ -18,6 +18,20 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-gldifferencematte. + * + * Saves a background frame and replace it with a pixbuf. + * + * + * Examples + * |[ + * gst-launch videotestsrc ! glupload ! gldifferencemate location=backgroundimagefile ! glimagesink + * ]| + * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/gl/gstgldownload.c b/gst/gl/gstgldownload.c index 7b9d3543cb..686c093f0d 100644 --- a/gst/gl/gstgldownload.c +++ b/gst/gl/gstgldownload.c @@ -49,7 +49,7 @@ * gst-launch -v gltestsrc ! gldownload ! xvimagesink * ]| A pipeline to test hardware colorspace conversion. * Your driver must support GLSL (OpenGL Shading Language needs OpenGL >= 2.1). - * Texture RGB32T is converted to one of the 4 following format YUY2, UYVY, I420, YV12 and AYUV, + * Texture RGB32 is converted to one of the 4 following format YUY2, UYVY, I420, YV12 and AYUV, * through some fragment shaders and using one framebuffer (FBO extension OpenGL >= 1.4). * MESA >= 7.1 supports GLSL but it's made in software. * |[ diff --git a/gst/gl/gstgleffects.c b/gst/gl/gstgleffects.c index 5d569ffc84..58875e90cc 100644 --- a/gst/gl/gstgleffects.c +++ b/gst/gl/gstgleffects.c @@ -18,6 +18,20 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-gleffects. + * + * GL Shading Language effects. + * + * + * Examples + * |[ + * gst-launch videotestsrc ! glupload ! gleffects effect=5 ! glimagesink + * ]| + * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. + * + */ + #include #define GST_TYPE_GL_EFFECTS (gst_gl_effects_get_type()) diff --git a/gst/gl/gstglfilterblur.c b/gst/gl/gstglfilterblur.c index 87a02f469c..a31a35e387 100644 --- a/gst/gl/gstglfilterblur.c +++ b/gst/gl/gstglfilterblur.c @@ -18,6 +18,20 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-glfilterblur + * + * Blur with 9x9 separable convolution. + * + * + * Examples + * |[ + * gst-launch videotestsrc ! glupload ! glfilterblur ! glimagesink + * ]| + * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/gl/gstglfilterlaplacian.c b/gst/gl/gstglfilterlaplacian.c index 10c40ebd4e..a0e14fdeb8 100644 --- a/gst/gl/gstglfilterlaplacian.c +++ b/gst/gl/gstglfilterlaplacian.c @@ -18,6 +18,20 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-glfilterlaplacian + * + * Laplacian Convolution Demo Filter. + * + * + * Examples + * |[ + * gst-launch videotestsrc ! glupload ! glfilterlaplacian ! glimagesink + * ]| + * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/gl/gstglfiltersobel.c b/gst/gl/gstglfiltersobel.c index 4eb2355d51..03080891f4 100644 --- a/gst/gl/gstglfiltersobel.c +++ b/gst/gl/gstglfiltersobel.c @@ -18,6 +18,20 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-glfiltersobel. + * + * Sobel Edge Detection. + * + * + * Examples + * |[ + * gst-launch videotestsrc ! glupload ! glfiltersobel ! glimagesink + * ]| + * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/gl/gstglpixbufoverlay.c b/gst/gl/gstglpixbufoverlay.c index 9c3cc6e86e..94912bb09d 100644 --- a/gst/gl/gstglpixbufoverlay.c +++ b/gst/gl/gstglpixbufoverlay.c @@ -18,6 +18,20 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-glpixbufoverlay + * + * Overlay GL video texture with a gdkpixbuf. + * + * + * Examples + * |[ + * gst-launch videotestsrc ! "video/x-raw-rgb" ! glupload ! glpixbufoverlay location=imagefile ! glimagesink + * ]| + * FBO (Frame Buffer Object) is required. + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif