blob: fa0423f7ed7ad257c62cefb59c961e3bba7ba33e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstGLQuery: GStreamer Bad Plugins 1.0 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Library Reference Manual">
<link rel="up" href="gl.html" title="OpenGL Helper Library">
<link rel="prev" href="gst-plugins-bad-libs-GstGLOverlayCompositor.html" title="GstGLOverlayCompositor">
<link rel="next" href="gst-plugins-bad-libs-GstGLRenderbuffer.html" title="GstGLRenderbuffer">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#gst-plugins-bad-libs-GstGLQuery.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="gl.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-libs-GstGLOverlayCompositor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-libs-GstGLRenderbuffer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-libs-GstGLQuery"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-libs-GstGLQuery.top_of_page"></a>GstGLQuery</span></h2>
<p>GstGLQuery — OpenGL query abstraction</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLQuery.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-counter" title="gst_gl_query_counter ()">gst_gl_query_counter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-counter-log" title="gst_gl_query_counter_log()">gst_gl_query_counter_log</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-counter-log-valist" title="gst_gl_query_counter_log_valist()">gst_gl_query_counter_log_valist</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-end" title="gst_gl_query_end ()">gst_gl_query_end</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-free" title="gst_gl_query_free ()">gst_gl_query_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-init" title="gst_gl_query_init ()">gst_gl_query_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GstGLQuery</span> *
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-new" title="gst_gl_query_new ()">gst_gl_query_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-result" title="gst_gl_query_result ()">gst_gl_query_result</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-start" title="gst_gl_query_start ()">gst_gl_query_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-start-log" title="gst_gl_query_start_log()">gst_gl_query_start_log</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-start-log-valist" title="gst_gl_query_start_log_valist()">gst_gl_query_start_log_valist</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-unset" title="gst_gl_query_unset ()">gst_gl_query_unset</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLQuery.description"></a><h2>Description</h2>
<p>A <span class="type">GstGLQuery</span> represents and holds an OpenGL query object. Various types of
queries can be run or counters retrieved.</p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLQuery.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-gl-query-counter"></a><h3>gst_gl_query_counter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_gl_query_counter (<em class="parameter"><code><span class="type">GstGLQuery</span> *query</code></em>);</pre>
<p>Record the result of a counter</p>
<div class="refsect3">
<a name="gst-gl-query-counter.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>query</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLQuery</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-counter-log"></a><h3>gst_gl_query_counter_log()</h3>
<pre class="programlisting">#define gst_gl_query_counter_log(query,cat,level,object,format,...)</pre>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-counter-log-valist"></a><h3>gst_gl_query_counter_log_valist()</h3>
<pre class="programlisting">#define gst_gl_query_counter_log_valist(query,cat,level,object,format,varargs)</pre>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-end"></a><h3>gst_gl_query_end ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_gl_query_end (<em class="parameter"><code><span class="type">GstGLQuery</span> *query</code></em>);</pre>
<p>End counting the query</p>
<div class="refsect3">
<a name="gst-gl-query-end.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>query</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLQuery</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-free"></a><h3>gst_gl_query_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_gl_query_free (<em class="parameter"><code><span class="type">GstGLQuery</span> *query</code></em>);</pre>
<p>Frees a <span class="type">GstGLQuery</span></p>
<div class="refsect3">
<a name="gst-gl-query-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>query</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLQuery</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-init"></a><h3>gst_gl_query_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_gl_query_init (<em class="parameter"><code><span class="type">GstGLQuery</span> *query</code></em>,
<em class="parameter"><code><a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a> *context</code></em>,
<em class="parameter"><code><span class="type">GstGLQueryType</span> query_type</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-query-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>query</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLQuery</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>query_type</p></td>
<td class="parameter_description"><p>the <span class="type">GstGLQueryType</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-new"></a><h3>gst_gl_query_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GstGLQuery</span> *
gst_gl_query_new (<em class="parameter"><code><a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a> *context</code></em>,
<em class="parameter"><code><span class="type">GstGLQueryType</span> query_type</code></em>);</pre>
<p>Free with <a class="link" href="gst-plugins-bad-libs-GstGLQuery.html#gst-gl-query-free" title="gst_gl_query_free ()"><code class="function">gst_gl_query_free()</code></a></p>
<div class="refsect3">
<a name="gst-gl-query-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a <a class="link" href="GstGLContext.html" title="GstGLContext"><span class="type">GstGLContext</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>query_type</p></td>
<td class="parameter_description"><p>the <span class="type">GstGLQueryType</span> to create</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-query-new.returns"></a><h4>Returns</h4>
<p> a new <span class="type">GstGLQuery</span></p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-result"></a><h3>gst_gl_query_result ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a>
gst_gl_query_result (<em class="parameter"><code><span class="type">GstGLQuery</span> *query</code></em>);</pre>
<div class="refsect3">
<a name="gst-gl-query-result.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>query</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLQuery</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-gl-query-result.returns"></a><h4>Returns</h4>
<p> the result of the query</p>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-start"></a><h3>gst_gl_query_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_gl_query_start (<em class="parameter"><code><span class="type">GstGLQuery</span> *query</code></em>);</pre>
<p>Start counting the query</p>
<div class="refsect3">
<a name="gst-gl-query-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>query</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLQuery</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-start-log"></a><h3>gst_gl_query_start_log()</h3>
<pre class="programlisting">#define gst_gl_query_start_log(query,cat,level,object,format,...)</pre>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-start-log-valist"></a><h3>gst_gl_query_start_log_valist()</h3>
<pre class="programlisting">#define gst_gl_query_start_log_valist(query,cat,level,object,format,varargs)</pre>
</div>
<hr>
<div class="refsect2">
<a name="gst-gl-query-unset"></a><h3>gst_gl_query_unset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gst_gl_query_unset (<em class="parameter"><code><span class="type">GstGLQuery</span> *query</code></em>);</pre>
<p>Free any dynamically allocated resources</p>
<div class="refsect3">
<a name="gst-gl-query-unset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>query</p></td>
<td class="parameter_description"><p>a <span class="type">GstGLQuery</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-libs-GstGLQuery.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>