1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
<?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="glGetQueryIndexed">
<refentryinfo>
<copyright>
<year>2010-2013</year>
<holder>Khronos Group.</holder>
</copyright>
</refentryinfo>
<refmeta>
<refentrytitle>glGetQueryIndexediv</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glGetQueryIndexediv</refname>
<refpurpose>return parameters of an indexed query object target</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glGetQueryIndexediv</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLuint <parameter>index</parameter></paramdef>
<paramdef>GLenum <parameter>pname</parameter></paramdef>
<paramdef>GLint * <parameter>params</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
Specifies a query object target.
Must be <constant>GL_SAMPLES_PASSED</constant>, <constant>GL_ANY_SAMPLES_PASSED</constant>, <constant>GL_ANY_SAMPLES_PASSED_CONSERVATIVE</constant>
<constant>GL_PRIMITIVES_GENERATED</constant>, <constant>GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN</constant>,
<constant>GL_TIME_ELAPSED</constant>, or <constant>GL_TIMESTAMP</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
Specifies the index of the query object target.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pname</parameter></term>
<listitem>
<para>
Specifies the symbolic name of a query object target parameter.
Accepted values are <constant>GL_CURRENT_QUERY</constant> or <constant>GL_QUERY_COUNTER_BITS</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>params</parameter></term>
<listitem>
<para>
Returns the requested data.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glGetQueryIndexediv</function> returns in <parameter>params</parameter> a selected parameter of the indexed query object target
specified by <parameter>target</parameter> and <parameter>index</parameter>. <parameter>index</parameter> specifies the index of the
query object target and must be between zero and a target-specific maxiumum.
</para>
<para>
<parameter>pname</parameter> names a specific query object target parameter. When <parameter>pname</parameter> is
<constant>GL_CURRENT_QUERY</constant>, the name of the currently active query for the specified <parameter>index</parameter> of <parameter>target</parameter>,
or zero if no query is active, will be placed in <parameter>params</parameter>.
If <parameter>pname</parameter> is <constant>GL_QUERY_COUNTER_BITS</constant>, the implementation-dependent number
of bits used to hold the result of queries for <parameter>target</parameter> is returned in <parameter>params</parameter>.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
The target <constant>GL_ANY_SAMPLES_PASSED_CONSERVATIVE</constant> is available only if the GL version is 4.3 or greater.
</para>
<para>
If an error is generated,
no change is made to the contents of <parameter>params</parameter>.
</para>
<para>
Calling <citerefentry><refentrytitle>glGetQueryiv</refentrytitle></citerefentry> is equivalent to calling
<function>glGetQueryIndexediv</function> with <parameter>index</parameter> set to zero.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> or <parameter>pname</parameter> is not an
accepted value.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>index</parameter> is greater than or equal to the
<parameter>target</parameter>-specific maximum.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glGetQueryObject</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glIsQuery</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2010-2013 Khronos Group.
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>
|
