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>glshader: 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-gloverlay.html" title="gloverlay"> 10<link rel="next" href="gst-plugins-base-plugins-glsinkbin.html" title="glsinkbin"> 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-glshader.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-glshader.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-glshader.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 21 <a href="#gst-plugins-base-plugins-glshader.signals" class="shortcut">Signals</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gst-plugins-base-plugins-gloverlay.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-base-plugins-glsinkbin.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gst-plugins-base-plugins-glshader"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-glshader.top_of_page"></a>glshader</span></h2> 33<p>glshader</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gst-plugins-base-plugins-glshader.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"> 48<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 49<td class="property_name"><a class="link" href="gst-plugins-base-plugins-glshader.html#GstGLFilterShader--fragment" title="The “fragment” property">fragment</a></td> 50<td class="property_flags">Read / Write</td> 51</tr> 52<tr> 53<td class="property_type"> 54<a href="../html/GstGLShader.html#GstGLShader-struct"><span class="type">GstGLShader</span></a> *</td> 55<td class="property_name"><a class="link" href="gst-plugins-base-plugins-glshader.html#GstGLFilterShader--shader" title="The “shader” property">shader</a></td> 56<td class="property_flags">Read / Write</td> 57</tr> 58<tr> 59<td class="property_type"> 60<a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *</td> 61<td class="property_name"><a class="link" href="gst-plugins-base-plugins-glshader.html#GstGLFilterShader--uniforms" title="The “uniforms” property">uniforms</a></td> 62<td class="property_flags">Read / Write</td> 63</tr> 64<tr> 65<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 66<td class="property_name"><a class="link" href="gst-plugins-base-plugins-glshader.html#GstGLFilterShader--update-shader" title="The “update-shader” property">update-shader</a></td> 67<td class="property_flags">Write</td> 68</tr> 69<tr> 70<td class="property_type"> 71<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> 72<td class="property_name"><a class="link" href="gst-plugins-base-plugins-glshader.html#GstGLFilterShader--vertex" title="The “vertex” property">vertex</a></td> 73<td class="property_flags">Read / Write</td> 74</tr> 75</tbody> 76</table></div> 77</div> 78<div class="refsect1"> 79<a name="gst-plugins-base-plugins-glshader.signals"></a><h2>Signals</h2> 80<div class="informaltable"><table class="informaltable" border="0"> 81<colgroup> 82<col width="150px" class="signals_return"> 83<col width="300px" class="signals_name"> 84<col width="200px" class="signals_flags"> 85</colgroup> 86<tbody><tr> 87<td class="signal_type"> 88<a href="../html/GstGLShader.html#GstGLShader-struct"><span class="returnvalue">GstGLShader</span></a>*</td> 89<td class="signal_name"><a class="link" href="gst-plugins-base-plugins-glshader.html#GstGLFilterShader-create-shader" title="The “create-shader” signal">create-shader</a></td> 90<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> 91</tr></tbody> 92</table></div> 93</div> 94<a name="GstGLFilterShader"></a><div class="refsect1"> 95<a name="gst-plugins-base-plugins-glshader.other"></a><h2>Types and Values</h2> 96<div class="informaltable"><table class="informaltable" width="100%" border="0"> 97<colgroup> 98<col width="150px" class="name"> 99<col class="description"> 100</colgroup> 101<tbody><tr> 102<td class="datatype_keyword">struct</td> 103<td class="function_name"><a class="link" href="gst-plugins-base-plugins-glshader.html#GstGLFilterShader-struct" title="struct GstGLFilterShader">GstGLFilterShader</a></td> 104</tr></tbody> 105</table></div> 106</div> 107<div class="refsect1"> 108<a name="gst-plugins-base-plugins-glshader.object-hierarchy"></a><h2>Object Hierarchy</h2> 109<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 110 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 111 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 112 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 113 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 114 <span class="lineart">╰──</span> <a href="../html/GstGLBaseFilter.html#GstGLBaseFilter-struct">GstGLBaseFilter</a> 115 <span class="lineart">╰──</span> <a href="../html/GstGLFilter.html#GstGLFilter-struct">GstGLFilter</a> 116 <span class="lineart">╰──</span> GstGLFilterShader 117</pre> 118</div> 119<div class="refsect1"> 120<a name="gst-plugins-base-plugins-glshader.description"></a><h2>Description</h2> 121<p>OpenGL fragment shader filter</p> 122<div class="refsect3"> 123<a name="id-1.2.59.8.3"></a><h4>Examples</h4> 124<div class="informalexample"> 125 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 126 <tbody> 127 <tr> 128 <td class="listing_lines" align="right"><pre>1</pre></td> 129 <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> glupload <span class="gtkdoc opt">!</span> glshader fragment<span class="gtkdoc opt">=</span><span class="string">"</span><span class="gtkdoc esc">\"</span><span class="string">`cat myshader.frag`</span><span class="gtkdoc esc">\"</span><span class="string">"</span> <span class="gtkdoc opt">!</span> glimagesink</pre></td> 130 </tr> 131 </tbody> 132 </table> 133</div> 134 135<p> 136FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. 137Depending on the exact OpenGL version chosen and the exact requirements of 138the OpenGL implementation, a <span class="type">version</span> header may be required.</p> 139<p>The following is a simple OpenGL ES (also usable with OpenGL 3 core contexts) 140passthrough shader with the required inputs.</p> 141<div class="informalexample"> 142 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 143 <tbody> 144 <tr> 145 <td class="listing_lines" align="right"><pre>1 1462 1473 1484 1495 1506 1517 1528 1539 15410 15511 15612 15713</pre></td> 158 <td class="listing_code"><pre class="programlisting"><span class="gtkdoc ppc">#version 100</span> 159<span class="gtkdoc ppc">#ifdef GL_ES</span> 160precision mediump <span class="gtkdoc kwb">float</span><span class="gtkdoc opt">;</span> 161<span class="gtkdoc ppc">#endif</span> 162varying vec2 v_texcoord<span class="gtkdoc opt">;</span> 163uniform sampler2D tex<span class="gtkdoc opt">;</span> 164uniform <span class="gtkdoc kwb">float</span> time<span class="gtkdoc opt">;</span> 165uniform <span class="gtkdoc kwb">float</span> width<span class="gtkdoc opt">;</span> 166uniform <span class="gtkdoc kwb">float</span> height<span class="gtkdoc opt">;</span> 167 168<span class="gtkdoc kwb">void</span> <span class="function">main</span> <span class="gtkdoc opt">() {</span> 169 gl_FragColor <span class="gtkdoc opt">=</span> <span class="function">texture2D</span><span class="gtkdoc opt">(</span> tex<span class="gtkdoc opt">,</span> v_texcoord <span class="gtkdoc opt">);</span> 170<span class="gtkdoc opt">}</span></pre></td> 171 </tr> 172 </tbody> 173 </table> 174</div> 175 176<p></p> 177</div> 178<div class="refsynopsisdiv"> 179<h2>Synopsis</h2> 180<div class="refsect2"> 181<a name="id-1.2.59.8.4.1"></a><h3>Element Information</h3> 182<div class="variablelist"><table border="0" class="variablelist"> 183<colgroup> 184<col align="left" valign="top"> 185<col> 186</colgroup> 187<tbody> 188<tr> 189<td><p><span class="term">plugin</span></p></td> 190<td> 191 <a class="link" href="gst-plugins-base-plugins-plugin-opengl.html#plugin-opengl">opengl</a> 192 </td> 193</tr> 194<tr> 195<td><p><span class="term">author</span></p></td> 196<td><matthew@centricular.com></td> 197</tr> 198<tr> 199<td><p><span class="term">class</span></p></td> 200<td>Filter/Effect</td> 201</tr> 202</tbody> 203</table></div> 204</div> 205<hr> 206<div class="refsect2"> 207<a name="id-1.2.59.8.4.2"></a><h3>Element Pads</h3> 208<div class="variablelist"><table border="0" class="variablelist"> 209<colgroup> 210<col align="left" valign="top"> 211<col> 212</colgroup> 213<tbody> 214<tr> 215<td><p><span class="term">name</span></p></td> 216<td>sink</td> 217</tr> 218<tr> 219<td><p><span class="term">direction</span></p></td> 220<td>sink</td> 221</tr> 222<tr> 223<td><p><span class="term">presence</span></p></td> 224<td>always</td> 225</tr> 226<tr> 227<td><p><span class="term">details</span></p></td> 228<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> 229</tr> 230<tr> 231<td><p><span class="term"></span></p></td> 232<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> 233</tr> 234</tbody> 235</table></div> 236<div class="variablelist"><table border="0" class="variablelist"> 237<colgroup> 238<col align="left" valign="top"> 239<col> 240</colgroup> 241<tbody> 242<tr> 243<td><p><span class="term">name</span></p></td> 244<td>src</td> 245</tr> 246<tr> 247<td><p><span class="term">direction</span></p></td> 248<td>source</td> 249</tr> 250<tr> 251<td><p><span class="term">presence</span></p></td> 252<td>always</td> 253</tr> 254<tr> 255<td><p><span class="term">details</span></p></td> 256<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> 257</tr> 258<tr> 259<td><p><span class="term"></span></p></td> 260<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> 261</tr> 262</tbody> 263</table></div> 264</div> 265</div> 266</div> 267<div class="refsect1"> 268<a name="gst-plugins-base-plugins-glshader.functions_details"></a><h2>Functions</h2> 269<p></p> 270</div> 271<div class="refsect1"> 272<a name="gst-plugins-base-plugins-glshader.other_details"></a><h2>Types and Values</h2> 273<div class="refsect2"> 274<a name="GstGLFilterShader-struct"></a><h3>struct GstGLFilterShader</h3> 275<pre class="programlisting">struct GstGLFilterShader;</pre> 276</div> 277</div> 278<div class="refsect1"> 279<a name="gst-plugins-base-plugins-glshader.property-details"></a><h2>Property Details</h2> 280<div class="refsect2"> 281<a name="GstGLFilterShader--fragment"></a><h3>The <code class="literal">“fragment”</code> property</h3> 282<pre class="programlisting"> “fragment” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 283<p>GLSL fragment source.</p> 284<p>Flags: Read / Write</p> 285<p>Default value: NULL</p> 286</div> 287<hr> 288<div class="refsect2"> 289<a name="GstGLFilterShader--shader"></a><h3>The <code class="literal">“shader”</code> property</h3> 290<pre class="programlisting"> “shader” <a href="../html/GstGLShader.html#GstGLShader-struct"><span class="type">GstGLShader</span></a> *</pre> 291<p>GstGLShader to use.</p> 292<p>Flags: Read / Write</p> 293</div> 294<hr> 295<div class="refsect2"> 296<a name="GstGLFilterShader--uniforms"></a><h3>The <code class="literal">“uniforms”</code> property</h3> 297<pre class="programlisting"> “uniforms” <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstStructure.html#GstStructure-struct"><span class="type">GstStructure</span></a> *</pre> 298<p>GLSL Uniforms.</p> 299<p>Flags: Read / Write</p> 300</div> 301<hr> 302<div class="refsect2"> 303<a name="GstGLFilterShader--update-shader"></a><h3>The <code class="literal">“update-shader”</code> property</h3> 304<pre class="programlisting"> “update-shader” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 305<p>Emit the 'create-shader' signal for the next frame.</p> 306<p>Flags: Write</p> 307<p>Default value: FALSE</p> 308</div> 309<hr> 310<div class="refsect2"> 311<a name="GstGLFilterShader--vertex"></a><h3>The <code class="literal">“vertex”</code> property</h3> 312<pre class="programlisting"> “vertex” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> 313<p>GLSL vertex source.</p> 314<p>Flags: Read / Write</p> 315<p>Default value: NULL</p> 316</div> 317</div> 318<div class="refsect1"> 319<a name="gst-plugins-base-plugins-glshader.signal-details"></a><h2>Signal Details</h2> 320<div class="refsect2"> 321<a name="GstGLFilterShader-create-shader"></a><h3>The <code class="literal">“create-shader”</code> signal</h3> 322<pre class="programlisting"><a href="../html/GstGLShader.html#GstGLShader-struct"><span class="returnvalue">GstGLShader</span></a>* 323user_function (<a class="link" href="gst-plugins-base-plugins-glshader.html#GstGLFilterShader"><span class="type">GstGLFilterShader</span></a> *gstglfiltershader, 324 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> 325<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> 326</div> 327</div> 328</div> 329<div class="footer"> 330<hr>Generated by GTK-Doc V1.28</div> 331</body> 332</html>
