From 9cf73bdd8f18505269fa4b6d1d80127945e735b1 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 28 Jan 2009 17:46:06 +0200 Subject: Update and add documentation for plugins with deps (ext). Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. Fix warnings that gtk-doc points out. --- ext/gdk_pixbuf/gstgdkpixbufsink.c | 71 +++++++++++++++------------------------ 1 file changed, 28 insertions(+), 43 deletions(-) (limited to 'ext/gdk_pixbuf') diff --git a/ext/gdk_pixbuf/gstgdkpixbufsink.c b/ext/gdk_pixbuf/gstgdkpixbufsink.c index f4d318a1..3c988f92 100644 --- a/ext/gdk_pixbuf/gstgdkpixbufsink.c +++ b/ext/gdk_pixbuf/gstgdkpixbufsink.c @@ -19,20 +19,14 @@ /** * SECTION:element-gdkpixbufsink - * @short_description: video sink that converts RGB images to GdkPixbufs. - * @see_also: + * @Since: 0.10.8 * - * - * * This sink element takes RGB or RGBA images as input and wraps them into - * GdkPixbuf objects, for easy saving to file via the - * - * GdkPixbuf library API or displaying in Gtk+ applications (e.g. using - * the - * GtkImage widget). - * - * - * There are two ways to use this element and obtain the GdkPixbuf objects + * #GdkPixbuf objects, for easy saving to file via the + * GdkPixbuf library API or displaying in Gtk+ applications (e.g. using + * the #GtkImage widget). + * + * There are two ways to use this element and obtain the #GdkPixbuf objects * created: * * @@ -43,34 +37,30 @@ * contained in them. * * - * Retrieving the current pixbuf via the "last-pixbuf" - * property when needed. + * Retrieving the current pixbuf via the #GstGdkPixbufSink:last-pixbuf property + * when needed. * * - * - * - * The primary purpose of this element is to abstract away the GstBuffer to - * GdkPixbuf conversion. Other than that it's very similar to the fakesink + * + * The primary purpose of this element is to abstract away the #GstBuffer to + * #GdkPixbuf conversion. Other than that it's very similar to the fakesink * element. - * - * + * * This element is meant for easy no-hassle video snapshotting. It is not * suitable for video playback or video display at high framerates. Use * ximagesink, xvimagesink or some other suitable video sink in connection - * with the GstXOverlay interface instead if you want to do video playback. - * + * with the #GstXOverlay interface instead if you want to do video playback. + * + * * Message details - * * As mentioned above, this element will by default post element messages * containing structures named "preroll-pixbuf" * or "pixbuf" on the bus (this - * can be disabled by setting the - * "send-messages" - * property to #FALSE though). The element message's structure - * will have the following fields: + * can be disabled by setting the #GstGdkPixbufSink:send-messages property + * to #FALSE though). The element message structure has the following fields: * * - * "pixbuf": the GdkPixbuf object + * "pixbuf": the #GdkPixbuf object * * * "pixel-aspect-ratio": the pixel aspect @@ -78,30 +68,25 @@ * PAR is usually 1:1 for images, but is often something non-1:1 in the case * of video input. In this case the image may be distorted and you may need * to rescale it accordingly before saving it to file or displaying it. This - * can easily be done using the - * - * GdkPixbuf library API (the reason this is not done automatically - * is that the application will often scale the image anyway according to the - * size of the output window, in which case it is much more efficient to only - * scale once rather than twice). You can put a videoscale element and a - * capsfilter element with + * can easily be done using gdk_pixbuf_scale() (the reason this is not done + * automatically is that the application will often scale the image anyway + * according to the size of the output window, in which case it is much more + * efficient to only scale once rather than twice). You can put a videoscale + * element and a capsfilter element with * video/x-raw-rgb,pixel-aspect-ratio=(fraction)1/1 caps * in front of this element to make sure the pixbufs always have a 1:1 PAR. * * - * + * + * + * * Example pipeline - * - * + * |[ * gst-launch -m -v videotestsrc num-buffers=1 ! gdkpixbufsink - * - * Process one single test image as pixbuf (note that the output you see will + * ]| Process one single test image as pixbuf (note that the output you see will * be slightly misleading. The message structure does contain a valid pixbuf * object even if the structure string says '(NULL)'). - * * - * - * Since: 0.10.8 */ #ifdef HAVE_CONFIG_H -- cgit