Commit ef53753a authored by Julien Moutte's avatar Julien Moutte
Browse files

Adding docs.

Original commit message from CVS:
2005-11-30  Julien MOUTTE  <julien@moutte.net>

* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* gst-libs/gst/video/gstvideofilter.c:
* gst-libs/gst/video/gstvideosink.c:
* gst-libs/gst/video/gstvideosink.h: Adding docs.
parent ad7671e5
2005-11-30 Julien MOUTTE <julien@moutte.net>
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* gst-libs/gst/video/gstvideofilter.c:
* gst-libs/gst/video/gstvideosink.c:
* gst-libs/gst/video/gstvideosink.h: Adding docs.
2005-11-30 Thomas Vander Stichele <thomas (at) apestaart (dot) org>
 
* LICENSE:
......
......@@ -6,6 +6,8 @@
<!ENTITY GstCompiling SYSTEM "compiling.sgml">
<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
<!ENTITY GstVideoSink SYSTEM "xml/element-videosink.xml">
<!ENTITY GstVideoFilter SYSTEM "xml/element-videofilter.xml">
<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
<!ENTITY GstGConf SYSTEM "xml/gstgconf.xml">
<!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
......@@ -39,6 +41,17 @@ This library should be linked to by getting cflags and libs from
&GstRingBuffer;
</chapter>
<chapter id="gstreamer-video">
<title>Video Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstVideoSink;
&GstVideoFilter;
</chapter>
<chapter id="gstreamer-interfaces">
<title>Interfaces Library</title>
<para>
......
......@@ -115,3 +115,20 @@ gst_x_overlay_prepare_xwindow_id
gst_x_overlay_expose
</SECTION>
<SECTION>
<FILE>element-videosink</FILE>
<INCLUDE>gst/video/gstvideosink.h</INCLUDE>
GstVideoSink
GstVideoSinkClass
GstVideoRectangle
gst_video_sink_center_rect
</SECTION>
<SECTION>
<FILE>element-videofilter</FILE>
<INCLUDE>gst/video/gstvideofilter.h</INCLUDE>
GstVideoFilter
GstVideoFilterClass
</SECTION>
......@@ -18,6 +18,18 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-videofilter
* @short_description: Base class for video filters.
*
* <refsect2>
* <para>
* Provides useful functions and a base class for video filters. Right now it's
* mostly used as a place holder for adding common code later on.
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
......
......@@ -19,6 +19,18 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-videosink
* @short_description: Base class for video sinks.
*
* <refsect2>
* <para>
* Provides useful functions and a base class for video sinks. Right now it's
* mostly used as a place holder for adding common code later on.
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
......@@ -27,6 +39,17 @@
static GstElementClass *parent_class = NULL;
/**
* gst_video_sink_center_rect:
* @src: the #GstVideoRectangle describing the source area
* @dst: the #GstVideoRectangle describing the destination area
* @result: a pointer to a #GstVideoRectangle which will receive the result area
* @scaling: a #gboolean indicating if scaling should be applied or not
*
* Takes @src rectangle and position it at the center of @dst rectangle with or
* without @scaling. It handles clipping if the @src rectangle is bigger than
* the @dst one and @scaling is set to FALSE.
*/
void
gst_video_sink_center_rect (GstVideoRectangle src, GstVideoRectangle dst,
GstVideoRectangle * result, gboolean scaling)
......
......@@ -48,6 +48,15 @@ typedef struct _GstVideoSink GstVideoSink;
typedef struct _GstVideoSinkClass GstVideoSinkClass;
typedef struct _GstVideoRectangle GstVideoRectangle;
/**
* GstVideoRectangle:
* @x: X coordinate of rectangle's top-left point
* @y: Y coordinate of rectangle's top-left point
* @w: width of the rectangle
* @h: height of the rectangle
*
* Helper structure representing a rectangular area.
*/
struct _GstVideoRectangle {
gint x;
gint y;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment