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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>glGetProgramInterface - OpenGL 4 Reference Pages</title>
<link rel="stylesheet" type="text/css" href="opengl-man.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
MathML: {
extensions: ["content-mathml.js"]
},
tex2jax: {
inlineMath: [['$','$'], ['\\(','\\)']]
}
});
</script>
<script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
</head>
<body>
<header/>
<div class="refentry" id="glGetProgramInterface">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>glGetProgramInterface — query a property of an interface in 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">glGetProgramInterfaceiv</strong>(</code>
</td>
<td>GLuint <var class="pdparam">program</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">programInterface</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 whose interface to query.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>programInterface</code>
</em>
</span>
</dt>
<dd>
<p>
A token identifying the interface within <em class="parameter"><code>program</code></em> to query.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>pname</code>
</em>
</span>
</dt>
<dd>
<p>
The name of the parameter within <em class="parameter"><code>programInterface</code></em> to query.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>params</code>
</em>
</span>
</dt>
<dd>
<p>
The address of a variable to retrieve the value of <em class="parameter"><code>pname</code></em> for the program interface.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glGetProgramInterfaceiv</code> queries the property of the interface identifed
by <em class="parameter"><code>programInterface</code></em> in <em class="parameter"><code>program</code></em>, the property name of
which is given by <em class="parameter"><code>pname</code></em>.
</p>
<p>
<em class="parameter"><code>program</code></em> must be the name of an existing program object. <em class="parameter"><code>programInterface</code></em>
is the name of the interface within <em class="parameter"><code>program</code></em> to query and must be one of the following
values:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="constant">GL_UNIFORM</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active uniforms within <em class="parameter"><code>program</code></em>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_UNIFORM_BLOCK</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active uniform blocks within <em class="parameter"><code>program</code></em>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active atomic counter buffer binding points within <em class="parameter"><code>program</code></em>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_PROGRAM_INPUT</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active input variables used by the first shader stage of <em class="parameter"><code>program</code></em>.
If <em class="parameter"><code>program</code></em> contains multiple shader stages then input variables from any stage other than the first
will not be enumerated.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_PROGRAM_OUTPUT</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active output variables produced by the last shader stage of <em class="parameter"><code>program</code></em>.
If <em class="parameter"><code>program</code></em> contains multiple shader stages then output variables from any stage other than the last
will not be enumerated.
</p>
</dd>
<dt>
<span class="term"><code class="constant">GL_VERTEX_SUBROUTINE</code>, </span>
<span class="term"><code class="constant">GL_TESS_CONTROL_SUBROUTINE</code>, </span>
<span class="term"><code class="constant">GL_TESS_EVALUATION_SUBROUTINE</code>, </span>
<span class="term"><code class="constant">GL_GEOMETRY_SUBROUTINE</code>, </span>
<span class="term"><code class="constant">GL_FRAGMENT_SUBROUTINE</code>, </span>
<span class="term">
<code class="constant">GL_COMPUTE_SUBROUTINE</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active subroutines for the vertex, tessellation control, tessellation evaluation,
geometry, fragment and compute shader stages of <em class="parameter"><code>program</code></em>, respectively.
</p>
</dd>
<dt>
<span class="term"><code class="constant">GL_VERTEX_SUBROUTINE_UNIFORM</code>, </span>
<span class="term"><code class="constant">GL_TESS_CONTROL_SUBROUTINE_UNIFORM</code>, </span>
<span class="term"><code class="constant">GL_TESS_EVALUATION_SUBROUTINE_UNIFORM</code>, </span>
<span class="term"><code class="constant">GL_GEOMETRY_SUBROUTINE_UNIFORM</code>, </span>
<span class="term"><code class="constant">GL_FRAGMENT_SUBROUTINE_UNIFORM</code>, </span>
<span class="term">
<code class="constant">GL_COMPUTE_SUBROUTINE_UNIFORM</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active subroutine uniform variables used by the vertex, tessellation control, tessellation evaluation,
geometry, fragment and compute shader stages of <em class="parameter"><code>program</code></em>, respectively.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_TRANSFORM_FEEDBACK_VARYING</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of output variables from the last non-fragment stage of <em class="parameter"><code>program</code></em> that would be
captured if transform feedback were active.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_BUFFER_VARIABLE</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active buffer variables used by <em class="parameter"><code>program</code></em>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_SHADER_STORAGE_BLOCK</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active shader storage blocks used by <em class="parameter"><code>program</code></em>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>
</span>
</dt>
<dd>
<p>
The query is targeted at the set of active buffer binding points to which output variables in the
<code class="constant">GL_TRANSFORM_FEEDBACK_VARYING</code> interface are written.
</p>
</dd>
</dl>
</div>
<p>
<em class="parameter"><code>pname</code></em> identifies the property of <em class="parameter"><code>programInterface</code></em>
to return in <em class="parameter"><code>params</code></em>.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ACTIVE_RESOURCES</code>, the value returned is the number of
resources in the active resource list for <em class="parameter"><code>programInterface</code></em>. If the list
of active resources for <em class="parameter"><code>programInterface</code></em> is empty, zero is returned.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NAME_LENGTH</code>, the value returned is the length of the
longest active name string for an active resource in <em class="parameter"><code>programInterface</code></em>.
This length includes an extra character for the null terminator. If the
list of active resources for <em class="parameter"><code>programInterface</code></em> is empty, zero is
returned. It is an error to specify <code class="constant">GL_MAX_NAME_LENGTH</code> when <em class="parameter"><code>programInterface</code></em>
is <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>, as active atomic counter buffer resources are
not assigned name strings.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NUM_ACTIVE_VARIABLES</code>, the value returned is the number
of active variables belonging to the interface block or atomic counter
buffer resource in <em class="parameter"><code>programInterface</code></em> with the most active variables. If
the list of active resources for <em class="parameter"><code>programInterface</code></em> is empty, zero is
returned. When <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NUM_ACTIVE_VARIABLES</code>, <em class="parameter"><code>programInterface</code></em>
must be <code class="constant">GL_UNIFORM_BLOCK</code>, <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>, or <code class="constant">GL_SHADER_STORAGE_BLOCK</code>.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NUM_COMPATIBLE_SUBROUTINES</code>, the value returned is the
number of compatible subroutines belonging to the active subroutine
uniform in <em class="parameter"><code>programInterface</code></em> with the most compatible subroutines. If
the list of active resources for <em class="parameter"><code>programInterface</code></em> is empty, zero is
returned. When <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NUM_COMPATIBLE_SUBROUTINES</code>,
<em class="parameter"><code>programInterface</code></em> must be one of <code class="constant">GL_VERTEX_SUBROUTINE_UNIFORM</code>,
<code class="constant">GL_TESS_CONTROL_SUBROUTINE_UNIFORM</code>, <code class="constant">GL_TESS_EVALUATION_SUBROUTINE_UNIFORM</code>,
<code class="constant">GL_GEOMETRY_SUBROUTINE_UNIFORM</code>, <code class="constant">GL_FRAGMENT_SUBROUTINE_UNIFORM</code>, or
<code class="constant">GL_COMPUTE_SUBROUTINE_UNIFORM</code>.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>identifier</code></em>
is not one of the accepted object types.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>program</code></em>
is not the name of an existing sync object.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>bufSize</code></em> is
zero.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>pname</code></em> is <code class="constant">GL_MAX_NAME_LENGTH</code> and
<em class="parameter"><code>programInterface</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code> or <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>,
since active atomic counter and transform feedback buffer resources are not assigned name strings.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> error is generated if <em class="parameter"><code>pname</code></em> is
<code class="constant">GL_MAX_NUM_ACTIVE_VARIABLES</code> and <em class="parameter"><code>programInterface</code></em> is not <code class="constant">GL_UNIFORM_BLOCK</code>,
<code class="constant">GL_SHADER_STORAGE_BLOCK</code>, <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>, or
<code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>.
</p>
<p>
If not NULL, <em class="parameter"><code>length</code></em> and <em class="parameter"><code>label</code></em> should be addresses
to which the client has write access, otherwise undefined behavior, including process termination
may occur.
</p>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_LABEL_LENGTH</code>.
</p>
</div>
<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">glGetProgramInterfaceiv</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="glPushDebugGroup.xhtml"><span class="citerefentry"><span class="refentrytitle">glPushDebugGroup</span></span></a>,
<a class="citerefentry" href="glPopDebugGroup.xhtml"><span class="citerefentry"><span class="refentrytitle">glPopDebugGroup</span></span></a>,
<a class="citerefentry" href="glObjectLabel.xhtml"><span class="citerefentry"><span class="refentrytitle">glObjectLabel</span></span></a>,
<a class="citerefentry" href="glGetObjectLabel.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetObjectLabel</span></span></a>.
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright <span class="trademark"/>© 2013-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="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p>
</div>
</div>
<footer/>
</body>
</html>
|
