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>GstGLBaseFilter: 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="gst-plugins-base-libs-GstGLAPI.html" title="GstGLAPI"> 10<link rel="next" href="gst-plugins-base-libs-GstGLBaseMemory.html" title="GstGLBaseMemory"> 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="#GstGLBaseFilter.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#GstGLBaseFilter.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#GstGLBaseFilter.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="gl.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-base-libs-GstGLAPI.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-base-libs-GstGLBaseMemory.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="GstGLBaseFilter"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="GstGLBaseFilter.top_of_page"></a>GstGLBaseFilter</span></h2> 32<p>GstGLBaseFilter — <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct"><span class="type">GstBaseTransform</span></a> subclass for transforming OpenGL resources</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="GstGLBaseFilter.functions"></a><h2>Functions</h2> 38<div class="informaltable"><table class="informaltable" width="100%" border="0"> 39<colgroup> 40<col width="150px" class="functions_return"> 41<col class="functions_name"> 42</colgroup> 43<tbody><tr> 44<td class="function_type"> 45<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 46</td> 47<td class="function_name"> 48<a class="link" href="GstGLBaseFilter.html#gst-gl-base-filter-find-gl-context" title="gst_gl_base_filter_find_gl_context ()">gst_gl_base_filter_find_gl_context</a> <span class="c_punctuation">()</span> 49</td> 50</tr></tbody> 51</table></div> 52</div> 53<div class="refsect1"> 54<a name="GstGLBaseFilter.properties"></a><h2>Properties</h2> 55<div class="informaltable"><table class="informaltable" border="0"> 56<colgroup> 57<col width="150px" class="properties_type"> 58<col width="300px" class="properties_name"> 59<col width="200px" class="properties_flags"> 60</colgroup> 61<tbody><tr> 62<td class="property_type"> 63<a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a> *</td> 64<td class="property_name"><a class="link" href="GstGLBaseFilter.html#GstGLBaseFilter--context" title="The “context” property">context</a></td> 65<td class="property_flags">Read</td> 66</tr></tbody> 67</table></div> 68</div> 69<div class="refsect1"> 70<a name="GstGLBaseFilter.other"></a><h2>Types and Values</h2> 71<div class="informaltable"><table class="informaltable" width="100%" border="0"> 72<colgroup> 73<col width="150px" class="name"> 74<col class="description"> 75</colgroup> 76<tbody> 77<tr> 78<td class="datatype_keyword"> </td> 79<td class="function_name"><a class="link" href="GstGLBaseFilter.html#GstGLBaseFilter-struct" title="GstGLBaseFilter">GstGLBaseFilter</a></td> 80</tr> 81<tr> 82<td class="datatype_keyword"> </td> 83<td class="function_name"><a class="link" href="GstGLBaseFilter.html#GstGLBaseFilterClass" title="GstGLBaseFilterClass">GstGLBaseFilterClass</a></td> 84</tr> 85</tbody> 86</table></div> 87</div> 88<div class="refsect1"> 89<a name="GstGLBaseFilter.object-hierarchy"></a><h2>Object Hierarchy</h2> 90<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 91 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 92 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 93 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 94 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 95 <span class="lineart">╰──</span> GstGLBaseFilter 96 <span class="lineart">╰──</span> <a class="link" href="GstGLFilter.html" title="GstGLFilter">GstGLFilter</a> 97</pre> 98</div> 99<div class="refsect1"> 100<a name="GstGLBaseFilter.includes"></a><h2>Includes</h2> 101<pre class="synopsis">#include <gst/gl/gl.h> 102</pre> 103</div> 104<div class="refsect1"> 105<a name="GstGLBaseFilter.description"></a><h2>Description</h2> 106<p><a class="link" href="GstGLBaseFilter.html" title="GstGLBaseFilter"><span class="type">GstGLBaseFilter</span></a> handles the nitty gritty details of retrieving an OpenGL 107context. It also provided some wrappers around <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct"><span class="type">GstBaseTransform</span></a>'s 108<code class="function">start()</code>, <code class="function">stop()</code> and <code class="function">set_caps()</code> virtual methods that ensure an OpenGL context 109is available and current in the calling thread.</p> 110</div> 111<div class="refsect1"> 112<a name="GstGLBaseFilter.functions_details"></a><h2>Functions</h2> 113<div class="refsect2"> 114<a name="gst-gl-base-filter-find-gl-context"></a><h3>gst_gl_base_filter_find_gl_context ()</h3> 115<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 116gst_gl_base_filter_find_gl_context (<em class="parameter"><code><a class="link" href="GstGLBaseFilter.html" title="GstGLBaseFilter"><span class="type">GstGLBaseFilter</span></a> *filter</code></em>);</pre> 117<div class="refsect3"> 118<a name="gst-gl-base-filter-find-gl-context.parameters"></a><h4>Parameters</h4> 119<div class="informaltable"><table class="informaltable" width="100%" border="0"> 120<colgroup> 121<col width="150px" class="parameters_name"> 122<col class="parameters_description"> 123<col width="200px" class="parameters_annotations"> 124</colgroup> 125<tbody><tr> 126<td class="parameter_name"><p>filter</p></td> 127<td class="parameter_description"><p>a <a class="link" href="GstGLBaseFilter.html" title="GstGLBaseFilter"><span class="type">GstGLBaseFilter</span></a></p></td> 128<td class="parameter_annotations"> </td> 129</tr></tbody> 130</table></div> 131</div> 132<div class="refsect3"> 133<a name="gst-gl-base-filter-find-gl-context.returns"></a><h4>Returns</h4> 134<p> Whether an OpenGL context could be retrieved or created successfully</p> 135</div> 136<p class="since">Since: <a class="link" href="ix03.html#api-index-1.16">1.16</a></p> 137</div> 138</div> 139<div class="refsect1"> 140<a name="GstGLBaseFilter.other_details"></a><h2>Types and Values</h2> 141<div class="refsect2"> 142<a name="GstGLBaseFilter-struct"></a><h3>GstGLBaseFilter</h3> 143<pre class="programlisting">typedef struct { 144 GstGLDisplay *display; 145 GstGLContext *context; 146 147 GstCaps *in_caps; 148 GstCaps *out_caps; 149} GstGLBaseFilter; 150</pre> 151<p>The parent instance type of a base GStreamer GL Filter.</p> 152<div class="refsect3"> 153<a name="GstGLBaseFilter.members"></a><h4>Members</h4> 154<div class="informaltable"><table class="informaltable" width="100%" border="0"> 155<colgroup> 156<col width="300px" class="struct_members_name"> 157<col class="struct_members_description"> 158<col width="200px" class="struct_members_annotations"> 159</colgroup> 160<tbody> 161<tr> 162<td class="struct_member_name"><p><a class="link" href="GstGLDisplay.html" title="GstGLDisplay"><span class="type">GstGLDisplay</span></a> *<em class="structfield"><code><a name="GstGLBaseFilter-struct.display"></a>display</code></em>;</p></td> 163<td class="struct_member_description"><p>the currently configured <a class="link" href="GstGLDisplay.html" title="GstGLDisplay"><span class="type">GstGLDisplay</span></a></p></td> 164<td class="struct_member_annotations"> </td> 165</tr> 166<tr> 167<td class="struct_member_name"><p><a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a> *<em class="structfield"><code><a name="GstGLBaseFilter-struct.context"></a>context</code></em>;</p></td> 168<td class="struct_member_description"><p>the currently configured <a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a></p></td> 169<td class="struct_member_annotations"> </td> 170</tr> 171<tr> 172<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> *<em class="structfield"><code><a name="GstGLBaseFilter-struct.in-caps"></a>in_caps</code></em>;</p></td> 173<td class="struct_member_description"><p>the currently configured input <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a></p></td> 174<td class="struct_member_annotations"> </td> 175</tr> 176<tr> 177<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a> *<em class="structfield"><code><a name="GstGLBaseFilter-struct.out-caps"></a>out_caps</code></em>;</p></td> 178<td class="struct_member_description"><p>the currently configured output <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstCaps.html#GstCaps-struct"><span class="type">GstCaps</span></a></p></td> 179<td class="struct_member_annotations"> </td> 180</tr> 181</tbody> 182</table></div> 183</div> 184</div> 185<hr> 186<div class="refsect2"> 187<a name="GstGLBaseFilterClass"></a><h3>GstGLBaseFilterClass</h3> 188<pre class="programlisting">typedef struct { 189 GstBaseTransformClass parent_class; 190 191 GstGLAPI supported_gl_api; 192 193 gboolean (*gl_start) (GstGLBaseFilter *filter); 194 void (*gl_stop) (GstGLBaseFilter *filter); 195 gboolean (*gl_set_caps) (GstGLBaseFilter *filter, GstCaps * incaps, GstCaps * outcaps); 196} GstGLBaseFilterClass; 197</pre> 198<p>The base class for GStreamer GL Filter.</p> 199<div class="refsect3"> 200<a name="GstGLBaseFilterClass.members"></a><h4>Members</h4> 201<div class="informaltable"><table class="informaltable" width="100%" border="0"> 202<colgroup> 203<col width="300px" class="struct_members_name"> 204<col class="struct_members_description"> 205<col width="200px" class="struct_members_annotations"> 206</colgroup> 207<tbody> 208<tr> 209<td class="struct_member_name"><p><a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLAPI" title="enum GstGLAPI"><span class="type">GstGLAPI</span></a> <em class="structfield"><code><a name="GstGLBaseFilterClass.supported-gl-api"></a>supported_gl_api</code></em>;</p></td> 210<td class="struct_member_description"><p>the logical-OR of <a class="link" href="gst-plugins-base-libs-GstGLAPI.html#GstGLAPI" title="enum GstGLAPI"><span class="type">GstGLAPI</span></a>'s supported by this element</p></td> 211<td class="struct_member_annotations"> </td> 212</tr> 213<tr> 214<td class="struct_member_name"><p><em class="structfield"><code><a name="GstGLBaseFilterClass.gl-start"></a>gl_start</code></em> ()</p></td> 215<td class="struct_member_description"><p>called in the GL thread to setup the element GL state.</p></td> 216<td class="struct_member_annotations"> </td> 217</tr> 218<tr> 219<td class="struct_member_name"><p><em class="structfield"><code><a name="GstGLBaseFilterClass.gl-stop"></a>gl_stop</code></em> ()</p></td> 220<td class="struct_member_description"><p>called in the GL thread to setup the element GL state.</p></td> 221<td class="struct_member_annotations"> </td> 222</tr> 223<tr> 224<td class="struct_member_name"><p><em class="structfield"><code><a name="GstGLBaseFilterClass.gl-set-caps"></a>gl_set_caps</code></em> ()</p></td> 225<td class="struct_member_description"><p>called in the GL thread when caps are set on <em class="parameter"><code>filter</code></em> 226.</p></td> 227<td class="struct_member_annotations"> </td> 228</tr> 229</tbody> 230</table></div> 231</div> 232</div> 233</div> 234<div class="refsect1"> 235<a name="GstGLBaseFilter.property-details"></a><h2>Property Details</h2> 236<div class="refsect2"> 237<a name="GstGLBaseFilter--context"></a><h3>The <code class="literal">“context”</code> property</h3> 238<pre class="programlisting"> “context” <a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a> *</pre> 239<p>Get OpenGL context.</p> 240<p>Flags: Read</p> 241</div> 242</div> 243<div class="refsect1"> 244<a name="GstGLBaseFilter.see-also"></a><h2>See Also</h2> 245<p><a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct"><span class="type">GstBaseTransform</span></a></p> 246</div> 247</div> 248<div class="footer"> 249<hr>Generated by GTK-Doc V1.28</div> 250</body> 251</html>
