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>GstGLAPI: GStreamer Base Plugins 1.0 Library 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 Library Reference Manual"> 8<link rel="up" href="gl.html" title="OpenGL Integration Library"> 9<link rel="prev" href="gl.html" title="OpenGL Integration Library"> 10<link rel="next" href="GstGLBaseFilter.html" title="GstGLBaseFilter"> 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-libs-GstGLAPI.description" class="shortcut">Description</a></span> 19</td> 20<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 21<td><a accesskey="u" href="gl.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 22<td><a accesskey="p" href="gl.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 23<td><a accesskey="n" href="GstGLBaseFilter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 24</tr></table> 25<div class="refentry"> 26<a name="gst-plugins-base-libs-GstGLAPI"></a><div class="titlepage"></div> 27<div class="refnamediv"><table width="100%"><tr> 28<td valign="top"> 29<h2><span class="refentrytitle"><a name="gst-plugins-base-libs-GstGLAPI.top_of_page"></a>GstGLAPI</span></h2> 30<p>GstGLAPI — OpenGL API specific functionality</p> 31</td> 32<td class="gallery_image" valign="top" align="right"></td> 33</tr></table></div> 34<div class="refsect1"> 35<a name="gst-plugins-base-libs-GstGLAPI.functions"></a><h2>Functions</h2> 36<div class="informaltable"><table class="informaltable" width="100%" border="0"> 37<colgroup> 38<col width="150px" class="functions_return"> 39<col class="functions_name"> 40</colgroup> 41<tbody> 42<tr> 43<td class="function_type"> 44<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 45</td> 46<td class="function_name"> 47<a class="link" href="gst-plugins-base-libs-GstGLAPI.html#gst-gl-api-to-string" title="gst_gl_api_to_string ()">gst_gl_api_to_string</a> <span class="c_punctuation">()</span> 48</td> 49</tr> 50<tr> 51<td class="function_type"> 52<a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLAPI" title="enum GstGLAPI"><span class="returnvalue">GstGLAPI</span></a> 53</td> 54<td class="function_name"> 55<a class="link" href="gst-plugins-base-libs-GstGLAPI.html#gst-gl-api-from-string" title="gst_gl_api_from_string ()">gst_gl_api_from_string</a> <span class="c_punctuation">()</span> 56</td> 57</tr> 58<tr> 59<td class="function_type"> 60<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 61</td> 62<td class="function_name"> 63<a class="link" href="gst-plugins-base-libs-GstGLAPI.html#gst-gl-platform-to-string" title="gst_gl_platform_to_string ()">gst_gl_platform_to_string</a> <span class="c_punctuation">()</span> 64</td> 65</tr> 66<tr> 67<td class="function_type"> 68<a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLPlatform" title="enum GstGLPlatform"><span class="returnvalue">GstGLPlatform</span></a> 69</td> 70<td class="function_name"> 71<a class="link" href="gst-plugins-base-libs-GstGLAPI.html#gst-gl-platform-from-string" title="gst_gl_platform_from_string ()">gst_gl_platform_from_string</a> <span class="c_punctuation">()</span> 72</td> 73</tr> 74</tbody> 75</table></div> 76</div> 77<div class="refsect1"> 78<a name="gst-plugins-base-libs-GstGLAPI.other"></a><h2>Types and Values</h2> 79<div class="informaltable"><table class="informaltable" width="100%" border="0"> 80<colgroup> 81<col width="150px" class="name"> 82<col class="description"> 83</colgroup> 84<tbody> 85<tr> 86<td class="datatype_keyword">enum</td> 87<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLAPI" title="enum GstGLAPI">GstGLAPI</a></td> 88</tr> 89<tr> 90<td class="datatype_keyword">enum</td> 91<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLPlatform" title="enum GstGLPlatform">GstGLPlatform</a></td> 92</tr> 93<tr> 94<td class="define_keyword">#define</td> 95<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GST-GL-API-GLES1-NAME:CAPS" title="GST_GL_API_GLES1_NAME">GST_GL_API_GLES1_NAME</a></td> 96</tr> 97<tr> 98<td class="define_keyword">#define</td> 99<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GST-GL-API-GLES2-NAME:CAPS" title="GST_GL_API_GLES2_NAME">GST_GL_API_GLES2_NAME</a></td> 100</tr> 101<tr> 102<td class="define_keyword">#define</td> 103<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GST-GL-API-OPENGL3-NAME:CAPS" title="GST_GL_API_OPENGL3_NAME">GST_GL_API_OPENGL3_NAME</a></td> 104</tr> 105<tr> 106<td class="define_keyword">#define</td> 107<td class="function_name"><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GST-GL-API-OPENGL-NAME:CAPS" title="GST_GL_API_OPENGL_NAME">GST_GL_API_OPENGL_NAME</a></td> 108</tr> 109</tbody> 110</table></div> 111</div> 112<div class="refsect1"> 113<a name="gst-plugins-base-libs-GstGLAPI.includes"></a><h2>Includes</h2> 114<pre class="synopsis">#include <gst/gl/gl.h> 115</pre> 116</div> 117<div class="refsect1"> 118<a name="gst-plugins-base-libs-GstGLAPI.description"></a><h2>Description</h2> 119<p>Provides some helper API for dealing with OpenGL API's and platforms</p> 120</div> 121<div class="refsect1"> 122<a name="gst-plugins-base-libs-GstGLAPI.functions_details"></a><h2>Functions</h2> 123<div class="refsect2"> 124<a name="gst-gl-api-to-string"></a><h3>gst_gl_api_to_string ()</h3> 125<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 126gst_gl_api_to_string (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLAPI" title="enum GstGLAPI"><span class="type">GstGLAPI</span></a> api</code></em>);</pre> 127<div class="refsect3"> 128<a name="gst-gl-api-to-string.parameters"></a><h4>Parameters</h4> 129<div class="informaltable"><table class="informaltable" width="100%" border="0"> 130<colgroup> 131<col width="150px" class="parameters_name"> 132<col class="parameters_description"> 133<col width="200px" class="parameters_annotations"> 134</colgroup> 135<tbody><tr> 136<td class="parameter_name"><p>api</p></td> 137<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLAPI" title="enum GstGLAPI"><span class="type">GstGLAPI</span></a> to stringify</p></td> 138<td class="parameter_annotations"> </td> 139</tr></tbody> 140</table></div> 141</div> 142<div class="refsect3"> 143<a name="gst-gl-api-to-string.returns"></a><h4>Returns</h4> 144<p> A space seperated string of the OpenGL api's enabled in <em class="parameter"><code>api</code></em> 145</p> 146</div> 147</div> 148<hr> 149<div class="refsect2"> 150<a name="gst-gl-api-from-string"></a><h3>gst_gl_api_from_string ()</h3> 151<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLAPI" title="enum GstGLAPI"><span class="returnvalue">GstGLAPI</span></a> 152gst_gl_api_from_string (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *api_s</code></em>);</pre> 153<div class="refsect3"> 154<a name="gst-gl-api-from-string.parameters"></a><h4>Parameters</h4> 155<div class="informaltable"><table class="informaltable" width="100%" border="0"> 156<colgroup> 157<col width="150px" class="parameters_name"> 158<col class="parameters_description"> 159<col width="200px" class="parameters_annotations"> 160</colgroup> 161<tbody><tr> 162<td class="parameter_name"><p>api_s</p></td> 163<td class="parameter_description"><p>a space seperated string of OpenGL apis</p></td> 164<td class="parameter_annotations"> </td> 165</tr></tbody> 166</table></div> 167</div> 168<div class="refsect3"> 169<a name="gst-gl-api-from-string.returns"></a><h4>Returns</h4> 170<p> The <a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLAPI" title="enum GstGLAPI"><span class="type">GstGLAPI</span></a> represented by <em class="parameter"><code>api_s</code></em> 171</p> 172</div> 173</div> 174<hr> 175<div class="refsect2"> 176<a name="gst-gl-platform-to-string"></a><h3>gst_gl_platform_to_string ()</h3> 177<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * 178gst_gl_platform_to_string (<em class="parameter"><code><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLPlatform" title="enum GstGLPlatform"><span class="type">GstGLPlatform</span></a> platform</code></em>);</pre> 179<div class="refsect3"> 180<a name="gst-gl-platform-to-string.parameters"></a><h4>Parameters</h4> 181<div class="informaltable"><table class="informaltable" width="100%" border="0"> 182<colgroup> 183<col width="150px" class="parameters_name"> 184<col class="parameters_description"> 185<col width="200px" class="parameters_annotations"> 186</colgroup> 187<tbody><tr> 188<td class="parameter_name"><p>platform</p></td> 189<td class="parameter_description"><p>a <a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLPlatform" title="enum GstGLPlatform"><span class="type">GstGLPlatform</span></a> to stringify</p></td> 190<td class="parameter_annotations"> </td> 191</tr></tbody> 192</table></div> 193</div> 194<div class="refsect3"> 195<a name="gst-gl-platform-to-string.returns"></a><h4>Returns</h4> 196<p> A space seperated string of the OpenGL platforms enabled in <em class="parameter"><code>platform</code></em> 197</p> 198</div> 199</div> 200<hr> 201<div class="refsect2"> 202<a name="gst-gl-platform-from-string"></a><h3>gst_gl_platform_from_string ()</h3> 203<pre class="programlisting"><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLPlatform" title="enum GstGLPlatform"><span class="returnvalue">GstGLPlatform</span></a> 204gst_gl_platform_from_string (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *platform_s</code></em>);</pre> 205<div class="refsect3"> 206<a name="gst-gl-platform-from-string.parameters"></a><h4>Parameters</h4> 207<div class="informaltable"><table class="informaltable" width="100%" border="0"> 208<colgroup> 209<col width="150px" class="parameters_name"> 210<col class="parameters_description"> 211<col width="200px" class="parameters_annotations"> 212</colgroup> 213<tbody><tr> 214<td class="parameter_name"><p>platform_s</p></td> 215<td class="parameter_description"><p>a space seperated string of OpenGL platformss</p></td> 216<td class="parameter_annotations"> </td> 217</tr></tbody> 218</table></div> 219</div> 220<div class="refsect3"> 221<a name="gst-gl-platform-from-string.returns"></a><h4>Returns</h4> 222<p> The <a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLPlatform" title="enum GstGLPlatform"><span class="type">GstGLPlatform</span></a> represented by <em class="parameter"><code>platform_s</code></em> 223</p> 224</div> 225</div> 226</div> 227<div class="refsect1"> 228<a name="gst-plugins-base-libs-GstGLAPI.other_details"></a><h2>Types and Values</h2> 229<div class="refsect2"> 230<a name="GstGLAPI"></a><h3>enum GstGLAPI</h3> 231<div class="refsect3"> 232<a name="GstGLAPI.members"></a><h4>Members</h4> 233<div class="informaltable"><table class="informaltable" width="100%" border="0"> 234<colgroup> 235<col width="300px" class="enum_members_name"> 236<col class="enum_members_description"> 237<col width="200px" class="enum_members_annotations"> 238</colgroup> 239<tbody> 240<tr> 241<td class="enum_member_name"><p><a name="GST-GL-API-NONE:CAPS"></a>GST_GL_API_NONE</p></td> 242<td class="enum_member_description"> 243<p>no API</p> 244</td> 245<td class="enum_member_annotations"> </td> 246</tr> 247<tr> 248<td class="enum_member_name"><p><a name="GST-GL-API-OPENGL:CAPS"></a>GST_GL_API_OPENGL</p></td> 249<td class="enum_member_description"> 250<p>Desktop OpenGL up to and including 3.1. The 251 compatibility profile when the OpenGL version is >= 3.2</p> 252</td> 253<td class="enum_member_annotations"> </td> 254</tr> 255<tr> 256<td class="enum_member_name"><p><a name="GST-GL-API-OPENGL3:CAPS"></a>GST_GL_API_OPENGL3</p></td> 257<td class="enum_member_description"> 258<p>Desktop OpenGL >= 3.2 core profile</p> 259</td> 260<td class="enum_member_annotations"> </td> 261</tr> 262<tr> 263<td class="enum_member_name"><p><a name="GST-GL-API-GLES1:CAPS"></a>GST_GL_API_GLES1</p></td> 264<td class="enum_member_description"> 265<p>OpenGL ES 1.x</p> 266</td> 267<td class="enum_member_annotations"> </td> 268</tr> 269<tr> 270<td class="enum_member_name"><p><a name="GST-GL-API-GLES2:CAPS"></a>GST_GL_API_GLES2</p></td> 271<td class="enum_member_description"> 272<p>OpenGL ES 2.x and 3.x</p> 273</td> 274<td class="enum_member_annotations"> </td> 275</tr> 276<tr> 277<td class="enum_member_name"><p><a name="GST-GL-API-ANY:CAPS"></a>GST_GL_API_ANY</p></td> 278<td class="enum_member_description"> 279<p>Any OpenGL API</p> 280</td> 281<td class="enum_member_annotations"> </td> 282</tr> 283</tbody> 284</table></div> 285</div> 286</div> 287<hr> 288<div class="refsect2"> 289<a name="GstGLPlatform"></a><h3>enum GstGLPlatform</h3> 290<div class="refsect3"> 291<a name="GstGLPlatform.members"></a><h4>Members</h4> 292<div class="informaltable"><table class="informaltable" width="100%" border="0"> 293<colgroup> 294<col width="300px" class="enum_members_name"> 295<col class="enum_members_description"> 296<col width="200px" class="enum_members_annotations"> 297</colgroup> 298<tbody> 299<tr> 300<td class="enum_member_name"><p><a name="GST-GL-PLATFORM-NONE:CAPS"></a>GST_GL_PLATFORM_NONE</p></td> 301<td class="enum_member_description"> 302<p>no platform</p> 303</td> 304<td class="enum_member_annotations"> </td> 305</tr> 306<tr> 307<td class="enum_member_name"><p><a name="GST-GL-PLATFORM-EGL:CAPS"></a>GST_GL_PLATFORM_EGL</p></td> 308<td class="enum_member_description"> 309<p>the EGL platform used primarily with the X11, wayland 310 and android window systems as well as on embedded Linux</p> 311</td> 312<td class="enum_member_annotations"> </td> 313</tr> 314<tr> 315<td class="enum_member_name"><p><a name="GST-GL-PLATFORM-GLX:CAPS"></a>GST_GL_PLATFORM_GLX</p></td> 316<td class="enum_member_description"> 317<p>the GLX platform used primarily with the X11 window system</p> 318</td> 319<td class="enum_member_annotations"> </td> 320</tr> 321<tr> 322<td class="enum_member_name"><p><a name="GST-GL-PLATFORM-WGL:CAPS"></a>GST_GL_PLATFORM_WGL</p></td> 323<td class="enum_member_description"> 324<p>the WGL platform used primarily on Windows</p> 325</td> 326<td class="enum_member_annotations"> </td> 327</tr> 328<tr> 329<td class="enum_member_name"><p><a name="GST-GL-PLATFORM-CGL:CAPS"></a>GST_GL_PLATFORM_CGL</p></td> 330<td class="enum_member_description"> 331<p>the CGL platform used primarily on OS X</p> 332</td> 333<td class="enum_member_annotations"> </td> 334</tr> 335<tr> 336<td class="enum_member_name"><p><a name="GST-GL-PLATFORM-EAGL:CAPS"></a>GST_GL_PLATFORM_EAGL</p></td> 337<td class="enum_member_description"> 338<p>the EAGL platform used primarily on iOS</p> 339</td> 340<td class="enum_member_annotations"> </td> 341</tr> 342<tr> 343<td class="enum_member_name"><p><a name="GST-GL-PLATFORM-ANY:CAPS"></a>GST_GL_PLATFORM_ANY</p></td> 344<td class="enum_member_description"> 345<p>any OpenGL platform</p> 346</td> 347<td class="enum_member_annotations"> </td> 348</tr> 349</tbody> 350</table></div> 351</div> 352</div> 353<hr> 354<div class="refsect2"> 355<a name="GST-GL-API-GLES1-NAME:CAPS"></a><h3>GST_GL_API_GLES1_NAME</h3> 356<pre class="programlisting">#define GST_GL_API_GLES1_NAME "gles1" 357</pre> 358<p>The name for <a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GST-GL-API-GLES1:CAPS"><code class="literal">GST_GL_API_GLES1</code></a> used in various places</p> 359</div> 360<hr> 361<div class="refsect2"> 362<a name="GST-GL-API-GLES2-NAME:CAPS"></a><h3>GST_GL_API_GLES2_NAME</h3> 363<pre class="programlisting">#define GST_GL_API_GLES2_NAME "gles2" 364</pre> 365<p>The name for <a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GST-GL-API-GLES2:CAPS"><code class="literal">GST_GL_API_GLES2</code></a> used in various places</p> 366</div> 367<hr> 368<div class="refsect2"> 369<a name="GST-GL-API-OPENGL3-NAME:CAPS"></a><h3>GST_GL_API_OPENGL3_NAME</h3> 370<pre class="programlisting">#define GST_GL_API_OPENGL3_NAME "opengl3" 371</pre> 372<p>The name for <a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GST-GL-API-OPENGL3:CAPS"><code class="literal">GST_GL_API_OPENGL3</code></a> used in various places</p> 373</div> 374<hr> 375<div class="refsect2"> 376<a name="GST-GL-API-OPENGL-NAME:CAPS"></a><h3>GST_GL_API_OPENGL_NAME</h3> 377<pre class="programlisting">#define GST_GL_API_OPENGL_NAME "opengl" 378</pre> 379<p>The name for <a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GST-GL-API-OPENGL:CAPS"><code class="literal">GST_GL_API_OPENGL</code></a> used in various places</p> 380</div> 381</div> 382<div class="refsect1"> 383<a name="gst-plugins-base-libs-GstGLAPI.see-also"></a><h2>See Also</h2> 384<p><a class="link" href="GstGLDisplay.html" title="GstGLDisplay"><span class="type">GstGLDisplay</span></a>, <a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a></p> 385</div> 386</div> 387<div class="footer"> 388<hr>Generated by GTK-Doc V1.28</div> 389</body> 390</html>
