HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
| 3 | <!-- saved from url=(0013)about:internet --> | |
| 4 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glGetQueryObject</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glGetQueryObject"><a id="glGetQueryObject"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetQueryObject — return parameters of a query object</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glGetQueryObjectiv</b>(</code></td><td>GLuint <var class="pdparam">id</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint * <var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glGetQueryObjectuiv</b>(</code></td><td>GLuint <var class="pdparam">id</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLuint * <var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glGetQueryObjecti64v</b>(</code></td><td>GLuint <var class="pdparam">id</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint64 * <var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glGetQueryObjectui64v</b>(</code></td><td>GLuint <var class="pdparam">id</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLuint64 * <var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>id</code></em></span></dt><dd><p> | |
| 5 | Specifies the name of a query object. | |
| 6 | </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p> | |
| 7 | Specifies the symbolic name of a query object parameter. | |
| 8 | Accepted values are <code class="constant">GL_QUERY_RESULT</code> or <code class="constant">GL_QUERY_RESULT_AVAILABLE</code>. | |
| 9 | </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p> | |
| 10 | Returns the requested data. | |
| 11 | </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p> | |
| 12 | <code class="function">glGetQueryObject</code> returns in <em class="parameter"><code>params</code></em> a selected parameter of the query object | |
| 13 | specified by <em class="parameter"><code>id</code></em>. | |
| 14 | </p><p> | |
| 15 | <em class="parameter"><code>pname</code></em> names a specific query object parameter. <em class="parameter"><code>pname</code></em> can be as follows: | |
| 16 | </p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GL_QUERY_RESULT</code></span></dt><dd><p> | |
| 17 | <em class="parameter"><code>params</code></em> returns the value of the query object's passed samples counter. | |
| 18 | The initial value is 0. | |
| 19 | </p></dd><dt><span class="term"><code class="constant">GL_QUERY_RESULT_AVAILABLE</code></span></dt><dd><p> | |
| 20 | <em class="parameter"><code>params</code></em> returns whether the passed samples counter is immediately available. | |
| 21 | If a delay would occur waiting for the query result, <code class="constant">GL_FALSE</code> is returned. | |
| 22 | Otherwise, <code class="constant">GL_TRUE</code> is returned, which also indicates that the results of all | |
| 23 | previous queries are available as well. | |
| 24 | </p></dd></dl></div></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p> | |
| 25 | If an error is generated, | |
| 26 | no change is made to the contents of <em class="parameter"><code>params</code></em>. | |
| 27 | </p><p> | |
| 28 | <code class="function">glGetQueryObject</code> implicitly flushes the GL pipeline so that any incomplete rendering | |
| 29 | delimited by the occlusion query completes in finite time. | |
| 30 | </p><p> | |
| 31 | If multiple queries are issued using the same query object <em class="parameter"><code>id</code></em> before calling | |
| 32 | <code class="function">glGetQueryObject</code>, the results of the most recent query will be returned. In this case, | |
| 33 | when issuing a new query, the results of the previous query are discarded. | |
| 34 | </p><p> | |
| 35 | <code class="function">glGetQueryObjecti64v</code> and <code class="function">glGetQueryObjectui64v</code> are available only | |
| 36 | if the GL version is 3.3 or greater. | |
| 37 | </p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p> | |
| 38 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not an accepted value. | |
| 39 | </p><p> | |
| 40 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>id</code></em> is not the name of a query object. | |
| 41 | </p><p> | |
| 42 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>id</code></em> is the name of a currently active | |
| 43 | query object. | |
| 44 | </p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p> | |
| 45 | <a class="citerefentry" href="glBeginQuery.xml"><span class="citerefentry"><span class="refentrytitle">glBeginQuery</span></span></a>, | |
| 46 | <a class="citerefentry" href="glEndQuery.xml"><span class="citerefentry"><span class="refentrytitle">glEndQuery</span></span></a>, | |
| 47 | <a class="citerefentry" href="glGetQueryiv.xml"><span class="citerefentry"><span class="refentrytitle">glGetQueryiv</span></span></a>, | |
| 48 | <a class="citerefentry" href="glIsQuery.xml"><span class="citerefentry"><span class="refentrytitle">glIsQuery</span></span></a>, | |
| 49 | <a class="citerefentry" href="glQueryCounter.xml"><span class="citerefentry"><span class="refentrytitle">glQueryCounter</span></span></a> | |
| 50 | </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 51 | Copyright <span class="trademark"></span>© 2005 Addison-Wesley. | |
| 52 | This material may be distributed subject to the terms and conditions set forth in | |
| 53 | the Open Publication License, v 1.0, 8 June 1999. | |
| 54 | <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 55 | </p></div></div></body></html> |