upstream-doc/man2/xhtml/glGenQueries.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" /><title>glGenQueries</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glGenQueries"><a id="glGenQueries"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGenQueries — generate query object names</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">glGenQueries</b>(</code></td><td>GLsizei <var class="pdparam">n</var>, </td></tr><tr><td> </td><td>GLuint * <var class="pdparam">ids</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>n</code></em></span></dt><dd><p>
   5                     Specifies the number of query object names to be generated.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>ids</code></em></span></dt><dd><p>
   7                     Specifies an array in which the generated query object names are stored.
   8                 </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
   9             <code class="function">glGenQueries</code> returns <em class="parameter"><code>n</code></em> query object names in <em class="parameter"><code>ids</code></em>.
  10             There is no guarantee that the names form a contiguous set of integers;
  11             however, it is guaranteed that none of the returned names was in use
  12             immediately before the call to <code class="function">glGenQueries</code>.
  13         </p><p>
  14             Query object names returned by a call to <code class="function">glGenQueries</code> are not returned by
  15             subsequent calls, unless they are first deleted with
  16             <a class="citerefentry" href="glDeleteQueries.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteQueries</span></span></a>.
  17         </p><p>
  18             No query objects are associated with the returned query object names until they are first used by calling
  19             <a class="citerefentry" href="glBeginQuery.xml"><span class="citerefentry"><span class="refentrytitle">glBeginQuery</span></span></a>.
  20         </p></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p>
  21             <code class="function">glGenQueries</code> is available only if the GL version is 1.5 or greater.
  22         </p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p>
  23             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>n</code></em> is negative.
  24         </p><p>
  25             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glGenQueries</code> is executed
  26             between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding
  27             execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  28         </p></div><div class="refsect1" title="Associated Gets"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  29             <a class="citerefentry" href="glIsQuery.xml"><span class="citerefentry"><span class="refentrytitle">glIsQuery</span></span></a>
  30         </p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
  31             <a class="citerefentry" href="glBeginQuery.xml"><span class="citerefentry"><span class="refentrytitle">glBeginQuery</span></span></a>,
  32             <a class="citerefentry" href="glDeleteQueries.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteQueries</span></span></a>,
  33             <a class="citerefentry" href="glEndQuery.xml"><span class="citerefentry"><span class="refentrytitle">glEndQuery</span></span></a>
  34         </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p>
  35             Copyright <span class="trademark"></span>© 2005 Addison-Wesley.
  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 class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  39         </p></div></div></body></html>