upstream-doc/man4/glDeleteQueries.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glDeleteQueries">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2005</year>
   9                 <holder>Sams Publishing</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glDeleteQueries</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glDeleteQueries</refname>
  17         <refpurpose>delete named query objects</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glDeleteQueries</function></funcdef>
  23                 <paramdef>GLsizei <parameter>n</parameter></paramdef>
  24                 <paramdef>const GLuint * <parameter>ids</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>n</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies the number of query objects to be deleted.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>ids</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specifies an array of query objects to be deleted.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>glDeleteQueries</function> deletes <parameter>n</parameter> query objects named by the elements of the array <parameter>ids</parameter>.
  51             After a query object is deleted, it has no contents,
  52             and its name is free for reuse (for example by <citerefentry><refentrytitle>glGenQueries</refentrytitle></citerefentry>).
  53         </para>
  54         <para>
  55             <function>glDeleteQueries</function> silently ignores 0's and names that do not correspond to
  56             existing query objects.
  57         </para>
  58     </refsect1>
  59     <refsect1 id="errors"><title>Errors</title>
  60         <para>
  61             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
  62         </para>
  63     </refsect1>
  64     <refsect1 id="associatedgets"><title>Associated Gets</title>
  65         <para>
  66             <citerefentry><refentrytitle>glIsQuery</refentrytitle></citerefentry>
  67         </para>
  68     </refsect1>
  69     <refsect1 id="seealso"><title>See Also</title>
  70         <para>
  71             <citerefentry><refentrytitle>glBeginQuery</refentrytitle></citerefentry>,
  72             <citerefentry><refentrytitle>glEndQuery</refentrytitle></citerefentry>,
  73             <citerefentry><refentrytitle>glGenQueries</refentrytitle></citerefentry>,
  74             <citerefentry><refentrytitle>glGetQueryiv</refentrytitle></citerefentry>,
  75             <citerefentry><refentrytitle>glGetQueryObject</refentrytitle></citerefentry>
  76         </para>
  77     </refsect1>
  78     <refsect1 id="Copyright"><title>Copyright</title>
  79         <para>
  80             Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley.
  81             This material may be distributed subject to the terms and conditions set forth in
  82             the Open Publication License, v 1.0, 8 June 1999.
  83             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  84         </para>
  85     </refsect1>
  86 </refentry>