Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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="glIsQuery"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>2005</year> | |
9 | <holder>Sams Publishing</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glIsQuery</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glIsQuery</refname> | |
17 | <refpurpose>determine if a name corresponds to a query object</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>GLboolean <function>glIsQuery</function></funcdef> | |
23 | <paramdef>GLuint <parameter>id</parameter></paramdef> | |
24 | </funcprototype> | |
25 | </funcsynopsis> | |
26 | </refsynopsisdiv> | |
27 | <refsect1 id="parameters"><title>Parameters</title> | |
28 | <variablelist> | |
29 | <varlistentry> | |
30 | <term><parameter>id</parameter></term> | |
31 | <listitem> | |
32 | <para> | |
33 | Specifies a value that may be the name of a query object. | |
34 | </para> | |
35 | </listitem> | |
36 | </varlistentry> | |
37 | </variablelist> | |
38 | </refsect1> | |
39 | <refsect1 id="description"><title>Description</title> | |
40 | <para> | |
41 | <function>glIsQuery</function> returns <constant>GL_TRUE</constant> if <parameter>id</parameter> is currently the name of a query object. | |
42 | If <parameter>id</parameter> is zero, or is a non-zero value that is not currently the | |
43 | name of a query object, or if an error occurs, <function>glIsQuery</function> returns <constant>GL_FALSE</constant>. | |
44 | </para> | |
45 | <para> | |
46 | A name returned by <citerefentry><refentrytitle>glGenQueries</refentrytitle></citerefentry>, but not yet associated with a query object | |
47 | by calling <citerefentry><refentrytitle>glBeginQuery</refentrytitle></citerefentry>, is not the name of a query object. | |
48 | </para> | |
49 | </refsect1> | |
50 | <refsect1 id="notes"><title>Notes</title> | |
51 | <para> | |
52 | <function>glIsQuery</function> is available only if the GL version is 1.5 or greater. | |
53 | </para> | |
54 | </refsect1> | |
55 | <refsect1 id="errors"><title>Errors</title> | |
56 | <para> | |
57 | <constant>GL_INVALID_OPERATION</constant> is generated if <function>glIsQuery</function> is executed | |
58 | between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding | |
59 | execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>. | |
60 | </para> | |
61 | </refsect1> | |
62 | <refsect1 id="seealso"><title>See Also</title> | |
63 | <para> | |
64 | <citerefentry><refentrytitle>glBeginQuery</refentrytitle></citerefentry>, | |
65 | <citerefentry><refentrytitle>glDeleteQueries</refentrytitle></citerefentry>, | |
66 | <citerefentry><refentrytitle>glEndQuery</refentrytitle></citerefentry>, | |
67 | <citerefentry><refentrytitle>glGenQueries</refentrytitle></citerefentry> | |
68 | </para> | |
69 | </refsect1> | |
70 | <refsect1 id="Copyright"><title>Copyright</title> | |
71 | <para> | |
72 | Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley. | |
73 | This material may be distributed subject to the terms and conditions set forth in | |
74 | the Open Publication License, v 1.0, 8 June 1999. | |
75 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>. | |
76 | </para> | |
77 | </refsect1> | |
78 | </refentry> |