~sipe-collab/sipe-collab/gstreamer-plugins-base

« back to all changes in this revision

Viewing changes to docs/libs/html/gst-plugins-base-libs-gstvideooverlaycomposition.html

  • Committer: Sebastian Dröge
  • Date: 2014-04-19 13:47:47 UTC
  • mfrom: (1.1.23)
  • Revision ID: git-v1:d06393f82dba0d5f13ec2e66275d75cf8178fe5c
Merge tag 'upstream/1.2.4'

Upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>gstvideooverlaycomposition</title>
 
5
<title>GStreamer Base Plugins 1.0 Library Reference Manual: gstvideooverlaycomposition</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
8
8
<link rel="up" href="gstreamer-video.html" title="Video Library">
9
9
<link rel="prev" href="gst-plugins-base-libs-gstvideometa.html" title="gstvideometa">
10
10
<link rel="next" href="gst-plugins-base-libs-gstvideofilter.html" title="gstvideofilter">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="gst-plugins-base-libs-gstvideometa.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="gstreamer-video.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">GStreamer Base Plugins 1.0 Library Reference Manual</th>
21
 
<td><a accesskey="n" href="gst-plugins-base-libs-gstvideofilter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#gst-plugins-base-libs-gstvideooverlaycomposition.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#gst-plugins-base-libs-gstvideooverlaycomposition.description" class="shortcut">Description</a>
27
 
</td></tr>
28
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#gst-plugins-base-libs-gstvideooverlaycomposition.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#gst-plugins-base-libs-gstvideooverlaycomposition.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
 
20
</td>
 
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
22
<td><a accesskey="u" href="gstreamer-video.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="gst-plugins-base-libs-gstvideometa.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="gst-plugins-base-libs-gstvideofilter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
29
26
<div class="refentry">
30
27
<a name="gst-plugins-base-libs-gstvideooverlaycomposition"></a><div class="titlepage"></div>
31
28
<div class="refnamediv"><table width="100%"><tr>
33
30
<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstvideooverlaycomposition.top_of_page"></a>gstvideooverlaycomposition</span></h2>
34
31
<p>gstvideooverlaycomposition — Video Buffer Overlay Compositions (Subtitles, Logos)</p>
35
32
</td>
36
 
<td valign="top" align="right"></td>
 
33
<td class="gallery_image" valign="top" align="right"></td>
37
34
</tr></table></div>
38
 
<div class="refsynopsisdiv">
39
 
<a name="gst-plugins-base-libs-gstvideooverlaycomposition.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis">
41
 
#include &lt;gst/video/video-overlay-composition.h&gt;
42
 
 
43
 
                    <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition">GstVideoOverlayComposition</a>;
44
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-new" title="gst_video_overlay_composition_new ()">gst_video_overlay_composition_new</a>
45
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);
46
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-ref" title="gst_video_overlay_composition_ref ()">gst_video_overlay_composition_ref</a>
47
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);
48
 
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-unref" title="gst_video_overlay_composition_unref ()">gst_video_overlay_composition_unref</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);
49
 
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-add-rectangle" title="gst_video_overlay_composition_add_rectangle ()">gst_video_overlay_composition_add_rectangle</a>
50
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>,
51
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);
52
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-n-rectangles" title="gst_video_overlay_composition_n_rectangles ()">gst_video_overlay_composition_n_rectangles</a>
53
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);
54
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-get-rectangle" title="gst_video_overlay_composition_get_rectangle ()">gst_video_overlay_composition_get_rectangle</a>
55
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>,
56
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);
57
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-get-seqnum" title="gst_video_overlay_composition_get_seqnum ()">gst_video_overlay_composition_get_seqnum</a>
58
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);
59
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-copy" title="gst_video_overlay_composition_copy ()">gst_video_overlay_composition_copy</a>
60
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);
61
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-make-writable" title="gst_video_overlay_composition_make_writable ()">gst_video_overlay_composition_make_writable</a>
62
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);
63
 
#define             <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-COMPOSITION-BLEND-FORMATS:CAPS" title="GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS">GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS</a>
64
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-blend" title="gst_video_overlay_composition_blend ()">gst_video_overlay_composition_blend</a> (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>,
65
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *video_buf</code></em>);
66
 
 
67
 
struct              <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayCompositionMeta" title="struct GstVideoOverlayCompositionMeta">GstVideoOverlayCompositionMeta</a>;
68
 
const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMeta.html#GstMetaInfo"><span class="returnvalue">GstMetaInfo</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-meta-get-info" title="gst_video_overlay_composition_meta_get_info ()">gst_video_overlay_composition_meta_get_info</a>
69
 
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
70
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayCompositionMeta" title="struct GstVideoOverlayCompositionMeta"><span class="returnvalue">GstVideoOverlayCompositionMeta</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-buffer-add-video-overlay-composition-meta" title="gst_buffer_add_video_overlay_composition_meta ()">gst_buffer_add_video_overlay_composition_meta</a>
71
 
                                                        (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>,
72
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);
73
 
#define             <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-buffer-get-video-overlay-composition-meta" title="gst_buffer_get_video_overlay_composition_meta()">gst_buffer_get_video_overlay_composition_meta</a>(b)
74
 
#define             <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-buffer-remove-video-overlay-composition-meta" title="gst_buffer_remove_video_overlay_composition_meta()">gst_buffer_remove_video_overlay_composition_meta</a>(b,
75
 
                                                         m)
76
 
 
77
 
enum                <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags">GstVideoOverlayFormatFlags</a>;
78
 
                    <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle">GstVideoOverlayRectangle</a>;
79
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-new-raw" title="gst_video_overlay_rectangle_new_raw ()">gst_video_overlay_rectangle_new_raw</a>
80
 
                                                        (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *pixels</code></em>,
81
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_x</code></em>,
82
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_y</code></em>,
83
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_width</code></em>,
84
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_height</code></em>,
85
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);
86
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-ref" title="gst_video_overlay_rectangle_ref ()">gst_video_overlay_rectangle_ref</a>
87
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *comp</code></em>);
88
 
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-unref" title="gst_video_overlay_rectangle_unref ()">gst_video_overlay_rectangle_unref</a>   (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *comp</code></em>);
89
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-raw" title="gst_video_overlay_rectangle_get_pixels_raw ()">gst_video_overlay_rectangle_get_pixels_raw</a>
90
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
91
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);
92
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-argb" title="gst_video_overlay_rectangle_get_pixels_argb ()">gst_video_overlay_rectangle_get_pixels_argb</a>
93
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
94
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);
95
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-ayuv" title="gst_video_overlay_rectangle_get_pixels_ayuv ()">gst_video_overlay_rectangle_get_pixels_ayuv</a>
96
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
97
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);
98
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-unscaled-raw" title="gst_video_overlay_rectangle_get_pixels_unscaled_raw ()">gst_video_overlay_rectangle_get_pixels_unscaled_raw</a>
99
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
100
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);
101
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-unscaled-argb" title="gst_video_overlay_rectangle_get_pixels_unscaled_argb ()">gst_video_overlay_rectangle_get_pixels_unscaled_argb</a>
102
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
103
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);
104
 
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-unscaled-ayuv" title="gst_video_overlay_rectangle_get_pixels_unscaled_ayuv ()">gst_video_overlay_rectangle_get_pixels_unscaled_ayuv</a>
105
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
106
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);
107
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()">gst_video_overlay_rectangle_get_render_rectangle</a>
108
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
109
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *render_x</code></em>,
110
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *render_y</code></em>,
111
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *render_width</code></em>,
112
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *render_height</code></em>);
113
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-seqnum" title="gst_video_overlay_rectangle_get_seqnum ()">gst_video_overlay_rectangle_get_seqnum</a>
114
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);
115
 
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-set-render-rectangle" title="gst_video_overlay_rectangle_set_render_rectangle ()">gst_video_overlay_rectangle_set_render_rectangle</a>
116
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
117
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_x</code></em>,
118
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_y</code></em>,
119
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_width</code></em>,
120
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_height</code></em>);
121
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> * <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-copy" title="gst_video_overlay_rectangle_copy ()">gst_video_overlay_rectangle_copy</a>
122
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);
123
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="returnvalue">GstVideoOverlayFormatFlags</span></a> <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-flags" title="gst_video_overlay_rectangle_get_flags ()">gst_video_overlay_rectangle_get_flags</a>
124
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);
125
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>              <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-global-alpha" title="gst_video_overlay_rectangle_get_global_alpha ()">gst_video_overlay_rectangle_get_global_alpha</a>
126
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);
127
 
<span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-set-global-alpha" title="gst_video_overlay_rectangle_set_global_alpha ()">gst_video_overlay_rectangle_set_global_alpha</a>
128
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
129
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> global_alpha</code></em>);
 
35
<div class="refsect1">
 
36
<a name="gst-plugins-base-libs-gstvideooverlaycomposition.functions"></a><h2>Functions</h2>
 
37
<div class="informaltable"><table width="100%" border="0">
 
38
<colgroup>
 
39
<col width="150px" class="functions_return">
 
40
<col class="functions_name">
 
41
</colgroup>
 
42
<tbody>
 
43
<tr>
 
44
<td class="function_type">
 
45
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> *
 
46
</td>
 
47
<td class="function_name">
 
48
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-new" title="gst_video_overlay_composition_new ()">gst_video_overlay_composition_new</a> <span class="c_punctuation">()</span>
 
49
</td>
 
50
</tr>
 
51
<tr>
 
52
<td class="function_type">
 
53
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> *
 
54
</td>
 
55
<td class="function_name">
 
56
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-ref" title="gst_video_overlay_composition_ref ()">gst_video_overlay_composition_ref</a> <span class="c_punctuation">()</span>
 
57
</td>
 
58
</tr>
 
59
<tr>
 
60
<td class="function_type">
 
61
<span class="returnvalue">void</span>
 
62
</td>
 
63
<td class="function_name">
 
64
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-unref" title="gst_video_overlay_composition_unref ()">gst_video_overlay_composition_unref</a> <span class="c_punctuation">()</span>
 
65
</td>
 
66
</tr>
 
67
<tr>
 
68
<td class="function_type">
 
69
<span class="returnvalue">void</span>
 
70
</td>
 
71
<td class="function_name">
 
72
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-add-rectangle" title="gst_video_overlay_composition_add_rectangle ()">gst_video_overlay_composition_add_rectangle</a> <span class="c_punctuation">()</span>
 
73
</td>
 
74
</tr>
 
75
<tr>
 
76
<td class="function_type">
 
77
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
 
78
</td>
 
79
<td class="function_name">
 
80
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-n-rectangles" title="gst_video_overlay_composition_n_rectangles ()">gst_video_overlay_composition_n_rectangles</a> <span class="c_punctuation">()</span>
 
81
</td>
 
82
</tr>
 
83
<tr>
 
84
<td class="function_type">
 
85
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> *
 
86
</td>
 
87
<td class="function_name">
 
88
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-get-rectangle" title="gst_video_overlay_composition_get_rectangle ()">gst_video_overlay_composition_get_rectangle</a> <span class="c_punctuation">()</span>
 
89
</td>
 
90
</tr>
 
91
<tr>
 
92
<td class="function_type">
 
93
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
 
94
</td>
 
95
<td class="function_name">
 
96
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-get-seqnum" title="gst_video_overlay_composition_get_seqnum ()">gst_video_overlay_composition_get_seqnum</a> <span class="c_punctuation">()</span>
 
97
</td>
 
98
</tr>
 
99
<tr>
 
100
<td class="function_type">
 
101
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> *
 
102
</td>
 
103
<td class="function_name">
 
104
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-copy" title="gst_video_overlay_composition_copy ()">gst_video_overlay_composition_copy</a> <span class="c_punctuation">()</span>
 
105
</td>
 
106
</tr>
 
107
<tr>
 
108
<td class="function_type">
 
109
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> *
 
110
</td>
 
111
<td class="function_name">
 
112
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-make-writable" title="gst_video_overlay_composition_make_writable ()">gst_video_overlay_composition_make_writable</a> <span class="c_punctuation">()</span>
 
113
</td>
 
114
</tr>
 
115
<tr>
 
116
<td class="function_type">
 
117
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
118
</td>
 
119
<td class="function_name">
 
120
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-blend" title="gst_video_overlay_composition_blend ()">gst_video_overlay_composition_blend</a> <span class="c_punctuation">()</span>
 
121
</td>
 
122
</tr>
 
123
<tr>
 
124
<td class="function_type">const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMeta.html#GstMetaInfo"><span class="returnvalue">GstMetaInfo</span></a> *
 
125
</td>
 
126
<td class="function_name">
 
127
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-meta-get-info" title="gst_video_overlay_composition_meta_get_info ()">gst_video_overlay_composition_meta_get_info</a> <span class="c_punctuation">()</span>
 
128
</td>
 
129
</tr>
 
130
<tr>
 
131
<td class="function_type">
 
132
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayCompositionMeta" title="struct GstVideoOverlayCompositionMeta"><span class="returnvalue">GstVideoOverlayCompositionMeta</span></a> *
 
133
</td>
 
134
<td class="function_name">
 
135
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-buffer-add-video-overlay-composition-meta" title="gst_buffer_add_video_overlay_composition_meta ()">gst_buffer_add_video_overlay_composition_meta</a> <span class="c_punctuation">()</span>
 
136
</td>
 
137
</tr>
 
138
<tr>
 
139
<td class="define_keyword">#define</td>
 
140
<td class="function_name">
 
141
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-buffer-get-video-overlay-composition-meta" title="gst_buffer_get_video_overlay_composition_meta()">gst_buffer_get_video_overlay_composition_meta</a><span class="c_punctuation">()</span>
 
142
</td>
 
143
</tr>
 
144
<tr>
 
145
<td class="define_keyword">#define</td>
 
146
<td class="function_name">
 
147
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-buffer-remove-video-overlay-composition-meta" title="gst_buffer_remove_video_overlay_composition_meta()">gst_buffer_remove_video_overlay_composition_meta</a><span class="c_punctuation">()</span>
 
148
</td>
 
149
</tr>
 
150
<tr>
 
151
<td class="function_type">
 
152
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> *
 
153
</td>
 
154
<td class="function_name">
 
155
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-new-raw" title="gst_video_overlay_rectangle_new_raw ()">gst_video_overlay_rectangle_new_raw</a> <span class="c_punctuation">()</span>
 
156
</td>
 
157
</tr>
 
158
<tr>
 
159
<td class="function_type">
 
160
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> *
 
161
</td>
 
162
<td class="function_name">
 
163
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-ref" title="gst_video_overlay_rectangle_ref ()">gst_video_overlay_rectangle_ref</a> <span class="c_punctuation">()</span>
 
164
</td>
 
165
</tr>
 
166
<tr>
 
167
<td class="function_type">
 
168
<span class="returnvalue">void</span>
 
169
</td>
 
170
<td class="function_name">
 
171
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-unref" title="gst_video_overlay_rectangle_unref ()">gst_video_overlay_rectangle_unref</a> <span class="c_punctuation">()</span>
 
172
</td>
 
173
</tr>
 
174
<tr>
 
175
<td class="function_type">
 
176
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
177
</td>
 
178
<td class="function_name">
 
179
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-raw" title="gst_video_overlay_rectangle_get_pixels_raw ()">gst_video_overlay_rectangle_get_pixels_raw</a> <span class="c_punctuation">()</span>
 
180
</td>
 
181
</tr>
 
182
<tr>
 
183
<td class="function_type">
 
184
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
185
</td>
 
186
<td class="function_name">
 
187
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-argb" title="gst_video_overlay_rectangle_get_pixels_argb ()">gst_video_overlay_rectangle_get_pixels_argb</a> <span class="c_punctuation">()</span>
 
188
</td>
 
189
</tr>
 
190
<tr>
 
191
<td class="function_type">
 
192
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
193
</td>
 
194
<td class="function_name">
 
195
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-ayuv" title="gst_video_overlay_rectangle_get_pixels_ayuv ()">gst_video_overlay_rectangle_get_pixels_ayuv</a> <span class="c_punctuation">()</span>
 
196
</td>
 
197
</tr>
 
198
<tr>
 
199
<td class="function_type">
 
200
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
201
</td>
 
202
<td class="function_name">
 
203
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-unscaled-raw" title="gst_video_overlay_rectangle_get_pixels_unscaled_raw ()">gst_video_overlay_rectangle_get_pixels_unscaled_raw</a> <span class="c_punctuation">()</span>
 
204
</td>
 
205
</tr>
 
206
<tr>
 
207
<td class="function_type">
 
208
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
209
</td>
 
210
<td class="function_name">
 
211
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-unscaled-argb" title="gst_video_overlay_rectangle_get_pixels_unscaled_argb ()">gst_video_overlay_rectangle_get_pixels_unscaled_argb</a> <span class="c_punctuation">()</span>
 
212
</td>
 
213
</tr>
 
214
<tr>
 
215
<td class="function_type">
 
216
<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
217
</td>
 
218
<td class="function_name">
 
219
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-pixels-unscaled-ayuv" title="gst_video_overlay_rectangle_get_pixels_unscaled_ayuv ()">gst_video_overlay_rectangle_get_pixels_unscaled_ayuv</a> <span class="c_punctuation">()</span>
 
220
</td>
 
221
</tr>
 
222
<tr>
 
223
<td class="function_type">
 
224
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
225
</td>
 
226
<td class="function_name">
 
227
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()">gst_video_overlay_rectangle_get_render_rectangle</a> <span class="c_punctuation">()</span>
 
228
</td>
 
229
</tr>
 
230
<tr>
 
231
<td class="function_type">
 
232
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
 
233
</td>
 
234
<td class="function_name">
 
235
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-seqnum" title="gst_video_overlay_rectangle_get_seqnum ()">gst_video_overlay_rectangle_get_seqnum</a> <span class="c_punctuation">()</span>
 
236
</td>
 
237
</tr>
 
238
<tr>
 
239
<td class="function_type">
 
240
<span class="returnvalue">void</span>
 
241
</td>
 
242
<td class="function_name">
 
243
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-set-render-rectangle" title="gst_video_overlay_rectangle_set_render_rectangle ()">gst_video_overlay_rectangle_set_render_rectangle</a> <span class="c_punctuation">()</span>
 
244
</td>
 
245
</tr>
 
246
<tr>
 
247
<td class="function_type">
 
248
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> *
 
249
</td>
 
250
<td class="function_name">
 
251
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-copy" title="gst_video_overlay_rectangle_copy ()">gst_video_overlay_rectangle_copy</a> <span class="c_punctuation">()</span>
 
252
</td>
 
253
</tr>
 
254
<tr>
 
255
<td class="function_type">
 
256
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="returnvalue">GstVideoOverlayFormatFlags</span></a>
 
257
</td>
 
258
<td class="function_name">
 
259
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-flags" title="gst_video_overlay_rectangle_get_flags ()">gst_video_overlay_rectangle_get_flags</a> <span class="c_punctuation">()</span>
 
260
</td>
 
261
</tr>
 
262
<tr>
 
263
<td class="function_type">
 
264
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>
 
265
</td>
 
266
<td class="function_name">
 
267
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-global-alpha" title="gst_video_overlay_rectangle_get_global_alpha ()">gst_video_overlay_rectangle_get_global_alpha</a> <span class="c_punctuation">()</span>
 
268
</td>
 
269
</tr>
 
270
<tr>
 
271
<td class="function_type">
 
272
<span class="returnvalue">void</span>
 
273
</td>
 
274
<td class="function_name">
 
275
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-set-global-alpha" title="gst_video_overlay_rectangle_set_global_alpha ()">gst_video_overlay_rectangle_set_global_alpha</a> <span class="c_punctuation">()</span>
 
276
</td>
 
277
</tr>
 
278
</tbody>
 
279
</table></div>
 
280
</div>
 
281
<div class="refsect1">
 
282
<a name="gst-plugins-base-libs-gstvideooverlaycomposition.other"></a><h2>Types and Values</h2>
 
283
<div class="informaltable"><table width="100%" border="0">
 
284
<colgroup>
 
285
<col width="150px" class="name">
 
286
<col class="description">
 
287
</colgroup>
 
288
<tbody>
 
289
<tr>
 
290
<td class="datatype_keyword"> </td>
 
291
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition">GstVideoOverlayComposition</a></td>
 
292
</tr>
 
293
<tr>
 
294
<td class="define_keyword">#define</td>
 
295
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-COMPOSITION-BLEND-FORMATS:CAPS" title="GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS">GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS</a></td>
 
296
</tr>
 
297
<tr>
 
298
<td class="datatype_keyword">struct</td>
 
299
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayCompositionMeta" title="struct GstVideoOverlayCompositionMeta">GstVideoOverlayCompositionMeta</a></td>
 
300
</tr>
 
301
<tr>
 
302
<td class="datatype_keyword">enum</td>
 
303
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags">GstVideoOverlayFormatFlags</a></td>
 
304
</tr>
 
305
<tr>
 
306
<td class="datatype_keyword"> </td>
 
307
<td class="function_name"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle">GstVideoOverlayRectangle</a></td>
 
308
</tr>
 
309
</tbody>
 
310
</table></div>
 
311
</div>
 
312
<div class="refsect1">
 
313
<a name="gst-plugins-base-libs-gstvideooverlaycomposition.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
314
<pre class="screen">
 
315
</pre>
 
316
</div>
 
317
<div class="refsect1">
 
318
<a name="gst-plugins-base-libs-gstvideooverlaycomposition.includes"></a><h2>Includes</h2>
 
319
<pre class="synopsis">#include &lt;gst/video/video-overlay-composition.h&gt;
130
320
</pre>
131
321
</div>
132
322
<div class="refsect1">
133
323
<a name="gst-plugins-base-libs-gstvideooverlaycomposition.description"></a><h2>Description</h2>
134
 
<p>
135
 
</p>
136
324
<div class="refsect2">
137
 
<a name="id-1.2.14.5.4.2.1"></a><p>
 
325
<a name="id-1.2.14.5.7.2"></a><p>
138
326
Functions to create and handle overlay compositions on video buffers.
139
327
</p>
140
328
<p>
162
350
<p>
163
351
</p>
164
352
</div>
165
 
<p>
166
 
</p>
167
353
</div>
168
354
<div class="refsect1">
169
 
<a name="gst-plugins-base-libs-gstvideooverlaycomposition.details"></a><h2>Details</h2>
170
 
<div class="refsect2">
171
 
<a name="GstVideoOverlayComposition"></a><h3>GstVideoOverlayComposition</h3>
172
 
<pre class="programlisting">typedef struct _GstVideoOverlayComposition GstVideoOverlayComposition;</pre>
173
 
<p>
174
 
An opaque video overlay composition object. A composition contains
175
 
multiple overlay rectangles.
176
 
</p>
177
 
</div>
178
 
<hr>
179
 
<div class="refsect2">
180
 
<a name="gst-video-overlay-composition-new"></a><h3>gst_video_overlay_composition_new ()</h3>
181
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> * gst_video_overlay_composition_new
182
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
183
 
<p>
184
 
Creates a new video overlay composition object to hold one or more
185
 
overlay rectangles.
186
 
</p>
187
 
<div class="variablelist"><table border="0" class="variablelist">
188
 
<colgroup>
189
 
<col align="left" valign="top">
190
 
<col>
191
 
</colgroup>
192
 
<tbody>
193
 
<tr>
194
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
195
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> to add to the
196
 
composition. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
197
 
</td>
198
 
</tr>
199
 
<tr>
200
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
201
 
<td>a new <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>. Unref with
202
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-unref" title="gst_video_overlay_composition_unref ()"><code class="function">gst_video_overlay_composition_unref()</code></a> when no longer needed. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
203
 
</td>
204
 
</tr>
205
 
</tbody>
206
 
</table></div>
207
 
</div>
208
 
<hr>
209
 
<div class="refsect2">
210
 
<a name="gst-video-overlay-composition-ref"></a><h3>gst_video_overlay_composition_ref ()</h3>
211
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> * gst_video_overlay_composition_ref
212
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
213
 
<p>
214
 
Increases the refcount of the given composition by one.
215
 
</p>
216
 
<p>
217
 
Note that the refcount affects the writeability
218
 
of <em class="parameter"><code>comp</code></em>, use <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-make-writable" title="gst_video_overlay_composition_make_writable ()"><code class="function">gst_video_overlay_composition_make_writable()</code></a> to ensure
219
 
a composition and its rectangles can be modified.
220
 
</p>
221
 
<div class="variablelist"><table border="0" class="variablelist">
222
 
<colgroup>
223
 
<col align="left" valign="top">
224
 
<col>
225
 
</colgroup>
226
 
<tbody>
227
 
<tr>
228
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
229
 
<td>a a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>.</td>
230
 
</tr>
231
 
<tr>
232
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
233
 
<td>
234
 
<em class="parameter"><code>comp</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
235
 
</td>
236
 
</tr>
237
 
</tbody>
238
 
</table></div>
239
 
</div>
240
 
<hr>
241
 
<div class="refsect2">
242
 
<a name="gst-video-overlay-composition-unref"></a><h3>gst_video_overlay_composition_unref ()</h3>
243
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_video_overlay_composition_unref (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
244
 
<p>
245
 
Decreases the refcount of the composition. If the refcount reaches 0, the
246
 
composition will be freed.
247
 
</p>
248
 
<div class="variablelist"><table border="0" class="variablelist">
249
 
<colgroup>
250
 
<col align="left" valign="top">
251
 
<col>
252
 
</colgroup>
253
 
<tbody><tr>
254
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
255
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
256
 
</td>
257
 
</tr></tbody>
258
 
</table></div>
259
 
</div>
260
 
<hr>
261
 
<div class="refsect2">
262
 
<a name="gst-video-overlay-composition-add-rectangle"></a><h3>gst_video_overlay_composition_add_rectangle ()</h3>
263
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_video_overlay_composition_add_rectangle
264
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>,
265
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
266
 
<p>
267
 
Adds an overlay rectangle to an existing overlay composition object. This
268
 
must be done right after creating the overlay composition.
269
 
</p>
270
 
<div class="variablelist"><table border="0" class="variablelist">
271
 
<colgroup>
272
 
<col align="left" valign="top">
273
 
<col>
274
 
</colgroup>
275
 
<tbody>
276
 
<tr>
277
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
278
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>
279
 
</td>
280
 
</tr>
281
 
<tr>
282
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
283
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> to add to the
284
 
composition. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
285
 
</td>
286
 
</tr>
287
 
</tbody>
288
 
</table></div>
289
 
</div>
290
 
<hr>
291
 
<div class="refsect2">
292
 
<a name="gst-video-overlay-composition-n-rectangles"></a><h3>gst_video_overlay_composition_n_rectangles ()</h3>
293
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gst_video_overlay_composition_n_rectangles
294
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
295
 
<p>
296
 
Returns the number of <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>s contained in <em class="parameter"><code>comp</code></em>.
297
 
</p>
298
 
<div class="variablelist"><table border="0" class="variablelist">
299
 
<colgroup>
300
 
<col align="left" valign="top">
301
 
<col>
302
 
</colgroup>
303
 
<tbody>
304
 
<tr>
305
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
306
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>
307
 
</td>
308
 
</tr>
309
 
<tr>
310
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
311
 
<td>the number of rectangles</td>
312
 
</tr>
313
 
</tbody>
314
 
</table></div>
315
 
</div>
316
 
<hr>
317
 
<div class="refsect2">
318
 
<a name="gst-video-overlay-composition-get-rectangle"></a><h3>gst_video_overlay_composition_get_rectangle ()</h3>
319
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> * gst_video_overlay_composition_get_rectangle
320
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>,
321
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);</pre>
322
 
<p>
323
 
Returns the <em class="parameter"><code>n</code></em>-th <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> contained in <em class="parameter"><code>comp</code></em>.
324
 
</p>
325
 
<div class="variablelist"><table border="0" class="variablelist">
326
 
<colgroup>
327
 
<col align="left" valign="top">
328
 
<col>
329
 
</colgroup>
330
 
<tbody>
331
 
<tr>
332
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
333
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>
334
 
</td>
335
 
</tr>
336
 
<tr>
337
 
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
338
 
<td>number of the rectangle to get</td>
339
 
</tr>
340
 
<tr>
341
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
342
 
<td>the <em class="parameter"><code>n</code></em>-th rectangle, or NULL if <em class="parameter"><code>n</code></em> is out of
 
355
<a name="gst-plugins-base-libs-gstvideooverlaycomposition.functions_details"></a><h2>Functions</h2>
 
356
<div class="refsect2">
 
357
<a name="gst-video-overlay-composition-new"></a><h3>gst_video_overlay_composition_new ()</h3>
 
358
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> *
 
359
gst_video_overlay_composition_new (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
 
360
<p>Creates a new video overlay composition object to hold one or more
 
361
overlay rectangles.</p>
 
362
<div class="refsect3">
 
363
<a name="id-1.2.14.5.8.2.5"></a><h4>Parameters</h4>
 
364
<div class="informaltable"><table width="100%" border="0">
 
365
<colgroup>
 
366
<col width="150px" class="parameters_name">
 
367
<col class="parameters_description">
 
368
<col width="200px" class="parameters_annotations">
 
369
</colgroup>
 
370
<tbody><tr>
 
371
<td class="parameter_name"><p>rectangle</p></td>
 
372
<td class="parameter_description"><p> a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> to add to the
 
373
composition. </p></td>
 
374
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 
375
</tr></tbody>
 
376
</table></div>
 
377
</div>
 
378
<div class="refsect3">
 
379
<a name="id-1.2.14.5.8.2.6"></a><h4>Returns</h4>
 
380
<p> a new <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>. Unref with
 
381
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-unref" title="gst_video_overlay_composition_unref ()"><code class="function">gst_video_overlay_composition_unref()</code></a> when no longer needed. </p>
 
382
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
383
</div>
 
384
</div>
 
385
<hr>
 
386
<div class="refsect2">
 
387
<a name="gst-video-overlay-composition-ref"></a><h3>gst_video_overlay_composition_ref ()</h3>
 
388
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> *
 
389
gst_video_overlay_composition_ref (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
 
390
<p>Increases the refcount of the given composition by one.</p>
 
391
<p>Note that the refcount affects the writeability
 
392
of <em class="parameter"><code>comp</code></em>
 
393
, use <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-make-writable" title="gst_video_overlay_composition_make_writable ()"><code class="function">gst_video_overlay_composition_make_writable()</code></a> to ensure
 
394
a composition and its rectangles can be modified.</p>
 
395
<div class="refsect3">
 
396
<a name="id-1.2.14.5.8.3.6"></a><h4>Parameters</h4>
 
397
<div class="informaltable"><table width="100%" border="0">
 
398
<colgroup>
 
399
<col width="150px" class="parameters_name">
 
400
<col class="parameters_description">
 
401
<col width="200px" class="parameters_annotations">
 
402
</colgroup>
 
403
<tbody><tr>
 
404
<td class="parameter_name"><p>comp</p></td>
 
405
<td class="parameter_description"><p>a a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>.</p></td>
 
406
<td class="parameter_annotations"> </td>
 
407
</tr></tbody>
 
408
</table></div>
 
409
</div>
 
410
<div class="refsect3">
 
411
<a name="id-1.2.14.5.8.3.7"></a><h4>Returns</h4>
 
412
<p> <em class="parameter"><code>comp</code></em>
 
413
. </p>
 
414
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
415
</div>
 
416
</div>
 
417
<hr>
 
418
<div class="refsect2">
 
419
<a name="gst-video-overlay-composition-unref"></a><h3>gst_video_overlay_composition_unref ()</h3>
 
420
<pre class="programlisting"><span class="returnvalue">void</span>
 
421
gst_video_overlay_composition_unref (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
 
422
<p>Decreases the refcount of the composition. If the refcount reaches 0, the
 
423
composition will be freed.</p>
 
424
<div class="refsect3">
 
425
<a name="id-1.2.14.5.8.4.5"></a><h4>Parameters</h4>
 
426
<div class="informaltable"><table width="100%" border="0">
 
427
<colgroup>
 
428
<col width="150px" class="parameters_name">
 
429
<col class="parameters_description">
 
430
<col width="200px" class="parameters_annotations">
 
431
</colgroup>
 
432
<tbody><tr>
 
433
<td class="parameter_name"><p>comp</p></td>
 
434
<td class="parameter_description"><p> a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>. </p></td>
 
435
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
 
436
</tr></tbody>
 
437
</table></div>
 
438
</div>
 
439
</div>
 
440
<hr>
 
441
<div class="refsect2">
 
442
<a name="gst-video-overlay-composition-add-rectangle"></a><h3>gst_video_overlay_composition_add_rectangle ()</h3>
 
443
<pre class="programlisting"><span class="returnvalue">void</span>
 
444
gst_video_overlay_composition_add_rectangle
 
445
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>,
 
446
                                <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
 
447
<p>Adds an overlay rectangle to an existing overlay composition object. This
 
448
must be done right after creating the overlay composition.</p>
 
449
<div class="refsect3">
 
450
<a name="id-1.2.14.5.8.5.5"></a><h4>Parameters</h4>
 
451
<div class="informaltable"><table width="100%" border="0">
 
452
<colgroup>
 
453
<col width="150px" class="parameters_name">
 
454
<col class="parameters_description">
 
455
<col width="200px" class="parameters_annotations">
 
456
</colgroup>
 
457
<tbody>
 
458
<tr>
 
459
<td class="parameter_name"><p>comp</p></td>
 
460
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a></p></td>
 
461
<td class="parameter_annotations"> </td>
 
462
</tr>
 
463
<tr>
 
464
<td class="parameter_name"><p>rectangle</p></td>
 
465
<td class="parameter_description"><p> a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> to add to the
 
466
composition. </p></td>
 
467
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 
468
</tr>
 
469
</tbody>
 
470
</table></div>
 
471
</div>
 
472
</div>
 
473
<hr>
 
474
<div class="refsect2">
 
475
<a name="gst-video-overlay-composition-n-rectangles"></a><h3>gst_video_overlay_composition_n_rectangles ()</h3>
 
476
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
 
477
gst_video_overlay_composition_n_rectangles
 
478
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
 
479
<p>Returns the number of <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>s contained in <em class="parameter"><code>comp</code></em>
 
480
.</p>
 
481
<div class="refsect3">
 
482
<a name="id-1.2.14.5.8.6.5"></a><h4>Parameters</h4>
 
483
<div class="informaltable"><table width="100%" border="0">
 
484
<colgroup>
 
485
<col width="150px" class="parameters_name">
 
486
<col class="parameters_description">
 
487
<col width="200px" class="parameters_annotations">
 
488
</colgroup>
 
489
<tbody><tr>
 
490
<td class="parameter_name"><p>comp</p></td>
 
491
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a></p></td>
 
492
<td class="parameter_annotations"> </td>
 
493
</tr></tbody>
 
494
</table></div>
 
495
</div>
 
496
<div class="refsect3">
 
497
<a name="id-1.2.14.5.8.6.6"></a><h4>Returns</h4>
 
498
<p> the number of rectangles</p>
 
499
<p></p>
 
500
</div>
 
501
</div>
 
502
<hr>
 
503
<div class="refsect2">
 
504
<a name="gst-video-overlay-composition-get-rectangle"></a><h3>gst_video_overlay_composition_get_rectangle ()</h3>
 
505
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> *
 
506
gst_video_overlay_composition_get_rectangle
 
507
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>,
 
508
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);</pre>
 
509
<p>Returns the <em class="parameter"><code>n</code></em>
 
510
-th <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> contained in <em class="parameter"><code>comp</code></em>
 
511
.</p>
 
512
<div class="refsect3">
 
513
<a name="id-1.2.14.5.8.7.5"></a><h4>Parameters</h4>
 
514
<div class="informaltable"><table width="100%" border="0">
 
515
<colgroup>
 
516
<col width="150px" class="parameters_name">
 
517
<col class="parameters_description">
 
518
<col width="200px" class="parameters_annotations">
 
519
</colgroup>
 
520
<tbody>
 
521
<tr>
 
522
<td class="parameter_name"><p>comp</p></td>
 
523
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a></p></td>
 
524
<td class="parameter_annotations"> </td>
 
525
</tr>
 
526
<tr>
 
527
<td class="parameter_name"><p>n</p></td>
 
528
<td class="parameter_description"><p>number of the rectangle to get</p></td>
 
529
<td class="parameter_annotations"> </td>
 
530
</tr>
 
531
</tbody>
 
532
</table></div>
 
533
</div>
 
534
<div class="refsect3">
 
535
<a name="id-1.2.14.5.8.7.6"></a><h4>Returns</h4>
 
536
<p> the <em class="parameter"><code>n</code></em>
 
537
-th rectangle, or NULL if <em class="parameter"><code>n</code></em>
 
538
is out of
343
539
bounds. Will not return a new reference, the caller will need to
344
 
obtain her own reference using <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-ref" title="gst_video_overlay_rectangle_ref ()"><code class="function">gst_video_overlay_rectangle_ref()</code></a>
345
 
if needed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
346
 
</td>
347
 
</tr>
348
 
</tbody>
349
 
</table></div>
 
540
obtain her own reference using <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-ref" title="gst_video_overlay_rectangle_ref ()"><code class="function">gst_video_overlay_rectangle_ref()</code></a>
 
541
if needed. </p>
 
542
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
543
</div>
350
544
</div>
351
545
<hr>
352
546
<div class="refsect2">
353
 
<a name="gst-video-overlay-composition-get-seqnum"></a><h3>gst_video_overlay_composition_get_seqnum ()</h3>
354
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gst_video_overlay_composition_get_seqnum
355
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
356
 
<p>
357
 
Returns the sequence number of this composition. Sequence numbers are
 
547
<a name="gst-video-overlay-composition-get-seqnum"></a><h3>gst_video_overlay_composition_get_seqnum ()</h3>
 
548
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
 
549
gst_video_overlay_composition_get_seqnum
 
550
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
 
551
<p>Returns the sequence number of this composition. Sequence numbers are
358
552
monotonically increasing and unique for overlay compositions and rectangles
359
553
(meaning there will never be a rectangle with the same sequence number as
360
 
a composition).
361
 
</p>
362
 
<div class="variablelist"><table border="0" class="variablelist">
 
554
a composition).</p>
 
555
<div class="refsect3">
 
556
<a name="id-1.2.14.5.8.8.5"></a><h4>Parameters</h4>
 
557
<div class="informaltable"><table width="100%" border="0">
363
558
<colgroup>
364
 
<col align="left" valign="top">
365
 
<col>
 
559
<col width="150px" class="parameters_name">
 
560
<col class="parameters_description">
 
561
<col width="200px" class="parameters_annotations">
366
562
</colgroup>
367
 
<tbody>
368
 
<tr>
369
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
370
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>
371
 
</td>
372
 
</tr>
373
 
<tr>
374
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
375
 
<td>the sequence number of <em class="parameter"><code>comp</code></em>
376
 
</td>
377
 
</tr>
378
 
</tbody>
 
563
<tbody><tr>
 
564
<td class="parameter_name"><p>comp</p></td>
 
565
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a></p></td>
 
566
<td class="parameter_annotations"> </td>
 
567
</tr></tbody>
379
568
</table></div>
380
569
</div>
 
570
<div class="refsect3">
 
571
<a name="id-1.2.14.5.8.8.6"></a><h4>Returns</h4>
 
572
<p> the sequence number of <em class="parameter"><code>comp</code></em>
 
573
</p>
 
574
<p></p>
 
575
</div>
 
576
</div>
381
577
<hr>
382
578
<div class="refsect2">
383
 
<a name="gst-video-overlay-composition-copy"></a><h3>gst_video_overlay_composition_copy ()</h3>
384
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> * gst_video_overlay_composition_copy
385
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
386
 
<p>
387
 
Makes a copy of <em class="parameter"><code>comp</code></em> and all contained rectangles, so that it is possible
 
579
<a name="gst-video-overlay-composition-copy"></a><h3>gst_video_overlay_composition_copy ()</h3>
 
580
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> *
 
581
gst_video_overlay_composition_copy (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
 
582
<p>Makes a copy of <em class="parameter"><code>comp</code></em>
 
583
 and all contained rectangles, so that it is possible
388
584
to modify the composition and contained rectangles (e.g. add additional
389
585
rectangles or change the render co-ordinates or render dimension). The
390
586
actual overlay pixel data buffers contained in the rectangles are not
391
 
copied.
392
 
</p>
393
 
<div class="variablelist"><table border="0" class="variablelist">
 
587
copied.</p>
 
588
<div class="refsect3">
 
589
<a name="id-1.2.14.5.8.9.5"></a><h4>Parameters</h4>
 
590
<div class="informaltable"><table width="100%" border="0">
394
591
<colgroup>
395
 
<col align="left" valign="top">
396
 
<col>
 
592
<col width="150px" class="parameters_name">
 
593
<col class="parameters_description">
 
594
<col width="200px" class="parameters_annotations">
397
595
</colgroup>
398
 
<tbody>
399
 
<tr>
400
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
401
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> to copy. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
402
 
</td>
403
 
</tr>
404
 
<tr>
405
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
406
 
<td>a new <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> equivalent
407
 
to <em class="parameter"><code>comp</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
408
 
</td>
409
 
</tr>
410
 
</tbody>
 
596
<tbody><tr>
 
597
<td class="parameter_name"><p>comp</p></td>
 
598
<td class="parameter_description"><p> a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> to copy. </p></td>
 
599
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 
600
</tr></tbody>
411
601
</table></div>
412
602
</div>
 
603
<div class="refsect3">
 
604
<a name="id-1.2.14.5.8.9.6"></a><h4>Returns</h4>
 
605
<p> a new <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> equivalent
 
606
to <em class="parameter"><code>comp</code></em>
 
607
. </p>
 
608
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
609
</div>
 
610
</div>
413
611
<hr>
414
612
<div class="refsect2">
415
 
<a name="gst-video-overlay-composition-make-writable"></a><h3>gst_video_overlay_composition_make_writable ()</h3>
416
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> * gst_video_overlay_composition_make_writable
417
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
418
 
<p>
419
 
Takes ownership of <em class="parameter"><code>comp</code></em> and returns a version of <em class="parameter"><code>comp</code></em> that is writable
420
 
(i.e. can be modified). Will either return <em class="parameter"><code>comp</code></em> right away, or create a
421
 
new writable copy of <em class="parameter"><code>comp</code></em> and unref <em class="parameter"><code>comp</code></em> itself. All the contained
 
613
<a name="gst-video-overlay-composition-make-writable"></a><h3>gst_video_overlay_composition_make_writable ()</h3>
 
614
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="returnvalue">GstVideoOverlayComposition</span></a> *
 
615
gst_video_overlay_composition_make_writable
 
616
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
 
617
<p>Takes ownership of <em class="parameter"><code>comp</code></em>
 
618
 and returns a version of <em class="parameter"><code>comp</code></em>
 
619
 that is writable
 
620
(i.e. can be modified). Will either return <em class="parameter"><code>comp</code></em>
 
621
 right away, or create a
 
622
new writable copy of <em class="parameter"><code>comp</code></em>
 
623
 and unref <em class="parameter"><code>comp</code></em>
 
624
 itself. All the contained
422
625
rectangles will also be copied, but the actual overlay pixel data buffers
423
 
contained in the rectangles are not copied.
424
 
</p>
425
 
<div class="variablelist"><table border="0" class="variablelist">
426
 
<colgroup>
427
 
<col align="left" valign="top">
428
 
<col>
429
 
</colgroup>
430
 
<tbody>
431
 
<tr>
432
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
433
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> to copy. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
434
 
</td>
435
 
</tr>
436
 
<tr>
437
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
438
 
<td>a writable <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>
439
 
equivalent to <em class="parameter"><code>comp</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
440
 
</td>
441
 
</tr>
442
 
</tbody>
443
 
</table></div>
444
 
</div>
445
 
<hr>
446
 
<div class="refsect2">
447
 
<a name="GST-VIDEO-OVERLAY-COMPOSITION-BLEND-FORMATS:CAPS"></a><h3>GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS</h3>
448
 
<pre class="programlisting">#define             GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS</pre>
449
 
<p>
450
 
Video formats supported by <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-blend" title="gst_video_overlay_composition_blend ()"><code class="function">gst_video_overlay_composition_blend()</code></a>, for
451
 
use in overlay elements' pad template caps.
452
 
</p>
453
 
<p class="since">Since 1.2</p>
454
 
</div>
455
 
<hr>
456
 
<div class="refsect2">
457
 
<a name="gst-video-overlay-composition-blend"></a><h3>gst_video_overlay_composition_blend ()</h3>
458
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_video_overlay_composition_blend (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>,
459
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *video_buf</code></em>);</pre>
460
 
<p>
461
 
Blends the overlay rectangles in <em class="parameter"><code>comp</code></em> on top of the raw video data
462
 
contained in <em class="parameter"><code>video_buf</code></em>. The data in <em class="parameter"><code>video_buf</code></em> must be writable and
463
 
mapped appropriately.
464
 
</p>
465
 
<div class="variablelist"><table border="0" class="variablelist">
466
 
<colgroup>
467
 
<col align="left" valign="top">
468
 
<col>
469
 
</colgroup>
470
 
<tbody>
471
 
<tr>
472
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
473
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>
474
 
</td>
475
 
</tr>
476
 
<tr>
477
 
<td><p><span class="term"><em class="parameter"><code>video_buf</code></em> :</span></p></td>
478
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> containing raw video data in a supported format</td>
479
 
</tr>
480
 
</tbody>
481
 
</table></div>
482
 
</div>
483
 
<hr>
484
 
<div class="refsect2">
485
 
<a name="GstVideoOverlayCompositionMeta"></a><h3>struct GstVideoOverlayCompositionMeta</h3>
486
 
<pre class="programlisting">struct GstVideoOverlayCompositionMeta {
487
 
  GstMeta meta;
488
 
 
489
 
  GstVideoOverlayComposition *overlay;
490
 
};
491
 
</pre>
492
 
<p>
493
 
Extra buffer metadata describing image overlay data.
494
 
</p>
495
 
<div class="variablelist"><table border="0" class="variablelist">
496
 
<colgroup>
497
 
<col align="left" valign="top">
498
 
<col>
499
 
</colgroup>
500
 
<tbody>
501
 
<tr>
502
 
<td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMeta.html#GstMeta"><span class="type">GstMeta</span></a> <em class="structfield"><code><a name="GstVideoOverlayCompositionMeta.meta"></a>meta</code></em>;</span></p></td>
503
 
<td>parent <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMeta.html#GstMeta"><span class="type">GstMeta</span></a>
504
 
</td>
505
 
</tr>
506
 
<tr>
507
 
<td><p><span class="term"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *<em class="structfield"><code><a name="GstVideoOverlayCompositionMeta.overlay"></a>overlay</code></em>;</span></p></td>
508
 
<td>the attached <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>
509
 
</td>
510
 
</tr>
511
 
</tbody>
512
 
</table></div>
513
 
</div>
514
 
<hr>
515
 
<div class="refsect2">
516
 
<a name="gst-video-overlay-composition-meta-get-info"></a><h3>gst_video_overlay_composition_meta_get_info ()</h3>
517
 
<pre class="programlisting">const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMeta.html#GstMetaInfo"><span class="returnvalue">GstMetaInfo</span></a> * gst_video_overlay_composition_meta_get_info
518
 
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
519
 
</div>
520
 
<hr>
521
 
<div class="refsect2">
522
 
<a name="gst-buffer-add-video-overlay-composition-meta"></a><h3>gst_buffer_add_video_overlay_composition_meta ()</h3>
523
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayCompositionMeta" title="struct GstVideoOverlayCompositionMeta"><span class="returnvalue">GstVideoOverlayCompositionMeta</span></a> * gst_buffer_add_video_overlay_composition_meta
524
 
                                                        (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>,
525
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
526
 
<p>
527
 
Sets an overlay composition on a buffer. The buffer will obtain its own
 
626
contained in the rectangles are not copied.</p>
 
627
<div class="refsect3">
 
628
<a name="id-1.2.14.5.8.10.5"></a><h4>Parameters</h4>
 
629
<div class="informaltable"><table width="100%" border="0">
 
630
<colgroup>
 
631
<col width="150px" class="parameters_name">
 
632
<col class="parameters_description">
 
633
<col width="200px" class="parameters_annotations">
 
634
</colgroup>
 
635
<tbody><tr>
 
636
<td class="parameter_name"><p>comp</p></td>
 
637
<td class="parameter_description"><p> a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> to copy. </p></td>
 
638
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
 
639
</tr></tbody>
 
640
</table></div>
 
641
</div>
 
642
<div class="refsect3">
 
643
<a name="id-1.2.14.5.8.10.6"></a><h4>Returns</h4>
 
644
<p> a writable <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>
 
645
equivalent to <em class="parameter"><code>comp</code></em>
 
646
. </p>
 
647
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
648
</div>
 
649
</div>
 
650
<hr>
 
651
<div class="refsect2">
 
652
<a name="gst-video-overlay-composition-blend"></a><h3>gst_video_overlay_composition_blend ()</h3>
 
653
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
654
gst_video_overlay_composition_blend (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>,
 
655
                                     <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> *video_buf</code></em>);</pre>
 
656
<p>Blends the overlay rectangles in <em class="parameter"><code>comp</code></em>
 
657
 on top of the raw video data
 
658
contained in <em class="parameter"><code>video_buf</code></em>
 
659
. The data in <em class="parameter"><code>video_buf</code></em>
 
660
 must be writable and
 
661
mapped appropriately.</p>
 
662
<div class="refsect3">
 
663
<a name="id-1.2.14.5.8.11.5"></a><h4>Parameters</h4>
 
664
<div class="informaltable"><table width="100%" border="0">
 
665
<colgroup>
 
666
<col width="150px" class="parameters_name">
 
667
<col class="parameters_description">
 
668
<col width="200px" class="parameters_annotations">
 
669
</colgroup>
 
670
<tbody>
 
671
<tr>
 
672
<td class="parameter_name"><p>comp</p></td>
 
673
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a></p></td>
 
674
<td class="parameter_annotations"> </td>
 
675
</tr>
 
676
<tr>
 
677
<td class="parameter_name"><p>video_buf</p></td>
 
678
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideo.html#GstVideoFrame" title="struct GstVideoFrame"><span class="type">GstVideoFrame</span></a> containing raw video data in a supported format</p></td>
 
679
<td class="parameter_annotations"> </td>
 
680
</tr>
 
681
</tbody>
 
682
</table></div>
 
683
</div>
 
684
</div>
 
685
<hr>
 
686
<div class="refsect2">
 
687
<a name="gst-video-overlay-composition-meta-get-info"></a><h3>gst_video_overlay_composition_meta_get_info ()</h3>
 
688
<pre class="programlisting">const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMeta.html#GstMetaInfo"><span class="returnvalue">GstMetaInfo</span></a> *
 
689
gst_video_overlay_composition_meta_get_info
 
690
                               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
691
</div>
 
692
<hr>
 
693
<div class="refsect2">
 
694
<a name="gst-buffer-add-video-overlay-composition-meta"></a><h3>gst_buffer_add_video_overlay_composition_meta ()</h3>
 
695
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayCompositionMeta" title="struct GstVideoOverlayCompositionMeta"><span class="returnvalue">GstVideoOverlayCompositionMeta</span></a> *
 
696
gst_buffer_add_video_overlay_composition_meta
 
697
                               (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *buf</code></em>,
 
698
                                <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *comp</code></em>);</pre>
 
699
<p>Sets an overlay composition on a buffer. The buffer will obtain its own
528
700
reference to the composition, meaning this function does not take ownership
529
 
of <em class="parameter"><code>comp</code></em>.
530
 
</p>
531
 
<div class="variablelist"><table border="0" class="variablelist">
 
701
of <em class="parameter"><code>comp</code></em>
 
702
.</p>
 
703
<div class="refsect3">
 
704
<a name="id-1.2.14.5.8.13.5"></a><h4>Parameters</h4>
 
705
<div class="informaltable"><table width="100%" border="0">
532
706
<colgroup>
533
 
<col align="left" valign="top">
534
 
<col>
 
707
<col width="150px" class="parameters_name">
 
708
<col class="parameters_description">
 
709
<col width="200px" class="parameters_annotations">
535
710
</colgroup>
536
711
<tbody>
537
712
<tr>
538
 
<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
539
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a>
540
 
</td>
 
713
<td class="parameter_name"><p>buf</p></td>
 
714
<td class="parameter_description"><p>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a></p></td>
 
715
<td class="parameter_annotations"> </td>
541
716
</tr>
542
717
<tr>
543
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
544
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
545
 
</td>
 
718
<td class="parameter_name"><p>comp</p></td>
 
719
<td class="parameter_description"><p> a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a>. </p></td>
 
720
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
546
721
</tr>
547
722
</tbody>
548
723
</table></div>
549
724
</div>
 
725
</div>
550
726
<hr>
551
727
<div class="refsect2">
552
728
<a name="gst-buffer-get-video-overlay-composition-meta"></a><h3>gst_buffer_get_video_overlay_composition_meta()</h3>
559
735
</div>
560
736
<hr>
561
737
<div class="refsect2">
562
 
<a name="GstVideoOverlayFormatFlags"></a><h3>enum GstVideoOverlayFormatFlags</h3>
563
 
<pre class="programlisting">typedef enum {
564
 
  GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE = 0,
565
 
  GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA = 1,
566
 
  GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA = 2
567
 
} GstVideoOverlayFormatFlags;
568
 
</pre>
569
 
<p>
570
 
Overlay format flags.
571
 
</p>
572
 
<div class="variablelist"><table border="0" class="variablelist">
573
 
<colgroup>
574
 
<col align="left" valign="top">
575
 
<col>
576
 
</colgroup>
577
 
<tbody>
578
 
<tr>
579
 
<td><p><a name="GST-VIDEO-OVERLAY-FORMAT-FLAG-NONE:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE</code></span></p></td>
580
 
<td>no flags
581
 
</td>
582
 
</tr>
583
 
<tr>
584
 
<td><p><a name="GST-VIDEO-OVERLAY-FORMAT-FLAG-PREMULTIPLIED-ALPHA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA</code></span></p></td>
585
 
<td>RGB are premultiplied by A/255.
586
 
</td>
587
 
</tr>
588
 
<tr>
589
 
<td><p><a name="GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</code></span></p></td>
590
 
<td>a global-alpha value != 1 is set.
591
 
</td>
592
 
</tr>
593
 
</tbody>
594
 
</table></div>
595
 
</div>
596
 
<hr>
597
 
<div class="refsect2">
598
 
<a name="GstVideoOverlayRectangle"></a><h3>GstVideoOverlayRectangle</h3>
599
 
<pre class="programlisting">typedef struct _GstVideoOverlayRectangle GstVideoOverlayRectangle;</pre>
600
 
<p>
601
 
An opaque video overlay rectangle object. A rectangle contains a single
602
 
overlay rectangle which can be added to a composition.
603
 
</p>
604
 
</div>
605
 
<hr>
606
 
<div class="refsect2">
607
 
<a name="gst-video-overlay-rectangle-new-raw"></a><h3>gst_video_overlay_rectangle_new_raw ()</h3>
608
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> * gst_video_overlay_rectangle_new_raw
609
 
                                                        (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *pixels</code></em>,
610
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_x</code></em>,
611
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_y</code></em>,
612
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_width</code></em>,
613
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_height</code></em>,
614
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
615
 
<p>
616
 
Creates a new video overlay rectangle with ARGB or AYUV pixel data.
 
738
<a name="gst-video-overlay-rectangle-new-raw"></a><h3>gst_video_overlay_rectangle_new_raw ()</h3>
 
739
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> *
 
740
gst_video_overlay_rectangle_new_raw (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> *pixels</code></em>,
 
741
                                     <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_x</code></em>,
 
742
                                     <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_y</code></em>,
 
743
                                     <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_width</code></em>,
 
744
                                     <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_height</code></em>,
 
745
                                     <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
 
746
<p>Creates a new video overlay rectangle with ARGB or AYUV pixel data.
617
747
The layout in case of ARGB of the components in memory is B-G-R-A
618
748
on little-endian platforms
619
749
(corresponding to <a class="link" href="gst-plugins-base-libs-gstvideo.html#GST-VIDEO-FORMAT-BGRA:CAPS"><span class="type">GST_VIDEO_FORMAT_BGRA</span></a>) and A-R-G-B on big-endian
623
753
component value. Unless specified in the flags, the RGB values are
624
754
non-premultiplied. This is the format that is used by most hardware,
625
755
and also many rendering libraries such as Cairo, for example.
626
 
The pixel data buffer must have <a class="link" href="gst-plugins-base-libs-gstvideometa.html#GstVideoMeta" title="struct GstVideoMeta"><span class="type">GstVideoMeta</span></a> set.
627
 
</p>
628
 
<div class="variablelist"><table border="0" class="variablelist">
 
756
The pixel data buffer must have <a class="link" href="gst-plugins-base-libs-gstvideometa.html#GstVideoMeta" title="struct GstVideoMeta"><span class="type">GstVideoMeta</span></a> set.</p>
 
757
<div class="refsect3">
 
758
<a name="id-1.2.14.5.8.16.5"></a><h4>Parameters</h4>
 
759
<div class="informaltable"><table width="100%" border="0">
629
760
<colgroup>
630
 
<col align="left" valign="top">
631
 
<col>
 
761
<col width="150px" class="parameters_name">
 
762
<col class="parameters_description">
 
763
<col width="200px" class="parameters_annotations">
632
764
</colgroup>
633
765
<tbody>
634
766
<tr>
635
 
<td><p><span class="term"><em class="parameter"><code>pixels</code></em> :</span></p></td>
636
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> pointing to the pixel memory. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
637
 
</td>
638
 
</tr>
639
 
<tr>
640
 
<td><p><span class="term"><em class="parameter"><code>render_x</code></em> :</span></p></td>
641
 
<td>the X co-ordinate on the video where the top-left corner of this
642
 
overlay rectangle should be rendered to</td>
643
 
</tr>
644
 
<tr>
645
 
<td><p><span class="term"><em class="parameter"><code>render_y</code></em> :</span></p></td>
646
 
<td>the Y co-ordinate on the video where the top-left corner of this
647
 
overlay rectangle should be rendered to</td>
648
 
</tr>
649
 
<tr>
650
 
<td><p><span class="term"><em class="parameter"><code>render_width</code></em> :</span></p></td>
651
 
<td>the render width of this rectangle on the video</td>
652
 
</tr>
653
 
<tr>
654
 
<td><p><span class="term"><em class="parameter"><code>render_height</code></em> :</span></p></td>
655
 
<td>the render height of this rectangle on the video</td>
656
 
</tr>
657
 
<tr>
658
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
659
 
<td>flags</td>
660
 
</tr>
661
 
<tr>
662
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
663
 
<td>a new <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>. Unref with
664
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-unref" title="gst_video_overlay_rectangle_unref ()"><code class="function">gst_video_overlay_rectangle_unref()</code></a> when no longer needed. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
665
 
</td>
 
767
<td class="parameter_name"><p>pixels</p></td>
 
768
<td class="parameter_description"><p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> pointing to the pixel memory. </p></td>
 
769
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 
770
</tr>
 
771
<tr>
 
772
<td class="parameter_name"><p>render_x</p></td>
 
773
<td class="parameter_description"><p>the X co-ordinate on the video where the top-left corner of this
 
774
overlay rectangle should be rendered to</p></td>
 
775
<td class="parameter_annotations"> </td>
 
776
</tr>
 
777
<tr>
 
778
<td class="parameter_name"><p>render_y</p></td>
 
779
<td class="parameter_description"><p>the Y co-ordinate on the video where the top-left corner of this
 
780
overlay rectangle should be rendered to</p></td>
 
781
<td class="parameter_annotations"> </td>
 
782
</tr>
 
783
<tr>
 
784
<td class="parameter_name"><p>render_width</p></td>
 
785
<td class="parameter_description"><p>the render width of this rectangle on the video</p></td>
 
786
<td class="parameter_annotations"> </td>
 
787
</tr>
 
788
<tr>
 
789
<td class="parameter_name"><p>render_height</p></td>
 
790
<td class="parameter_description"><p>the render height of this rectangle on the video</p></td>
 
791
<td class="parameter_annotations"> </td>
 
792
</tr>
 
793
<tr>
 
794
<td class="parameter_name"><p>flags</p></td>
 
795
<td class="parameter_description"><p>flags</p></td>
 
796
<td class="parameter_annotations"> </td>
666
797
</tr>
667
798
</tbody>
668
799
</table></div>
669
800
</div>
 
801
<div class="refsect3">
 
802
<a name="id-1.2.14.5.8.16.6"></a><h4>Returns</h4>
 
803
<p> a new <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>. Unref with
 
804
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-unref" title="gst_video_overlay_rectangle_unref ()"><code class="function">gst_video_overlay_rectangle_unref()</code></a> when no longer needed. </p>
 
805
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
806
</div>
 
807
</div>
670
808
<hr>
671
809
<div class="refsect2">
672
 
<a name="gst-video-overlay-rectangle-ref"></a><h3>gst_video_overlay_rectangle_ref ()</h3>
673
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> * gst_video_overlay_rectangle_ref
674
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *comp</code></em>);</pre>
675
 
<p>
676
 
Increases the refcount of the given rectangle by one.
677
 
</p>
678
 
<p>
679
 
Note that the refcount affects the writeability
680
 
of <em class="parameter"><code>comp</code></em>, use <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-copy" title="gst_video_overlay_rectangle_copy ()"><code class="function">gst_video_overlay_rectangle_copy()</code></a> to ensure a rectangle can
 
810
<a name="gst-video-overlay-rectangle-ref"></a><h3>gst_video_overlay_rectangle_ref ()</h3>
 
811
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> *
 
812
gst_video_overlay_rectangle_ref (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *comp</code></em>);</pre>
 
813
<p>Increases the refcount of the given rectangle by one.</p>
 
814
<p>Note that the refcount affects the writeability
 
815
of <em class="parameter"><code>comp</code></em>
 
816
, use <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-copy" title="gst_video_overlay_rectangle_copy ()"><code class="function">gst_video_overlay_rectangle_copy()</code></a> to ensure a rectangle can
681
817
be modified (there is no <code class="function">gst_video_overlay_rectangle_make_writable()</code> because
682
818
it is unlikely that someone will hold the single reference to the rectangle
683
 
and not know that that's the case).
684
 
</p>
685
 
<div class="variablelist"><table border="0" class="variablelist">
686
 
<colgroup>
687
 
<col align="left" valign="top">
688
 
<col>
689
 
</colgroup>
690
 
<tbody>
691
 
<tr>
692
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
693
 
<td>a a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>.</td>
694
 
</tr>
695
 
<tr>
696
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
697
 
<td>
698
 
<em class="parameter"><code>comp</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
699
 
</td>
700
 
</tr>
701
 
</tbody>
702
 
</table></div>
703
 
</div>
704
 
<hr>
705
 
<div class="refsect2">
706
 
<a name="gst-video-overlay-rectangle-unref"></a><h3>gst_video_overlay_rectangle_unref ()</h3>
707
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_video_overlay_rectangle_unref   (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *comp</code></em>);</pre>
708
 
<p>
709
 
Decreases the refcount of the rectangle. If the refcount reaches 0, the
710
 
rectangle will be freed.
711
 
</p>
712
 
<div class="variablelist"><table border="0" class="variablelist">
713
 
<colgroup>
714
 
<col align="left" valign="top">
715
 
<col>
716
 
</colgroup>
717
 
<tbody><tr>
718
 
<td><p><span class="term"><em class="parameter"><code>comp</code></em> :</span></p></td>
719
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
720
 
</td>
721
 
</tr></tbody>
722
 
</table></div>
723
 
</div>
724
 
<hr>
725
 
<div class="refsect2">
726
 
<a name="gst-video-overlay-rectangle-get-pixels-raw"></a><h3>gst_video_overlay_rectangle_get_pixels_raw ()</h3>
727
 
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_video_overlay_rectangle_get_pixels_raw
728
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
729
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
730
 
<div class="variablelist"><table border="0" class="variablelist">
731
 
<colgroup>
732
 
<col align="left" valign="top">
733
 
<col>
734
 
</colgroup>
735
 
<tbody>
736
 
<tr>
737
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
738
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
739
 
</td>
740
 
</tr>
741
 
<tr>
742
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
743
 
<td>flags
 
819
and not know that that's the case).</p>
 
820
<div class="refsect3">
 
821
<a name="id-1.2.14.5.8.17.6"></a><h4>Parameters</h4>
 
822
<div class="informaltable"><table width="100%" border="0">
 
823
<colgroup>
 
824
<col width="150px" class="parameters_name">
 
825
<col class="parameters_description">
 
826
<col width="200px" class="parameters_annotations">
 
827
</colgroup>
 
828
<tbody><tr>
 
829
<td class="parameter_name"><p>comp</p></td>
 
830
<td class="parameter_description"><p>a a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>.</p></td>
 
831
<td class="parameter_annotations"> </td>
 
832
</tr></tbody>
 
833
</table></div>
 
834
</div>
 
835
<div class="refsect3">
 
836
<a name="id-1.2.14.5.8.17.7"></a><h4>Returns</h4>
 
837
<p> <em class="parameter"><code>comp</code></em>
 
838
. </p>
 
839
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
840
</div>
 
841
</div>
 
842
<hr>
 
843
<div class="refsect2">
 
844
<a name="gst-video-overlay-rectangle-unref"></a><h3>gst_video_overlay_rectangle_unref ()</h3>
 
845
<pre class="programlisting"><span class="returnvalue">void</span>
 
846
gst_video_overlay_rectangle_unref (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *comp</code></em>);</pre>
 
847
<p>Decreases the refcount of the rectangle. If the refcount reaches 0, the
 
848
rectangle will be freed.</p>
 
849
<div class="refsect3">
 
850
<a name="id-1.2.14.5.8.18.5"></a><h4>Parameters</h4>
 
851
<div class="informaltable"><table width="100%" border="0">
 
852
<colgroup>
 
853
<col width="150px" class="parameters_name">
 
854
<col class="parameters_description">
 
855
<col width="200px" class="parameters_annotations">
 
856
</colgroup>
 
857
<tbody><tr>
 
858
<td class="parameter_name"><p>comp</p></td>
 
859
<td class="parameter_description"><p> a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>. </p></td>
 
860
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
 
861
</tr></tbody>
 
862
</table></div>
 
863
</div>
 
864
</div>
 
865
<hr>
 
866
<div class="refsect2">
 
867
<a name="gst-video-overlay-rectangle-get-pixels-raw"></a><h3>gst_video_overlay_rectangle_get_pixels_raw ()</h3>
 
868
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
869
gst_video_overlay_rectangle_get_pixels_raw
 
870
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
 
871
                                <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
 
872
<div class="refsect3">
 
873
<a name="id-1.2.14.5.8.19.4"></a><h4>Parameters</h4>
 
874
<div class="informaltable"><table width="100%" border="0">
 
875
<colgroup>
 
876
<col width="150px" class="parameters_name">
 
877
<col class="parameters_description">
 
878
<col width="200px" class="parameters_annotations">
 
879
</colgroup>
 
880
<tbody>
 
881
<tr>
 
882
<td class="parameter_name"><p>rectangle</p></td>
 
883
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
884
<td class="parameter_annotations"> </td>
 
885
</tr>
 
886
<tr>
 
887
<td class="parameter_name"><p>flags</p></td>
 
888
<td class="parameter_description"><p>flags
744
889
If a global_alpha value != 1 is set for the rectangle, the caller
745
890
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
746
891
if he wants to apply global-alpha himself. If the flag is not set
747
 
global_alpha is applied internally before returning the pixel-data.</td>
 
892
global_alpha is applied internally before returning the pixel-data.</p></td>
 
893
<td class="parameter_annotations"> </td>
748
894
</tr>
749
 
<tr>
750
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
751
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the pixel data with
 
895
</tbody>
 
896
</table></div>
 
897
</div>
 
898
<div class="refsect3">
 
899
<a name="id-1.2.14.5.8.19.5"></a><h4>Returns</h4>
 
900
<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the pixel data with
752
901
format as originally provided and specified in video meta with
753
902
width and height of the render dimensions as per
754
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>. This function does
755
 
not return a reference, the caller should obtain a reference of her own
756
 
with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
757
 
</td>
758
 
</tr>
759
 
</tbody>
760
 
</table></div>
761
 
</div>
762
 
<hr>
763
 
<div class="refsect2">
764
 
<a name="gst-video-overlay-rectangle-get-pixels-argb"></a><h3>gst_video_overlay_rectangle_get_pixels_argb ()</h3>
765
 
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_video_overlay_rectangle_get_pixels_argb
766
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
767
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
768
 
<div class="variablelist"><table border="0" class="variablelist">
769
 
<colgroup>
770
 
<col align="left" valign="top">
771
 
<col>
772
 
</colgroup>
773
 
<tbody>
774
 
<tr>
775
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
776
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
777
 
</td>
778
 
</tr>
779
 
<tr>
780
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
781
 
<td>flags
782
 
If a global_alpha value != 1 is set for the rectangle, the caller
783
 
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
784
 
if he wants to apply global-alpha himself. If the flag is not set
785
 
global_alpha is applied internally before returning the pixel-data.</td>
786
 
</tr>
787
 
<tr>
788
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
789
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the ARGB pixel data with
790
 
width and height of the render dimensions as per
791
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>. This function does
792
 
not return a reference, the caller should obtain a reference of her own
793
 
with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
794
 
</td>
795
 
</tr>
796
 
</tbody>
797
 
</table></div>
798
 
</div>
799
 
<hr>
800
 
<div class="refsect2">
801
 
<a name="gst-video-overlay-rectangle-get-pixels-ayuv"></a><h3>gst_video_overlay_rectangle_get_pixels_ayuv ()</h3>
802
 
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_video_overlay_rectangle_get_pixels_ayuv
803
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
804
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
805
 
<div class="variablelist"><table border="0" class="variablelist">
806
 
<colgroup>
807
 
<col align="left" valign="top">
808
 
<col>
809
 
</colgroup>
810
 
<tbody>
811
 
<tr>
812
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
813
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
814
 
</td>
815
 
</tr>
816
 
<tr>
817
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
818
 
<td>flags
819
 
If a global_alpha value != 1 is set for the rectangle, the caller
820
 
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
821
 
if he wants to apply global-alpha himself. If the flag is not set
822
 
global_alpha is applied internally before returning the pixel-data.</td>
823
 
</tr>
824
 
<tr>
825
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
826
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the AYUV pixel data with
827
 
width and height of the render dimensions as per
828
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>. This function does
829
 
not return a reference, the caller should obtain a reference of her own
830
 
with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
831
 
</td>
832
 
</tr>
833
 
</tbody>
834
 
</table></div>
835
 
</div>
836
 
<hr>
837
 
<div class="refsect2">
838
 
<a name="gst-video-overlay-rectangle-get-pixels-unscaled-raw"></a><h3>gst_video_overlay_rectangle_get_pixels_unscaled_raw ()</h3>
839
 
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_video_overlay_rectangle_get_pixels_unscaled_raw
840
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
841
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
842
 
<p>
843
 
Retrieves the pixel data as it is. This is useful if the caller can
844
 
do the scaling itself when handling the overlaying. The rectangle will
845
 
need to be scaled to the render dimensions, which can be retrieved using
846
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>.
847
 
</p>
848
 
<div class="variablelist"><table border="0" class="variablelist">
849
 
<colgroup>
850
 
<col align="left" valign="top">
851
 
<col>
852
 
</colgroup>
853
 
<tbody>
854
 
<tr>
855
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
856
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
857
 
</td>
858
 
</tr>
859
 
<tr>
860
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
861
 
<td>flags.
862
 
If a global_alpha value != 1 is set for the rectangle, the caller
863
 
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
864
 
if he wants to apply global-alpha himself. If the flag is not set
865
 
global_alpha is applied internally before returning the pixel-data.</td>
866
 
</tr>
867
 
<tr>
868
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
869
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the pixel data with
870
 
<a class="link" href="gst-plugins-base-libs-gstvideometa.html#GstVideoMeta" title="struct GstVideoMeta"><span class="type">GstVideoMeta</span></a> set. This function does not return a reference, the caller
871
 
should obtain a reference of her own with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
872
 
</td>
873
 
</tr>
874
 
</tbody>
875
 
</table></div>
876
 
</div>
877
 
<hr>
878
 
<div class="refsect2">
879
 
<a name="gst-video-overlay-rectangle-get-pixels-unscaled-argb"></a><h3>gst_video_overlay_rectangle_get_pixels_unscaled_argb ()</h3>
880
 
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_video_overlay_rectangle_get_pixels_unscaled_argb
881
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
882
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
883
 
<p>
884
 
Retrieves the pixel data as it is. This is useful if the caller can
885
 
do the scaling itself when handling the overlaying. The rectangle will
886
 
need to be scaled to the render dimensions, which can be retrieved using
887
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>.
888
 
</p>
889
 
<div class="variablelist"><table border="0" class="variablelist">
890
 
<colgroup>
891
 
<col align="left" valign="top">
892
 
<col>
893
 
</colgroup>
894
 
<tbody>
895
 
<tr>
896
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
897
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
898
 
</td>
899
 
</tr>
900
 
<tr>
901
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
902
 
<td>flags.
903
 
If a global_alpha value != 1 is set for the rectangle, the caller
904
 
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
905
 
if he wants to apply global-alpha himself. If the flag is not set
906
 
global_alpha is applied internally before returning the pixel-data.</td>
907
 
</tr>
908
 
<tr>
909
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
910
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the ARGB pixel data with
911
 
<a class="link" href="gst-plugins-base-libs-gstvideometa.html#GstVideoMeta" title="struct GstVideoMeta"><span class="type">GstVideoMeta</span></a> set. This function does not return a reference, the caller
912
 
should obtain a reference of her own with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
913
 
</td>
914
 
</tr>
915
 
</tbody>
916
 
</table></div>
917
 
</div>
918
 
<hr>
919
 
<div class="refsect2">
920
 
<a name="gst-video-overlay-rectangle-get-pixels-unscaled-ayuv"></a><h3>gst_video_overlay_rectangle_get_pixels_unscaled_ayuv ()</h3>
921
 
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *         gst_video_overlay_rectangle_get_pixels_unscaled_ayuv
922
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
923
 
                                                         <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
924
 
<p>
925
 
Retrieves the pixel data as it is. This is useful if the caller can
926
 
do the scaling itself when handling the overlaying. The rectangle will
927
 
need to be scaled to the render dimensions, which can be retrieved using
928
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>.
929
 
</p>
930
 
<div class="variablelist"><table border="0" class="variablelist">
931
 
<colgroup>
932
 
<col align="left" valign="top">
933
 
<col>
934
 
</colgroup>
935
 
<tbody>
936
 
<tr>
937
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
938
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
939
 
</td>
940
 
</tr>
941
 
<tr>
942
 
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
943
 
<td>flags.
944
 
If a global_alpha value != 1 is set for the rectangle, the caller
945
 
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
946
 
if he wants to apply global-alpha himself. If the flag is not set
947
 
global_alpha is applied internally before returning the pixel-data.</td>
948
 
</tr>
949
 
<tr>
950
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
951
 
<td>a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the AYUV pixel data with
952
 
<a class="link" href="gst-plugins-base-libs-gstvideometa.html#GstVideoMeta" title="struct GstVideoMeta"><span class="type">GstVideoMeta</span></a> set. This function does not return a reference, the caller
953
 
should obtain a reference of her own with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
954
 
</td>
955
 
</tr>
956
 
</tbody>
957
 
</table></div>
958
 
</div>
959
 
<hr>
960
 
<div class="refsect2">
961
 
<a name="gst-video-overlay-rectangle-get-render-rectangle"></a><h3>gst_video_overlay_rectangle_get_render_rectangle ()</h3>
962
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gst_video_overlay_rectangle_get_render_rectangle
963
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
964
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *render_x</code></em>,
965
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *render_y</code></em>,
966
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *render_width</code></em>,
967
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *render_height</code></em>);</pre>
968
 
<p>
969
 
Retrieves the render position and render dimension of the overlay
970
 
rectangle on the video.
971
 
</p>
972
 
<div class="variablelist"><table border="0" class="variablelist">
973
 
<colgroup>
974
 
<col align="left" valign="top">
975
 
<col>
976
 
</colgroup>
977
 
<tbody>
978
 
<tr>
979
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
980
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
981
 
</td>
982
 
</tr>
983
 
<tr>
984
 
<td><p><span class="term"><em class="parameter"><code>render_x</code></em> :</span></p></td>
985
 
<td>address where to store the X render offset. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
986
 
</td>
987
 
</tr>
988
 
<tr>
989
 
<td><p><span class="term"><em class="parameter"><code>render_y</code></em> :</span></p></td>
990
 
<td>address where to store the Y render offset. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
991
 
</td>
992
 
</tr>
993
 
<tr>
994
 
<td><p><span class="term"><em class="parameter"><code>render_width</code></em> :</span></p></td>
995
 
<td>address where to store the render width. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
996
 
</td>
997
 
</tr>
998
 
<tr>
999
 
<td><p><span class="term"><em class="parameter"><code>render_height</code></em> :</span></p></td>
1000
 
<td>address where to store the render height. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1001
 
</td>
1002
 
</tr>
1003
 
<tr>
1004
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1005
 
<td>TRUE if valid render dimensions were retrieved.</td>
1006
 
</tr>
1007
 
</tbody>
1008
 
</table></div>
1009
 
</div>
1010
 
<hr>
1011
 
<div class="refsect2">
1012
 
<a name="gst-video-overlay-rectangle-get-seqnum"></a><h3>gst_video_overlay_rectangle_get_seqnum ()</h3>
1013
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gst_video_overlay_rectangle_get_seqnum
1014
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
1015
 
<p>
1016
 
Returns the sequence number of this rectangle. Sequence numbers are
 
903
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>. This function does
 
904
not return a reference, the caller should obtain a reference of her own
 
905
with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. </p>
 
906
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
907
</div>
 
908
</div>
 
909
<hr>
 
910
<div class="refsect2">
 
911
<a name="gst-video-overlay-rectangle-get-pixels-argb"></a><h3>gst_video_overlay_rectangle_get_pixels_argb ()</h3>
 
912
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
913
gst_video_overlay_rectangle_get_pixels_argb
 
914
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
 
915
                                <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
 
916
<div class="refsect3">
 
917
<a name="id-1.2.14.5.8.20.4"></a><h4>Parameters</h4>
 
918
<div class="informaltable"><table width="100%" border="0">
 
919
<colgroup>
 
920
<col width="150px" class="parameters_name">
 
921
<col class="parameters_description">
 
922
<col width="200px" class="parameters_annotations">
 
923
</colgroup>
 
924
<tbody>
 
925
<tr>
 
926
<td class="parameter_name"><p>rectangle</p></td>
 
927
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
928
<td class="parameter_annotations"> </td>
 
929
</tr>
 
930
<tr>
 
931
<td class="parameter_name"><p>flags</p></td>
 
932
<td class="parameter_description"><p>flags
 
933
If a global_alpha value != 1 is set for the rectangle, the caller
 
934
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
 
935
if he wants to apply global-alpha himself. If the flag is not set
 
936
global_alpha is applied internally before returning the pixel-data.</p></td>
 
937
<td class="parameter_annotations"> </td>
 
938
</tr>
 
939
</tbody>
 
940
</table></div>
 
941
</div>
 
942
<div class="refsect3">
 
943
<a name="id-1.2.14.5.8.20.5"></a><h4>Returns</h4>
 
944
<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the ARGB pixel data with
 
945
width and height of the render dimensions as per
 
946
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>. This function does
 
947
not return a reference, the caller should obtain a reference of her own
 
948
with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. </p>
 
949
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
950
</div>
 
951
</div>
 
952
<hr>
 
953
<div class="refsect2">
 
954
<a name="gst-video-overlay-rectangle-get-pixels-ayuv"></a><h3>gst_video_overlay_rectangle_get_pixels_ayuv ()</h3>
 
955
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
956
gst_video_overlay_rectangle_get_pixels_ayuv
 
957
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
 
958
                                <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
 
959
<div class="refsect3">
 
960
<a name="id-1.2.14.5.8.21.4"></a><h4>Parameters</h4>
 
961
<div class="informaltable"><table width="100%" border="0">
 
962
<colgroup>
 
963
<col width="150px" class="parameters_name">
 
964
<col class="parameters_description">
 
965
<col width="200px" class="parameters_annotations">
 
966
</colgroup>
 
967
<tbody>
 
968
<tr>
 
969
<td class="parameter_name"><p>rectangle</p></td>
 
970
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
971
<td class="parameter_annotations"> </td>
 
972
</tr>
 
973
<tr>
 
974
<td class="parameter_name"><p>flags</p></td>
 
975
<td class="parameter_description"><p>flags
 
976
If a global_alpha value != 1 is set for the rectangle, the caller
 
977
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
 
978
if he wants to apply global-alpha himself. If the flag is not set
 
979
global_alpha is applied internally before returning the pixel-data.</p></td>
 
980
<td class="parameter_annotations"> </td>
 
981
</tr>
 
982
</tbody>
 
983
</table></div>
 
984
</div>
 
985
<div class="refsect3">
 
986
<a name="id-1.2.14.5.8.21.5"></a><h4>Returns</h4>
 
987
<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the AYUV pixel data with
 
988
width and height of the render dimensions as per
 
989
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>. This function does
 
990
not return a reference, the caller should obtain a reference of her own
 
991
with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. </p>
 
992
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
993
</div>
 
994
</div>
 
995
<hr>
 
996
<div class="refsect2">
 
997
<a name="gst-video-overlay-rectangle-get-pixels-unscaled-raw"></a><h3>gst_video_overlay_rectangle_get_pixels_unscaled_raw ()</h3>
 
998
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
999
gst_video_overlay_rectangle_get_pixels_unscaled_raw
 
1000
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
 
1001
                                <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
 
1002
<p>Retrieves the pixel data as it is. This is useful if the caller can
 
1003
do the scaling itself when handling the overlaying. The rectangle will
 
1004
need to be scaled to the render dimensions, which can be retrieved using
 
1005
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>.</p>
 
1006
<div class="refsect3">
 
1007
<a name="id-1.2.14.5.8.22.5"></a><h4>Parameters</h4>
 
1008
<div class="informaltable"><table width="100%" border="0">
 
1009
<colgroup>
 
1010
<col width="150px" class="parameters_name">
 
1011
<col class="parameters_description">
 
1012
<col width="200px" class="parameters_annotations">
 
1013
</colgroup>
 
1014
<tbody>
 
1015
<tr>
 
1016
<td class="parameter_name"><p>rectangle</p></td>
 
1017
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
1018
<td class="parameter_annotations"> </td>
 
1019
</tr>
 
1020
<tr>
 
1021
<td class="parameter_name"><p>flags</p></td>
 
1022
<td class="parameter_description"><p>flags.
 
1023
If a global_alpha value != 1 is set for the rectangle, the caller
 
1024
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
 
1025
if he wants to apply global-alpha himself. If the flag is not set
 
1026
global_alpha is applied internally before returning the pixel-data.</p></td>
 
1027
<td class="parameter_annotations"> </td>
 
1028
</tr>
 
1029
</tbody>
 
1030
</table></div>
 
1031
</div>
 
1032
<div class="refsect3">
 
1033
<a name="id-1.2.14.5.8.22.6"></a><h4>Returns</h4>
 
1034
<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the pixel data with
 
1035
<a class="link" href="gst-plugins-base-libs-gstvideometa.html#GstVideoMeta" title="struct GstVideoMeta"><span class="type">GstVideoMeta</span></a> set. This function does not return a reference, the caller
 
1036
should obtain a reference of her own with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. </p>
 
1037
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
1038
</div>
 
1039
</div>
 
1040
<hr>
 
1041
<div class="refsect2">
 
1042
<a name="gst-video-overlay-rectangle-get-pixels-unscaled-argb"></a><h3>gst_video_overlay_rectangle_get_pixels_unscaled_argb ()</h3>
 
1043
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
1044
gst_video_overlay_rectangle_get_pixels_unscaled_argb
 
1045
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
 
1046
                                <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
 
1047
<p>Retrieves the pixel data as it is. This is useful if the caller can
 
1048
do the scaling itself when handling the overlaying. The rectangle will
 
1049
need to be scaled to the render dimensions, which can be retrieved using
 
1050
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>.</p>
 
1051
<div class="refsect3">
 
1052
<a name="id-1.2.14.5.8.23.5"></a><h4>Parameters</h4>
 
1053
<div class="informaltable"><table width="100%" border="0">
 
1054
<colgroup>
 
1055
<col width="150px" class="parameters_name">
 
1056
<col class="parameters_description">
 
1057
<col width="200px" class="parameters_annotations">
 
1058
</colgroup>
 
1059
<tbody>
 
1060
<tr>
 
1061
<td class="parameter_name"><p>rectangle</p></td>
 
1062
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
1063
<td class="parameter_annotations"> </td>
 
1064
</tr>
 
1065
<tr>
 
1066
<td class="parameter_name"><p>flags</p></td>
 
1067
<td class="parameter_description"><p>flags.
 
1068
If a global_alpha value != 1 is set for the rectangle, the caller
 
1069
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
 
1070
if he wants to apply global-alpha himself. If the flag is not set
 
1071
global_alpha is applied internally before returning the pixel-data.</p></td>
 
1072
<td class="parameter_annotations"> </td>
 
1073
</tr>
 
1074
</tbody>
 
1075
</table></div>
 
1076
</div>
 
1077
<div class="refsect3">
 
1078
<a name="id-1.2.14.5.8.23.6"></a><h4>Returns</h4>
 
1079
<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the ARGB pixel data with
 
1080
<a class="link" href="gst-plugins-base-libs-gstvideometa.html#GstVideoMeta" title="struct GstVideoMeta"><span class="type">GstVideoMeta</span></a> set. This function does not return a reference, the caller
 
1081
should obtain a reference of her own with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. </p>
 
1082
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
1083
</div>
 
1084
</div>
 
1085
<hr>
 
1086
<div class="refsect2">
 
1087
<a name="gst-video-overlay-rectangle-get-pixels-unscaled-ayuv"></a><h3>gst_video_overlay_rectangle_get_pixels_unscaled_ayuv ()</h3>
 
1088
<pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="returnvalue">GstBuffer</span></a> *
 
1089
gst_video_overlay_rectangle_get_pixels_unscaled_ayuv
 
1090
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
 
1091
                                <em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> flags</code></em>);</pre>
 
1092
<p>Retrieves the pixel data as it is. This is useful if the caller can
 
1093
do the scaling itself when handling the overlaying. The rectangle will
 
1094
need to be scaled to the render dimensions, which can be retrieved using
 
1095
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-get-render-rectangle" title="gst_video_overlay_rectangle_get_render_rectangle ()"><code class="function">gst_video_overlay_rectangle_get_render_rectangle()</code></a>.</p>
 
1096
<div class="refsect3">
 
1097
<a name="id-1.2.14.5.8.24.5"></a><h4>Parameters</h4>
 
1098
<div class="informaltable"><table width="100%" border="0">
 
1099
<colgroup>
 
1100
<col width="150px" class="parameters_name">
 
1101
<col class="parameters_description">
 
1102
<col width="200px" class="parameters_annotations">
 
1103
</colgroup>
 
1104
<tbody>
 
1105
<tr>
 
1106
<td class="parameter_name"><p>rectangle</p></td>
 
1107
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
1108
<td class="parameter_annotations"> </td>
 
1109
</tr>
 
1110
<tr>
 
1111
<td class="parameter_name"><p>flags</p></td>
 
1112
<td class="parameter_description"><p>flags.
 
1113
If a global_alpha value != 1 is set for the rectangle, the caller
 
1114
should set the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"><span class="type">GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</span></a> flag
 
1115
if he wants to apply global-alpha himself. If the flag is not set
 
1116
global_alpha is applied internally before returning the pixel-data.</p></td>
 
1117
<td class="parameter_annotations"> </td>
 
1118
</tr>
 
1119
</tbody>
 
1120
</table></div>
 
1121
</div>
 
1122
<div class="refsect3">
 
1123
<a name="id-1.2.14.5.8.24.6"></a><h4>Returns</h4>
 
1124
<p> a <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#GstBuffer"><span class="type">GstBuffer</span></a> holding the AYUV pixel data with
 
1125
<a class="link" href="gst-plugins-base-libs-gstvideometa.html#GstVideoMeta" title="struct GstVideoMeta"><span class="type">GstVideoMeta</span></a> set. This function does not return a reference, the caller
 
1126
should obtain a reference of her own with <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstBuffer.html#gst-buffer-ref"><code class="function">gst_buffer_ref()</code></a> if needed. </p>
 
1127
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
1128
</div>
 
1129
</div>
 
1130
<hr>
 
1131
<div class="refsect2">
 
1132
<a name="gst-video-overlay-rectangle-get-render-rectangle"></a><h3>gst_video_overlay_rectangle_get_render_rectangle ()</h3>
 
1133
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
1134
gst_video_overlay_rectangle_get_render_rectangle
 
1135
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
 
1136
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *render_x</code></em>,
 
1137
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *render_y</code></em>,
 
1138
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *render_width</code></em>,
 
1139
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *render_height</code></em>);</pre>
 
1140
<p>Retrieves the render position and render dimension of the overlay
 
1141
rectangle on the video.</p>
 
1142
<div class="refsect3">
 
1143
<a name="id-1.2.14.5.8.25.5"></a><h4>Parameters</h4>
 
1144
<div class="informaltable"><table width="100%" border="0">
 
1145
<colgroup>
 
1146
<col width="150px" class="parameters_name">
 
1147
<col class="parameters_description">
 
1148
<col width="200px" class="parameters_annotations">
 
1149
</colgroup>
 
1150
<tbody>
 
1151
<tr>
 
1152
<td class="parameter_name"><p>rectangle</p></td>
 
1153
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
1154
<td class="parameter_annotations"> </td>
 
1155
</tr>
 
1156
<tr>
 
1157
<td class="parameter_name"><p>render_x</p></td>
 
1158
<td class="parameter_description"><p> address where to store the X render offset. </p></td>
 
1159
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
 
1160
</tr>
 
1161
<tr>
 
1162
<td class="parameter_name"><p>render_y</p></td>
 
1163
<td class="parameter_description"><p> address where to store the Y render offset. </p></td>
 
1164
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
 
1165
</tr>
 
1166
<tr>
 
1167
<td class="parameter_name"><p>render_width</p></td>
 
1168
<td class="parameter_description"><p> address where to store the render width. </p></td>
 
1169
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
 
1170
</tr>
 
1171
<tr>
 
1172
<td class="parameter_name"><p>render_height</p></td>
 
1173
<td class="parameter_description"><p> address where to store the render height. </p></td>
 
1174
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
 
1175
</tr>
 
1176
</tbody>
 
1177
</table></div>
 
1178
</div>
 
1179
<div class="refsect3">
 
1180
<a name="id-1.2.14.5.8.25.6"></a><h4>Returns</h4>
 
1181
<p> TRUE if valid render dimensions were retrieved.</p>
 
1182
<p></p>
 
1183
</div>
 
1184
</div>
 
1185
<hr>
 
1186
<div class="refsect2">
 
1187
<a name="gst-video-overlay-rectangle-get-seqnum"></a><h3>gst_video_overlay_rectangle_get_seqnum ()</h3>
 
1188
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
 
1189
gst_video_overlay_rectangle_get_seqnum
 
1190
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
 
1191
<p>Returns the sequence number of this rectangle. Sequence numbers are
1017
1192
monotonically increasing and unique for overlay compositions and rectangles
1018
1193
(meaning there will never be a rectangle with the same sequence number as
1019
 
a composition).
1020
 
</p>
1021
 
<p>
1022
 
Using the sequence number of a rectangle as an indicator for changed
 
1194
a composition).</p>
 
1195
<p>Using the sequence number of a rectangle as an indicator for changed
1023
1196
pixel-data of a rectangle is dangereous. Some API calls, like e.g.
1024
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-set-global-alpha" title="gst_video_overlay_rectangle_set_global_alpha ()"><code class="function">gst_video_overlay_rectangle_set_global_alpha()</code></a>, automatically update
 
1197
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-rectangle-set-global-alpha" title="gst_video_overlay_rectangle_set_global_alpha ()"><code class="function">gst_video_overlay_rectangle_set_global_alpha()</code></a>, automatically update
1025
1198
the per rectangle sequence number, which is misleading for renderers/
1026
1199
consumers, that handle global-alpha themselves. For them  the
1027
1200
pixel-data returned by gst_video_overlay_rectangle_get_pixels_*()
1028
1201
wont be different for different global-alpha values. In this case a
1029
1202
renderer could also use the GstBuffer pointers as a hint for changed
1030
 
pixel-data.
1031
 
</p>
1032
 
<div class="variablelist"><table border="0" class="variablelist">
 
1203
pixel-data.</p>
 
1204
<div class="refsect3">
 
1205
<a name="id-1.2.14.5.8.26.6"></a><h4>Parameters</h4>
 
1206
<div class="informaltable"><table width="100%" border="0">
1033
1207
<colgroup>
1034
 
<col align="left" valign="top">
1035
 
<col>
 
1208
<col width="150px" class="parameters_name">
 
1209
<col class="parameters_description">
 
1210
<col width="200px" class="parameters_annotations">
1036
1211
</colgroup>
1037
 
<tbody>
1038
 
<tr>
1039
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
1040
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
1041
 
</td>
1042
 
</tr>
1043
 
<tr>
1044
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1045
 
<td>the sequence number of <em class="parameter"><code>rectangle</code></em>
1046
 
</td>
1047
 
</tr>
1048
 
</tbody>
 
1212
<tbody><tr>
 
1213
<td class="parameter_name"><p>rectangle</p></td>
 
1214
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
1215
<td class="parameter_annotations"> </td>
 
1216
</tr></tbody>
1049
1217
</table></div>
1050
1218
</div>
 
1219
<div class="refsect3">
 
1220
<a name="id-1.2.14.5.8.26.7"></a><h4>Returns</h4>
 
1221
<p> the sequence number of <em class="parameter"><code>rectangle</code></em>
 
1222
</p>
 
1223
<p></p>
 
1224
</div>
 
1225
</div>
1051
1226
<hr>
1052
1227
<div class="refsect2">
1053
 
<a name="gst-video-overlay-rectangle-set-render-rectangle"></a><h3>gst_video_overlay_rectangle_set_render_rectangle ()</h3>
1054
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_video_overlay_rectangle_set_render_rectangle
1055
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
1056
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_x</code></em>,
1057
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_y</code></em>,
1058
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_width</code></em>,
1059
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_height</code></em>);</pre>
1060
 
<p>
1061
 
Sets the render position and dimensions of the rectangle on the video.
 
1228
<a name="gst-video-overlay-rectangle-set-render-rectangle"></a><h3>gst_video_overlay_rectangle_set_render_rectangle ()</h3>
 
1229
<pre class="programlisting"><span class="returnvalue">void</span>
 
1230
gst_video_overlay_rectangle_set_render_rectangle
 
1231
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
 
1232
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_x</code></em>,
 
1233
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> render_y</code></em>,
 
1234
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_width</code></em>,
 
1235
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> render_height</code></em>);</pre>
 
1236
<p>Sets the render position and dimensions of the rectangle on the video.
1062
1237
This function is mainly for elements that modify the size of the video
1063
1238
in some way (e.g. through scaling or cropping) and need to adjust the
1064
 
details of any overlays to match the operation that changed the size.
1065
 
</p>
1066
 
<p>
1067
 
<em class="parameter"><code>rectangle</code></em> must be writable, meaning its refcount must be 1. You can
 
1239
details of any overlays to match the operation that changed the size.</p>
 
1240
<p><em class="parameter"><code>rectangle</code></em>
 
1241
 must be writable, meaning its refcount must be 1. You can
1068
1242
make the rectangles inside a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> writable using
1069
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-make-writable" title="gst_video_overlay_composition_make_writable ()"><code class="function">gst_video_overlay_composition_make_writable()</code></a> or
1070
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-copy" title="gst_video_overlay_composition_copy ()"><code class="function">gst_video_overlay_composition_copy()</code></a>.
1071
 
</p>
1072
 
<div class="variablelist"><table border="0" class="variablelist">
 
1243
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-make-writable" title="gst_video_overlay_composition_make_writable ()"><code class="function">gst_video_overlay_composition_make_writable()</code></a> or
 
1244
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-copy" title="gst_video_overlay_composition_copy ()"><code class="function">gst_video_overlay_composition_copy()</code></a>.</p>
 
1245
<div class="refsect3">
 
1246
<a name="id-1.2.14.5.8.27.6"></a><h4>Parameters</h4>
 
1247
<div class="informaltable"><table width="100%" border="0">
1073
1248
<colgroup>
1074
 
<col align="left" valign="top">
1075
 
<col>
 
1249
<col width="150px" class="parameters_name">
 
1250
<col class="parameters_description">
 
1251
<col width="200px" class="parameters_annotations">
1076
1252
</colgroup>
1077
1253
<tbody>
1078
1254
<tr>
1079
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
1080
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
1081
 
</td>
1082
 
</tr>
1083
 
<tr>
1084
 
<td><p><span class="term"><em class="parameter"><code>render_x</code></em> :</span></p></td>
1085
 
<td>render X position of rectangle on video</td>
1086
 
</tr>
1087
 
<tr>
1088
 
<td><p><span class="term"><em class="parameter"><code>render_y</code></em> :</span></p></td>
1089
 
<td>render Y position of rectangle on video</td>
1090
 
</tr>
1091
 
<tr>
1092
 
<td><p><span class="term"><em class="parameter"><code>render_width</code></em> :</span></p></td>
1093
 
<td>render width of rectangle</td>
1094
 
</tr>
1095
 
<tr>
1096
 
<td><p><span class="term"><em class="parameter"><code>render_height</code></em> :</span></p></td>
1097
 
<td>render height of rectangle</td>
 
1255
<td class="parameter_name"><p>rectangle</p></td>
 
1256
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
1257
<td class="parameter_annotations"> </td>
 
1258
</tr>
 
1259
<tr>
 
1260
<td class="parameter_name"><p>render_x</p></td>
 
1261
<td class="parameter_description"><p>render X position of rectangle on video</p></td>
 
1262
<td class="parameter_annotations"> </td>
 
1263
</tr>
 
1264
<tr>
 
1265
<td class="parameter_name"><p>render_y</p></td>
 
1266
<td class="parameter_description"><p>render Y position of rectangle on video</p></td>
 
1267
<td class="parameter_annotations"> </td>
 
1268
</tr>
 
1269
<tr>
 
1270
<td class="parameter_name"><p>render_width</p></td>
 
1271
<td class="parameter_description"><p>render width of rectangle</p></td>
 
1272
<td class="parameter_annotations"> </td>
 
1273
</tr>
 
1274
<tr>
 
1275
<td class="parameter_name"><p>render_height</p></td>
 
1276
<td class="parameter_description"><p>render height of rectangle</p></td>
 
1277
<td class="parameter_annotations"> </td>
1098
1278
</tr>
1099
1279
</tbody>
1100
1280
</table></div>
1101
1281
</div>
 
1282
</div>
1102
1283
<hr>
1103
1284
<div class="refsect2">
1104
 
<a name="gst-video-overlay-rectangle-copy"></a><h3>gst_video_overlay_rectangle_copy ()</h3>
1105
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> * gst_video_overlay_rectangle_copy
1106
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
1107
 
<p>
1108
 
Makes a copy of <em class="parameter"><code>rectangle</code></em>, so that it is possible to modify it
 
1285
<a name="gst-video-overlay-rectangle-copy"></a><h3>gst_video_overlay_rectangle_copy ()</h3>
 
1286
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="returnvalue">GstVideoOverlayRectangle</span></a> *
 
1287
gst_video_overlay_rectangle_copy (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
 
1288
<p>Makes a copy of <em class="parameter"><code>rectangle</code></em>
 
1289
, so that it is possible to modify it
1109
1290
(e.g. to change the render co-ordinates or render dimension). The
1110
1291
actual overlay pixel data buffers contained in the rectangle are not
1111
 
copied.
1112
 
</p>
1113
 
<div class="variablelist"><table border="0" class="variablelist">
 
1292
copied.</p>
 
1293
<div class="refsect3">
 
1294
<a name="id-1.2.14.5.8.28.5"></a><h4>Parameters</h4>
 
1295
<div class="informaltable"><table width="100%" border="0">
1114
1296
<colgroup>
1115
 
<col align="left" valign="top">
1116
 
<col>
 
1297
<col width="150px" class="parameters_name">
 
1298
<col class="parameters_description">
 
1299
<col width="200px" class="parameters_annotations">
1117
1300
</colgroup>
1118
 
<tbody>
1119
 
<tr>
1120
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
1121
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> to copy. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1122
 
</td>
1123
 
</tr>
1124
 
<tr>
1125
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1126
 
<td>a new <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> equivalent
1127
 
to <em class="parameter"><code>rectangle</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1128
 
</td>
1129
 
</tr>
1130
 
</tbody>
 
1301
<tbody><tr>
 
1302
<td class="parameter_name"><p>rectangle</p></td>
 
1303
<td class="parameter_description"><p> a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> to copy. </p></td>
 
1304
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 
1305
</tr></tbody>
1131
1306
</table></div>
1132
1307
</div>
 
1308
<div class="refsect3">
 
1309
<a name="id-1.2.14.5.8.28.6"></a><h4>Returns</h4>
 
1310
<p> a new <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> equivalent
 
1311
to <em class="parameter"><code>rectangle</code></em>
 
1312
. </p>
 
1313
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1314
</div>
 
1315
</div>
1133
1316
<hr>
1134
1317
<div class="refsect2">
1135
 
<a name="gst-video-overlay-rectangle-get-flags"></a><h3>gst_video_overlay_rectangle_get_flags ()</h3>
1136
 
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="returnvalue">GstVideoOverlayFormatFlags</span></a> gst_video_overlay_rectangle_get_flags
1137
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
1138
 
<p>
1139
 
Retrieves the flags associated with a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>.
 
1318
<a name="gst-video-overlay-rectangle-get-flags"></a><h3>gst_video_overlay_rectangle_get_flags ()</h3>
 
1319
<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="returnvalue">GstVideoOverlayFormatFlags</span></a>
 
1320
gst_video_overlay_rectangle_get_flags (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
 
1321
<p>Retrieves the flags associated with a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>.
1140
1322
This is useful if the caller can handle both premultiplied alpha and
1141
1323
non premultiplied alpha, for example. By knowing whether the rectangle
1142
1324
uses premultiplied or not, it can request the pixel data in the format
1143
 
it is stored in, to avoid unnecessary conversion.
1144
 
</p>
1145
 
<div class="variablelist"><table border="0" class="variablelist">
1146
 
<colgroup>
1147
 
<col align="left" valign="top">
1148
 
<col>
1149
 
</colgroup>
1150
 
<tbody>
1151
 
<tr>
1152
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
1153
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
1154
 
</td>
1155
 
</tr>
1156
 
<tr>
1157
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1158
 
<td>the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> associated with the rectangle.</td>
1159
 
</tr>
1160
 
</tbody>
1161
 
</table></div>
1162
 
</div>
1163
 
<hr>
1164
 
<div class="refsect2">
1165
 
<a name="gst-video-overlay-rectangle-get-global-alpha"></a><h3>gst_video_overlay_rectangle_get_global_alpha ()</h3>
1166
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>              gst_video_overlay_rectangle_get_global_alpha
1167
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
1168
 
<p>
1169
 
Retrieves the global-alpha value associated with a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>.
1170
 
</p>
1171
 
<div class="variablelist"><table border="0" class="variablelist">
1172
 
<colgroup>
1173
 
<col align="left" valign="top">
1174
 
<col>
1175
 
</colgroup>
1176
 
<tbody>
1177
 
<tr>
1178
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
1179
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
1180
 
</td>
1181
 
</tr>
1182
 
<tr>
1183
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1184
 
<td>the global-alpha value associated with the rectangle.</td>
1185
 
</tr>
1186
 
</tbody>
1187
 
</table></div>
1188
 
</div>
1189
 
<hr>
1190
 
<div class="refsect2">
1191
 
<a name="gst-video-overlay-rectangle-set-global-alpha"></a><h3>gst_video_overlay_rectangle_set_global_alpha ()</h3>
1192
 
<pre class="programlisting"><span class="returnvalue">void</span>                gst_video_overlay_rectangle_set_global_alpha
1193
 
                                                        (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
1194
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> global_alpha</code></em>);</pre>
1195
 
<p>
1196
 
Sets the global alpha value associated with a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>. Per-
 
1325
it is stored in, to avoid unnecessary conversion.</p>
 
1326
<div class="refsect3">
 
1327
<a name="id-1.2.14.5.8.29.5"></a><h4>Parameters</h4>
 
1328
<div class="informaltable"><table width="100%" border="0">
 
1329
<colgroup>
 
1330
<col width="150px" class="parameters_name">
 
1331
<col class="parameters_description">
 
1332
<col width="200px" class="parameters_annotations">
 
1333
</colgroup>
 
1334
<tbody><tr>
 
1335
<td class="parameter_name"><p>rectangle</p></td>
 
1336
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
1337
<td class="parameter_annotations"> </td>
 
1338
</tr></tbody>
 
1339
</table></div>
 
1340
</div>
 
1341
<div class="refsect3">
 
1342
<a name="id-1.2.14.5.8.29.6"></a><h4>Returns</h4>
 
1343
<p> the <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayFormatFlags" title="enum GstVideoOverlayFormatFlags"><span class="type">GstVideoOverlayFormatFlags</span></a> associated with the rectangle.</p>
 
1344
<p></p>
 
1345
</div>
 
1346
</div>
 
1347
<hr>
 
1348
<div class="refsect2">
 
1349
<a name="gst-video-overlay-rectangle-get-global-alpha"></a><h3>gst_video_overlay_rectangle_get_global_alpha ()</h3>
 
1350
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>
 
1351
gst_video_overlay_rectangle_get_global_alpha
 
1352
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>);</pre>
 
1353
<p>Retrieves the global-alpha value associated with a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>.</p>
 
1354
<div class="refsect3">
 
1355
<a name="id-1.2.14.5.8.30.5"></a><h4>Parameters</h4>
 
1356
<div class="informaltable"><table width="100%" border="0">
 
1357
<colgroup>
 
1358
<col width="150px" class="parameters_name">
 
1359
<col class="parameters_description">
 
1360
<col width="200px" class="parameters_annotations">
 
1361
</colgroup>
 
1362
<tbody><tr>
 
1363
<td class="parameter_name"><p>rectangle</p></td>
 
1364
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
1365
<td class="parameter_annotations"> </td>
 
1366
</tr></tbody>
 
1367
</table></div>
 
1368
</div>
 
1369
<div class="refsect3">
 
1370
<a name="id-1.2.14.5.8.30.6"></a><h4>Returns</h4>
 
1371
<p> the global-alpha value associated with the rectangle.</p>
 
1372
<p></p>
 
1373
</div>
 
1374
</div>
 
1375
<hr>
 
1376
<div class="refsect2">
 
1377
<a name="gst-video-overlay-rectangle-set-global-alpha"></a><h3>gst_video_overlay_rectangle_set_global_alpha ()</h3>
 
1378
<pre class="programlisting"><span class="returnvalue">void</span>
 
1379
gst_video_overlay_rectangle_set_global_alpha
 
1380
                               (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a> *rectangle</code></em>,
 
1381
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> global_alpha</code></em>);</pre>
 
1382
<p>Sets the global alpha value associated with a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>. Per-
1197
1383
pixel alpha values are multiplied with this value. Valid
1198
 
values: 0 &lt;= global_alpha &lt;= 1; 1 to deactivate.
1199
 
</p>
1200
 
<p>
1201
 
 # <em class="parameter"><code>rectangle</code></em> must be writable, meaning its refcount must be 1. You can
 
1384
values: 0 &lt;= global_alpha &lt;= 1; 1 to deactivate.</p>
 
1385
<p> # <em class="parameter"><code>rectangle</code></em>
 
1386
 must be writable, meaning its refcount must be 1. You can
1202
1387
make the rectangles inside a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> writable using
1203
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-make-writable" title="gst_video_overlay_composition_make_writable ()"><code class="function">gst_video_overlay_composition_make_writable()</code></a> or
1204
 
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-copy" title="gst_video_overlay_composition_copy ()"><code class="function">gst_video_overlay_composition_copy()</code></a>.
1205
 
</p>
1206
 
<div class="variablelist"><table border="0" class="variablelist">
 
1388
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-make-writable" title="gst_video_overlay_composition_make_writable ()"><code class="function">gst_video_overlay_composition_make_writable()</code></a> or
 
1389
<a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-copy" title="gst_video_overlay_composition_copy ()"><code class="function">gst_video_overlay_composition_copy()</code></a>.</p>
 
1390
<div class="refsect3">
 
1391
<a name="id-1.2.14.5.8.31.6"></a><h4>Parameters</h4>
 
1392
<div class="informaltable"><table width="100%" border="0">
1207
1393
<colgroup>
1208
 
<col align="left" valign="top">
1209
 
<col>
 
1394
<col width="150px" class="parameters_name">
 
1395
<col class="parameters_description">
 
1396
<col width="200px" class="parameters_annotations">
1210
1397
</colgroup>
1211
1398
<tbody><tr>
1212
 
<td><p><span class="term"><em class="parameter"><code>rectangle</code></em> :</span></p></td>
1213
 
<td>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a>
1214
 
</td>
 
1399
<td class="parameter_name"><p>rectangle</p></td>
 
1400
<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayRectangle" title="GstVideoOverlayRectangle"><span class="type">GstVideoOverlayRectangle</span></a></p></td>
 
1401
<td class="parameter_annotations"> </td>
1215
1402
</tr></tbody>
1216
1403
</table></div>
1217
1404
</div>
1218
1405
</div>
1219
1406
</div>
 
1407
<div class="refsect1">
 
1408
<a name="gst-plugins-base-libs-gstvideooverlaycomposition.other_details"></a><h2>Types and Values</h2>
 
1409
<div class="refsect2">
 
1410
<a name="GstVideoOverlayComposition"></a><h3>GstVideoOverlayComposition</h3>
 
1411
<pre class="programlisting">typedef struct _GstVideoOverlayComposition GstVideoOverlayComposition;</pre>
 
1412
<p>An opaque video overlay composition object. A composition contains
 
1413
multiple overlay rectangles.</p>
 
1414
</div>
 
1415
<hr>
 
1416
<div class="refsect2">
 
1417
<a name="GST-VIDEO-OVERLAY-COMPOSITION-BLEND-FORMATS:CAPS"></a><h3>GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS</h3>
 
1418
<pre class="programlisting">#define             GST_VIDEO_OVERLAY_COMPOSITION_BLEND_FORMATS</pre>
 
1419
<p>Video formats supported by <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#gst-video-overlay-composition-blend" title="gst_video_overlay_composition_blend ()"><code class="function">gst_video_overlay_composition_blend()</code></a>, for
 
1420
use in overlay elements' pad template caps.</p>
 
1421
<p class="since">Since 1.2</p>
 
1422
</div>
 
1423
<hr>
 
1424
<div class="refsect2">
 
1425
<a name="GstVideoOverlayCompositionMeta"></a><h3>struct GstVideoOverlayCompositionMeta</h3>
 
1426
<pre class="programlisting">struct GstVideoOverlayCompositionMeta {
 
1427
  GstMeta meta;
 
1428
 
 
1429
  GstVideoOverlayComposition *overlay;
 
1430
};
 
1431
</pre>
 
1432
<p>Extra buffer metadata describing image overlay data.</p>
 
1433
<div class="refsect3">
 
1434
<a name="id-1.2.14.5.9.4.5"></a><h4>Members</h4>
 
1435
<div class="informaltable"><table width="100%" border="0">
 
1436
<colgroup>
 
1437
<col width="300px" class="struct_members_name">
 
1438
<col class="struct_members_description">
 
1439
<col width="200px" class="struct_members_annotations">
 
1440
</colgroup>
 
1441
<tbody>
 
1442
<tr>
 
1443
<td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMeta.html#GstMeta"><span class="type">GstMeta</span></a> <em class="structfield"><code><a name="GstVideoOverlayCompositionMeta.meta"></a>meta</code></em>;</p></td>
 
1444
<td class="struct_member_description"><p>parent <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstMeta.html#GstMeta"><span class="type">GstMeta</span></a></p></td>
 
1445
<td class="struct_member_annotations"> </td>
 
1446
</tr>
 
1447
<tr>
 
1448
<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a> *<em class="structfield"><code><a name="GstVideoOverlayCompositionMeta.overlay"></a>overlay</code></em>;</p></td>
 
1449
<td class="struct_member_description"><p>the attached <a class="link" href="gst-plugins-base-libs-gstvideooverlaycomposition.html#GstVideoOverlayComposition" title="GstVideoOverlayComposition"><span class="type">GstVideoOverlayComposition</span></a></p></td>
 
1450
<td class="struct_member_annotations"> </td>
 
1451
</tr>
 
1452
</tbody>
 
1453
</table></div>
 
1454
</div>
 
1455
</div>
 
1456
<hr>
 
1457
<div class="refsect2">
 
1458
<a name="GstVideoOverlayFormatFlags"></a><h3>enum GstVideoOverlayFormatFlags</h3>
 
1459
<p>Overlay format flags.</p>
 
1460
<div class="refsect3">
 
1461
<a name="id-1.2.14.5.9.5.4"></a><h4>Members</h4>
 
1462
<div class="informaltable"><table width="100%" border="0">
 
1463
<colgroup>
 
1464
<col width="300px" class="enum_members_name">
 
1465
<col class="enum_members_description">
 
1466
<col width="200px" class="enum_members_annotations">
 
1467
</colgroup>
 
1468
<tbody>
 
1469
<tr>
 
1470
<td class="enum_member_name"><p><a name="GST-VIDEO-OVERLAY-FORMAT-FLAG-NONE:CAPS"></a>GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE</p></td>
 
1471
<td class="enum_member_description">
 
1472
<p>no flags</p>
 
1473
</td>
 
1474
<td class="enum_member_annotations"> </td>
 
1475
</tr>
 
1476
<tr>
 
1477
<td class="enum_member_name"><p><a name="GST-VIDEO-OVERLAY-FORMAT-FLAG-PREMULTIPLIED-ALPHA:CAPS"></a>GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA</p></td>
 
1478
<td class="enum_member_description">
 
1479
<p>RGB are premultiplied by A/255.</p>
 
1480
</td>
 
1481
<td class="enum_member_annotations"> </td>
 
1482
</tr>
 
1483
<tr>
 
1484
<td class="enum_member_name"><p><a name="GST-VIDEO-OVERLAY-FORMAT-FLAG-GLOBAL-ALPHA:CAPS"></a>GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA</p></td>
 
1485
<td class="enum_member_description">
 
1486
<p>a global-alpha value != 1 is set.</p>
 
1487
</td>
 
1488
<td class="enum_member_annotations"> </td>
 
1489
</tr>
 
1490
</tbody>
 
1491
</table></div>
 
1492
</div>
 
1493
</div>
 
1494
<hr>
 
1495
<div class="refsect2">
 
1496
<a name="GstVideoOverlayRectangle"></a><h3>GstVideoOverlayRectangle</h3>
 
1497
<pre class="programlisting">typedef struct _GstVideoOverlayRectangle GstVideoOverlayRectangle;</pre>
 
1498
<p>An opaque video overlay rectangle object. A rectangle contains a single
 
1499
overlay rectangle which can be added to a composition.</p>
 
1500
</div>
 
1501
</div>
 
1502
</div>
1220
1503
<div class="footer">
1221
1504
<hr>
1222
 
          Generated by GTK-Doc V1.19</div>
 
1505
          Generated by GTK-Doc V1.20</div>
1223
1506
</body>
1224
1507
</html>
 
 
b'\\ No newline at end of file'