1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>gloverlay: GStreamer Base Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-base Elements"> 9<link rel="prev" href="gst-plugins-base-plugins-glmosaic.html" title="glmosaic"> 10<link rel="next" href="gst-plugins-base-plugins-glshader.html" title="glshader"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 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="5"><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-plugins-gloverlay.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-gloverlay.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-gloverlay.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-base-plugins-glmosaic.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-base-plugins-glshader.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-base-plugins-gloverlay"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-gloverlay.top_of_page"></a>gloverlay</span></h2> 32<p>gloverlay</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-base-plugins-gloverlay.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-base-plugins-gloverlay.html#GstGLOverlay--alpha" title="The “alpha” property">alpha</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"> 52<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 53<td class="property_name"><a class="link" href="gst-plugins-base-plugins-gloverlay.html#GstGLOverlay--location" title="The “location” property">location</a></td> 54<td class="property_flags">Read / Write</td> 55</tr> 56<tr> 57<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 58<td class="property_name"><a class="link" href="gst-plugins-base-plugins-gloverlay.html#GstGLOverlay--offset-x" title="The “offset-x” property">offset-x</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61<tr> 62<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 63<td class="property_name"><a class="link" href="gst-plugins-base-plugins-gloverlay.html#GstGLOverlay--offset-y" title="The “offset-y” property">offset-y</a></td> 64<td class="property_flags">Read / Write</td> 65</tr> 66<tr> 67<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 68<td class="property_name"><a class="link" href="gst-plugins-base-plugins-gloverlay.html#GstGLOverlay--overlay-height" title="The “overlay-height” property">overlay-height</a></td> 69<td class="property_flags">Read / Write</td> 70</tr> 71<tr> 72<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 73<td class="property_name"><a class="link" href="gst-plugins-base-plugins-gloverlay.html#GstGLOverlay--overlay-width" title="The “overlay-width” property">overlay-width</a></td> 74<td class="property_flags">Read / Write</td> 75</tr> 76<tr> 77<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 78<td class="property_name"><a class="link" href="gst-plugins-base-plugins-gloverlay.html#GstGLOverlay--relative-x" title="The “relative-x” property">relative-x</a></td> 79<td class="property_flags">Read / Write</td> 80</tr> 81<tr> 82<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 83<td class="property_name"><a class="link" href="gst-plugins-base-plugins-gloverlay.html#GstGLOverlay--relative-y" title="The “relative-y” property">relative-y</a></td> 84<td class="property_flags">Read / Write</td> 85</tr> 86</tbody> 87</table></div> 88</div> 89<a name="GstGLOverlay"></a><div class="refsect1"> 90<a name="gst-plugins-base-plugins-gloverlay.other"></a><h2>Types and Values</h2> 91<div class="informaltable"><table class="informaltable" width="100%" border="0"> 92<colgroup> 93<col width="150px" class="name"> 94<col class="description"> 95</colgroup> 96<tbody><tr> 97<td class="datatype_keyword">struct</td> 98<td class="function_name"><a class="link" href="gst-plugins-base-plugins-gloverlay.html#GstGLOverlay-struct" title="struct GstGLOverlay">GstGLOverlay</a></td> 99</tr></tbody> 100</table></div> 101</div> 102<div class="refsect1"> 103<a name="gst-plugins-base-plugins-gloverlay.object-hierarchy"></a><h2>Object Hierarchy</h2> 104<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 105 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 106 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 107 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 108 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 109 <span class="lineart">╰──</span> <a href="../html/GstGLBaseFilter.html#GstGLBaseFilter-struct">GstGLBaseFilter</a> 110 <span class="lineart">╰──</span> <a href="../html/GstGLFilter.html#GstGLFilter-struct">GstGLFilter</a> 111 <span class="lineart">╰──</span> GstGLOverlay 112</pre> 113</div> 114<div class="refsect1"> 115<a name="gst-plugins-base-plugins-gloverlay.description"></a><h2>Description</h2> 116<p>Overlay GL video texture with a PNG image</p> 117<div class="refsect3"> 118<a name="id-1.2.58.7.3"></a><h4>Examples</h4> 119<div class="informalexample"> 120 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 121 <tbody> 122 <tr> 123 <td class="listing_lines" align="right"><pre>1</pre></td> 124 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> videotestsrc <span class="gtkdoc opt">!</span> gloverlay location<span class="gtkdoc opt">=</span>image<span class="gtkdoc opt">.</span>jpg <span class="gtkdoc opt">!</span> glimagesink</pre></td> 125 </tr> 126 </tbody> 127 </table> 128</div> 129 130<p> 131FBO (Frame Buffer Object) is required.</p> 132</div> 133<div class="refsynopsisdiv"> 134<h2>Synopsis</h2> 135<div class="refsect2"> 136<a name="id-1.2.58.7.4.1"></a><h3>Element Information</h3> 137<div class="variablelist"><table border="0" class="variablelist"> 138<colgroup> 139<col align="left" valign="top"> 140<col> 141</colgroup> 142<tbody> 143<tr> 144<td><p><span class="term">plugin</span></p></td> 145<td> 146 <a class="link" href="gst-plugins-base-plugins-plugin-opengl.html#plugin-opengl">opengl</a> 147 </td> 148</tr> 149<tr> 150<td><p><span class="term">author</span></p></td> 151<td>Filippo Argiolas <filippo.argiolas@gmail.com>, Matthew Waters <matthew@centricular.com></td> 152</tr> 153<tr> 154<td><p><span class="term">class</span></p></td> 155<td>Filter/Effect/Video</td> 156</tr> 157</tbody> 158</table></div> 159</div> 160<hr> 161<div class="refsect2"> 162<a name="id-1.2.58.7.4.2"></a><h3>Element Pads</h3> 163<div class="variablelist"><table border="0" class="variablelist"> 164<colgroup> 165<col align="left" valign="top"> 166<col> 167</colgroup> 168<tbody> 169<tr> 170<td><p><span class="term">name</span></p></td> 171<td>sink</td> 172</tr> 173<tr> 174<td><p><span class="term">direction</span></p></td> 175<td>sink</td> 176</tr> 177<tr> 178<td><p><span class="term">presence</span></p></td> 179<td>always</td> 180</tr> 181<tr> 182<td><p><span class="term">details</span></p></td> 183<td>video/x-raw(ANY), format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ], texture-target=(string)2D</td> 184</tr> 185<tr> 186<td><p><span class="term"></span></p></td> 187<td> video/x-raw(memory:GLMemory), format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ], texture-target=(string)2D</td> 188</tr> 189</tbody> 190</table></div> 191<div class="variablelist"><table border="0" class="variablelist"> 192<colgroup> 193<col align="left" valign="top"> 194<col> 195</colgroup> 196<tbody> 197<tr> 198<td><p><span class="term">name</span></p></td> 199<td>src</td> 200</tr> 201<tr> 202<td><p><span class="term">direction</span></p></td> 203<td>source</td> 204</tr> 205<tr> 206<td><p><span class="term">presence</span></p></td> 207<td>always</td> 208</tr> 209<tr> 210<td><p><span class="term">details</span></p></td> 211<td>video/x-raw(memory:GLMemory), format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ], texture-target=(string)2D</td> 212</tr> 213<tr> 214<td><p><span class="term"></span></p></td> 215<td> video/x-raw(ANY), format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ], texture-target=(string)2D</td> 216</tr> 217</tbody> 218</table></div> 219</div> 220</div> 221</div> 222<div class="refsect1"> 223<a name="gst-plugins-base-plugins-gloverlay.functions_details"></a><h2>Functions</h2> 224<p></p> 225</div> 226<div class="refsect1"> 227<a name="gst-plugins-base-plugins-gloverlay.other_details"></a><h2>Types and Values</h2> 228<div class="refsect2"> 229<a name="GstGLOverlay-struct"></a><h3>struct GstGLOverlay</h3> 230<pre class="programlisting">struct GstGLOverlay;</pre> 231</div> 232</div> 233<div class="refsect1"> 234<a name="gst-plugins-base-plugins-gloverlay.property-details"></a><h2>Property Details</h2> 235<div class="refsect2"> 236<a name="GstGLOverlay--alpha"></a><h3>The <code class="literal">“alpha”</code> property</h3> 237<pre class="programlisting"> “alpha” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 238<p>Global alpha of overlay image.</p> 239<p>Flags: Read / Write</p> 240<p>Allowed values: [0,1]</p> 241<p>Default value: 1</p> 242</div> 243<hr> 244<div class="refsect2"> 245<a name="GstGLOverlay--location"></a><h3>The <code class="literal">“location”</code> property</h3> 246<pre class="programlisting"> “location” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 247<p>Location of image file to overlay.</p> 248<p>Flags: Read / Write</p> 249<p>Default value: NULL</p> 250</div> 251<hr> 252<div class="refsect2"> 253<a name="GstGLOverlay--offset-x"></a><h3>The <code class="literal">“offset-x”</code> property</h3> 254<pre class="programlisting"> “offset-x” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 255<p>For positive value, horizontal offset of overlay image in pixels from left of video image. For negative value, horizontal offset of overlay image in pixels from right of video image.</p> 256<p>Flags: Read / Write</p> 257<p>Default value: 0</p> 258</div> 259<hr> 260<div class="refsect2"> 261<a name="GstGLOverlay--offset-y"></a><h3>The <code class="literal">“offset-y”</code> property</h3> 262<pre class="programlisting"> “offset-y” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 263<p>For positive value, vertical offset of overlay image in pixels from top of video image. For negative value, vertical offset of overlay image in pixels from bottom of video image.</p> 264<p>Flags: Read / Write</p> 265<p>Default value: 0</p> 266</div> 267<hr> 268<div class="refsect2"> 269<a name="GstGLOverlay--overlay-height"></a><h3>The <code class="literal">“overlay-height”</code> property</h3> 270<pre class="programlisting"> “overlay-height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 271<p>Height of overlay image in pixels (0 = same as overlay image).</p> 272<p>Flags: Read / Write</p> 273<p>Allowed values: >= 0</p> 274<p>Default value: 0</p> 275</div> 276<hr> 277<div class="refsect2"> 278<a name="GstGLOverlay--overlay-width"></a><h3>The <code class="literal">“overlay-width”</code> property</h3> 279<pre class="programlisting"> “overlay-width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 280<p>Width of overlay image in pixels (0 = same as overlay image).</p> 281<p>Flags: Read / Write</p> 282<p>Allowed values: >= 0</p> 283<p>Default value: 0</p> 284</div> 285<hr> 286<div class="refsect2"> 287<a name="GstGLOverlay--relative-x"></a><h3>The <code class="literal">“relative-x”</code> property</h3> 288<pre class="programlisting"> “relative-x” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 289<p>Horizontal offset of overlay image in fractions of video image width, from top-left corner of video image.</p> 290<p>Flags: Read / Write</p> 291<p>Allowed values: [0,1]</p> 292<p>Default value: 0</p> 293</div> 294<hr> 295<div class="refsect2"> 296<a name="GstGLOverlay--relative-y"></a><h3>The <code class="literal">“relative-y”</code> property</h3> 297<pre class="programlisting"> “relative-y” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 298<p>Vertical offset of overlay image in fractions of video image height, from top-left corner of video image.</p> 299<p>Flags: Read / Write</p> 300<p>Allowed values: [0,1]</p> 301<p>Default value: 0</p> 302</div> 303</div> 304</div> 305<div class="footer"> 306<hr>Generated by GTK-Doc V1.28</div> 307</body> 308</html>
