/
glGetActiveAtomicCounterBufferiv.xhtml
276 lines (275 loc) · 14.7 KB
/
glGetActiveAtomicCounterBufferiv.xhtml
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
<div class="refentry" id="glGetActiveAtomicCounterBufferiv">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glGetActiveAtomicCounterBufferiv — retrieve information about the set of active atomic counter buffers for a program</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glGetActiveAtomicCounterBufferiv</strong>(</code>
</td>
<td>Gluint <var class="pdparam">program</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">bufferIndex</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">pname</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint *<var class="pdparam">params</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>program</code>
</em>
</span>
</dt>
<dd>
<p>
The name of a program object from which to retrieve information.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>bufferIndex</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies index of an active atomic counter buffer.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>pname</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies which parameter of the atomic counter buffer to retrieve.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>params</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the address of a variable into which to write the retrieved information.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glGetActiveAtomicCounterBufferiv</code> retrieves information about the set of active
atomic counter buffers for a program object. <em class="parameter"><code>program</code></em> is the name of a program
object for which the command <a class="citerefentry" href="glLinkProgram"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>
has been issued in the past. It is not necessary for <em class="parameter"><code>program</code></em> to have been linked
successfully. The link may have failed because the number of active atomic counters exceeded the limits.
</p>
<p>
<em class="parameter"><code>bufferIndex</code></em> specifies the index of an active atomic counter buffer and must be in
the range zero to the value of <code class="constant">GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</code> minus one. The value
of <code class="constant">GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</code> for <em class="parameter"><code>program</code></em> indicates the
number of active atomic counter buffer and can be queried with
<a class="citerefentry" href="glGetProgram"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>.
</p>
<p>
If no error occurs, the parameter(s) specified by <em class="parameter"><code>pname</code></em> are returned in <em class="parameter"><code>params</code></em>.
If an error is generated, the contents of <em class="parameter"><code>params</code></em> are not modified.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_BINDING</code>, then the index of the
counter buffer binding point associated with the active atomic counter buffer <em class="parameter"><code>bufferIndex</code></em>
for <em class="parameter"><code>program</code></em> is returned.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_DATA_SIZE</code>, then the implementation-dependent
minimum total buffer object size, in baseic machine units, required to hold all active atomic counters in the
atomic counter binding point identified by <em class="parameter"><code>bufferIndex</code></em> is returned.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_ACTIVE_ATOMIC_COUNTERS</code>, then the number of active
atomic counters for the atomic counter buffer identified by <em class="parameter"><code>bufferIndex</code></em> is returned.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_ACTIVE_ATOMIC_COUNTER_INDICES</code>,
then a list of the active atomic counter indices for the atomic counter buffer identified by <em class="parameter"><code>bufferIndex</code></em>
is returned. The number of elements that will be written into <em class="parameter"><code>params</code></em> is the value of
<code class="constant">GL_ATOMIC_COUNTER_BUFFER_ACTIVE_ATOMIC_COUNTERS</code> for <em class="parameter"><code>bufferIndex</code></em>.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_VERTEX_SHADER</code>,
<code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_TESS_CONTROL_SHADER</code>,
<code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_TESS_EVALUATION_SHADER</code>,
<code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_GEOMETRY_SHADER</code>,
<code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_FRAGMENT_SHADER</code>,
<code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_COMPUTE_SHADER</code> then a boolean value indicating
whether the atomic counter buffer identified by <em class="parameter"><code>bufferIndex</code></em> is referenced by the vertex,
tessellation control, tessellation evaluation, geometry, fragment or compute processing stages of <em class="parameter"><code>program</code></em>,
respectively, is returned.
</p>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
<code class="function">glGetActiveAtomicCounterBufferiv</code> is available only if the
GL version is 4.2 or higher.
</p>
<p>
<code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_COMPUTE_SHADER</code> is available
only of the GL version is 4.3 or higher.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>program</code></em> is not the name of a program
object for which <a class="citerefentry" href="glLinkProgram"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a> has been called in the past.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>bufferIndex</code></em> is greater than or equal to
the value of <code class="constant">GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</code> for <em class="parameter"><code>program</code></em>.
</p>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not one of the accepted tokens.
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glGetActiveAtomicCounterBufferiv</code>
</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glGetProgram"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
<a class="citerefentry" href="glGetActiveSubroutineUniform"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniform</span></span></a>,
<a class="citerefentry" href="glGetActiveSubroutineUniformName"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniformName</span></span></a>,
<a class="citerefentry" href="glGetUniformLocation"><span class="citerefentry"><span class="refentrytitle">glGetUniformLocation</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2011-2014 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.
<a class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p>
</div>
</div>