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=
"glGetQueryIndexed">
9 <holder>Khronos Group.
</holder>
12 <refentrytitle>glGetQueryIndexediv
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glGetQueryIndexediv
</refname>
17 <refpurpose>return parameters of an indexed query object target
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glGetQueryIndexediv
</function></funcdef>
23 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
24 <paramdef>GLuint
<parameter>index
</parameter></paramdef>
25 <paramdef>GLenum
<parameter>pname
</parameter></paramdef>
26 <paramdef>GLint *
<parameter>params
</parameter></paramdef>
30 <refsect1 id=
"parameters"><title>Parameters
</title>
33 <term><parameter>target
</parameter></term>
36 Specifies a query object target.
37 Must be
<constant>GL_SAMPLES_PASSED
</constant>,
<constant>GL_ANY_SAMPLES_PASSED
</constant>,
<constant>GL_ANY_SAMPLES_PASSED_CONSERVATIVE
</constant>
38 <constant>GL_PRIMITIVES_GENERATED
</constant>,
<constant>GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
</constant>,
39 <constant>GL_TIME_ELAPSED
</constant>, or
<constant>GL_TIMESTAMP
</constant>.
44 <term><parameter>index
</parameter></term>
47 Specifies the index of the query object target.
52 <term><parameter>pname
</parameter></term>
55 Specifies the symbolic name of a query object target parameter.
56 Accepted values are
<constant>GL_CURRENT_QUERY
</constant> or
<constant>GL_QUERY_COUNTER_BITS
</constant>.
61 <term><parameter>params
</parameter></term>
64 Returns the requested data.
70 <refsect1 id=
"description"><title>Description
</title>
72 <function>glGetQueryIndexediv
</function> returns in
<parameter>params
</parameter> a selected parameter of the indexed query object target
73 specified by
<parameter>target
</parameter> and
<parameter>index
</parameter>.
<parameter>index
</parameter> specifies the index of the
74 query object target and must be between zero and a target-specific maxiumum.
77 <parameter>pname
</parameter> names a specific query object target parameter. When
<parameter>pname
</parameter> is
78 <constant>GL_CURRENT_QUERY
</constant>, the name of the currently active query for the specified
<parameter>index
</parameter> of
<parameter>target
</parameter>,
79 or zero if no query is active, will be placed in
<parameter>params
</parameter>.
80 If
<parameter>pname
</parameter> is
<constant>GL_QUERY_COUNTER_BITS
</constant>, the implementation-dependent number
81 of bits used to hold the result of queries for
<parameter>target
</parameter> is returned in
<parameter>params
</parameter>.
84 <refsect1 id=
"notes"><title>Notes
</title>
86 The target
<constant>GL_ANY_SAMPLES_PASSED_CONSERVATIVE
</constant> is available only if the GL version is
4.3 or greater.
89 If an error is generated,
90 no change is made to the contents of
<parameter>params
</parameter>.
93 Calling
<citerefentry><refentrytitle>glGetQueryiv
</refentrytitle></citerefentry> is equivalent to calling
94 <function>glGetQueryIndexediv
</function> with
<parameter>index
</parameter> set to zero.
97 <refsect1 id=
"errors"><title>Errors
</title>
99 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> or
<parameter>pname
</parameter> is not an
103 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>index
</parameter> is greater than or equal to the
104 <parameter>target
</parameter>-specific maximum.
107 <refsect1 id=
"seealso"><title>See Also
</title>
109 <citerefentry><refentrytitle>glGetQueryObject
</refentrytitle></citerefentry>,
110 <citerefentry><refentrytitle>glIsQuery
</refentrytitle></citerefentry>
113 <refsect1 id=
"Copyright"><title>Copyright
</title>
115 Copyright
<trademark class=
"copyright"></trademark> 2010 Khronos Group.
116 This material may be distributed subject to the terms and conditions set forth in
117 the Open Publication License, v
1.0,
8 June
1999.
118 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.