upstream-man-pages/man3/glGetQueryiv.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="glGetQueryiv">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2005</year>
   9                 <holder>Sams Publishing</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGetQueryiv</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGetQueryiv</refname>
  17         <refpurpose>return parameters of a query object target</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glGetQueryiv</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLenum <parameter>pname</parameter></paramdef>
  25                 <paramdef>GLint * <parameter>params</parameter></paramdef>
  26             </funcprototype>
  27         </funcsynopsis>
  28     </refsynopsisdiv>
  29     <refsect1 id="parameters"><title>Parameters</title>
  30         <variablelist>
  31         <varlistentry>
  32             <term><parameter>target</parameter></term>
  33             <listitem>
  34                 <para>
  35                     Specifies a query object target.
  36                     Must be <constant>GL_SAMPLES_PASSED</constant>, <constant>GL_ANY_SAMPLES_PASSED</constant>,
  37                     <constant>GL_PRIMITIVES_GENERATED</constant>, <constant>GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN</constant>,
  38                     <constant>GL_TIME_ELAPSED</constant>, or <constant>GL_TIMESTAMP</constant>.
  39                 </para>
  40             </listitem>
  41         </varlistentry>
  42         <varlistentry>
  43             <term><parameter>pname</parameter></term>
  44             <listitem>
  45                 <para>
  46                     Specifies the symbolic name of a query object target parameter.
  47                     Accepted values are <constant>GL_CURRENT_QUERY</constant> or <constant>GL_QUERY_COUNTER_BITS</constant>.
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         <varlistentry>
  52             <term><parameter>params</parameter></term>
  53             <listitem>
  54                 <para>
  55                     Returns the requested data.
  56                 </para>
  57             </listitem>
  58         </varlistentry>
  59         </variablelist>
  60     </refsect1>
  61     <refsect1 id="description"><title>Description</title>
  62         <para>
  63             <function>glGetQueryiv</function> returns in <parameter>params</parameter> a selected parameter of the query object target
  64             specified by <parameter>target</parameter>.
  65         </para>
  66         <para>
  67             <parameter>pname</parameter> names a specific query object target parameter.  When <parameter>pname</parameter> is
  68             <constant>GL_CURRENT_QUERY</constant>, the name of the currently active query for <parameter>target</parameter>,
  69             or zero if no query is active, will be placed in <parameter>params</parameter>.
  70             If <parameter>pname</parameter> is <constant>GL_QUERY_COUNTER_BITS</constant>, the implementation-dependent number
  71             of bits used to hold the result of queries for <parameter>target</parameter> is returned in <parameter>params</parameter>.
  72         </para>
  73     </refsect1>
  74     <refsect1 id="notes"><title>Notes</title>
  75         <para>
  76             If an error is generated,
  77             no change is made to the contents of <parameter>params</parameter>.
  78         </para>
  79     </refsect1>
  80     <refsect1 id="errors"><title>Errors</title>
  81         <para>
  82             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> or <parameter>pname</parameter> is not an
  83             accepted value.
  84         </para>
  85     </refsect1>
  86     <refsect1 id="seealso"><title>See Also</title>
  87         <para>
  88             <citerefentry><refentrytitle>glGetQueryObject</refentrytitle></citerefentry>,
  89             <citerefentry><refentrytitle>glIsQuery</refentrytitle></citerefentry>
  90         </para>
  91     </refsect1>
  92     <refsect1 id="Copyright"><title>Copyright</title>
  93         <para>
  94             Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley.
  95             This material may be distributed subject to the terms and conditions set forth in
  96             the Open Publication License, v 1.0, 8 June 1999.
  97             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  98         </para>
  99     </refsect1>
 100 </refentry>