Opentk/Source/Bind/Specifications/Docs/glIsQuery.xml
2009-03-08 00:46:58 +00:00

78 lines
3.6 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glIsQuery">
<refmeta>
<refmetainfo>
<copyright>
<year>2005</year>
<holder>Sams Publishing</holder>
</copyright>
</refmetainfo>
<refentrytitle>glIsQuery</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glIsQuery</refname>
<refpurpose>determine if a name corresponds to a query object</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLboolean <function>glIsQuery</function></funcdef>
<paramdef>GLuint <parameter>id</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>id</parameter></term>
<listitem>
<para>
Specifies a value that may be the name of a query object.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glIsQuery</function> returns <constant>GL_TRUE</constant> if <parameter>id</parameter> is currently the name of a query object.
If <parameter>id</parameter> is zero, or is a non-zero value that is not currently the
name of a query object, or if an error occurs, <function>glIsQuery</function> returns <constant>GL_FALSE</constant>.
</para>
<para>
A name returned by <citerefentry><refentrytitle>glGenQueries</refentrytitle></citerefentry>, but not yet associated with a query object
by calling <citerefentry><refentrytitle>glBeginQuery</refentrytitle></citerefentry>, is not the name of a query object.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
<function>glIsQuery</function> is available only if the GL version is 1.5 or greater.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if <function>glIsQuery</function> is executed
between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glBeginQuery</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteQueries</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glEndQuery</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGenQueries</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
</para>
</refsect1>
</refentry>