rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glQueryCounter.xml
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>glQueryCounter - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glQueryCounter"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glQueryCounter — record the GL time into a query object after all previous commands have reached the GL server but have not yet necessarily executed.</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glQueryCounter</b>(</code></td><td>GLuint  </td><td><var class="pdparam">id</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">target</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><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 Specify the name of a query object into which to record the GL time.
6 </p></dd><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p>
7 Specify the counter to query. <em class="parameter"><code>target</code></em> must be <code class="constant">GL_TIMESTAMP</code>.
8 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
9 <code class="function">glQueryCounter</code> causes the GL to record the current time into the query object named <em class="parameter"><code>id</code></em>.
10 <em class="parameter"><code>target</code></em> must be <code class="constant">GL_TIMESTAMP</code>. The time is recorded after all previous commands on the
11 GL client and server state and the framebuffer have been fully realized. When the time is recorded, the query result for that object
12 is marked available. <code class="function">glQueryCounter</code> timer queries can be used within a <a href="glBeginQuery.xml"><span class="citerefentry"><span class="refentrytitle">glBeginQuery</span></span></a> /
13 <a href="glEndQuery.xml"><span class="citerefentry"><span class="refentrytitle">glEndQuery</span></span></a> block where the target is <code class="constant">GL_TIME_ELAPSED</code> and it does
14 not affect the result of that query object.
15 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
16 <code class="function">glQueryCounter</code> is available only if the GL version is 3.3 or higher.
17 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
18 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>id</code></em> is the name
19 of a query object that is already in use within a <a href="glBeginQuery.xml"><span class="citerefentry"><span class="refentrytitle">glBeginQuery</span></span></a> /
20 <a href="glEndQuery.xml"><span class="citerefentry"><span class="refentrytitle">glEndQuery</span></span></a> block.
21 </p><p>
22 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>id</code></em> is not the name of a query object returned
23 from a previous call to <a href="glGenQueries.xml"><span class="citerefentry"><span class="refentrytitle">glGenQueries</span></span></a>.
24 </p><p>
25 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not <code class="constant">GL_TIMESTAMP</code>.
26 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
27 <a href="glGenQueries.xml"><span class="citerefentry"><span class="refentrytitle">glGenQueries</span></span></a>,
28 <a href="glBeginQuery.xml"><span class="citerefentry"><span class="refentrytitle">glBeginQuery</span></span></a>,
29 <a href="glEndQuery.xml"><span class="citerefentry"><span class="refentrytitle">glEndQuery</span></span></a>,
30 <a href="glDeleteQueries.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteQueries</span></span></a>,
31 <a href="glGetQueryObject.xml"><span class="citerefentry"><span class="refentrytitle">glGetQueryObject</span></span></a>,
32 <a href="glGetQueryiv.xml"><span class="citerefentry"><span class="refentrytitle">glGetQueryiv</span></span></a>,
33 <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a>
34 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
35 Copyright <span class="trademark"></span>© 2010 Khronos Group.
36 This material may be distributed subject to the terms and conditions set forth in
37 the Open Publication License, v 1.0, 8 June 1999.
38 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
39 </p></div></div></body></html>