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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>glGetProgram - 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="glGetProgram">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>glGetProgramiv — Returns a parameter from a program object</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">glGetProgramiv</strong>(</code>
</td>
<td>GLuint <var class="pdparam">program</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>Specifies the program object to be
queried.</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>pname</code>
</em>
</span>
</dt>
<dd>
<p>Specifies the object parameter. Accepted
symbolic names are
<code class="constant">GL_DELETE_STATUS</code>,
<code class="constant">GL_LINK_STATUS</code>,
<code class="constant">GL_VALIDATE_STATUS</code>,
<code class="constant">GL_INFO_LOG_LENGTH</code>,
<code class="constant">GL_ATTACHED_SHADERS</code>,
<code class="constant">GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</code>,
<code class="constant">GL_ACTIVE_ATTRIBUTES</code>,
<code class="constant">GL_ACTIVE_ATTRIBUTE_MAX_LENGTH</code>,
<code class="constant">GL_ACTIVE_UNIFORMS</code>,
<code class="constant">GL_ACTIVE_UNIFORM_BLOCKS</code>,
<code class="constant">GL_ACTIVE_UNIFORM_BLOCK_MAX_NAME_LENGTH</code>,
<code class="constant">GL_ACTIVE_UNIFORM_MAX_LENGTH</code>,
<code class="constant">GL_COMPUTE_WORK_GROUP_SIZE</code>
<code class="constant">GL_PROGRAM_BINARY_LENGTH</code>,
<code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER_MODE</code>,
<code class="constant">GL_TRANSFORM_FEEDBACK_VARYINGS</code>,
<code class="constant">GL_TRANSFORM_FEEDBACK_VARYING_MAX_LENGTH</code>,
<code class="constant">GL_GEOMETRY_VERTICES_OUT</code>,
<code class="constant">GL_GEOMETRY_INPUT_TYPE</code>, and
<code class="constant">GL_GEOMETRY_OUTPUT_TYPE</code>.</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>params</code>
</em>
</span>
</dt>
<dd>
<p>Returns the requested object parameter.</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p><code class="function">glGetProgram</code>
returns in <em class="parameter"><code>params</code></em>
the value of a parameter for a specific program object. The following parameters are defined:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="constant">GL_DELETE_STATUS</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns
<code class="constant">GL_TRUE</code> if
<em class="parameter"><code>program</code></em> is currently flagged
for deletion, and <code class="constant">GL_FALSE</code>
otherwise.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_LINK_STATUS</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns
<code class="constant">GL_TRUE</code> if the last link
operation on <em class="parameter"><code>program</code></em> was
successful, and <code class="constant">GL_FALSE</code>
otherwise.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_VALIDATE_STATUS</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns
<code class="constant">GL_TRUE</code> or if the last
validation operation on
<em class="parameter"><code>program</code></em> was successful, and
<code class="constant">GL_FALSE</code>
otherwise.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_INFO_LOG_LENGTH</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the
number of characters in the information log for
<em class="parameter"><code>program</code></em> including the null
termination character (i.e., the size of the
character buffer required to store the information
log). If <em class="parameter"><code>program</code></em> has no
information log, a value of 0 is
returned.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_ATTACHED_SHADERS</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the
number of shader objects attached to
<em class="parameter"><code>program</code></em>.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the
number of active attribute atomic counter buffers used by
<em class="parameter"><code>program</code></em>.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_ACTIVE_ATTRIBUTES</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the
number of active attribute variables for
<em class="parameter"><code>program</code></em>.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_ACTIVE_ATTRIBUTE_MAX_LENGTH</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the
length of the longest active attribute name for
<em class="parameter"><code>program</code></em>, including the null
termination character (i.e., the size of the
character buffer required to store the longest
attribute name). If no active attributes exist, 0 is
returned.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_ACTIVE_UNIFORMS</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the
number of active uniform variables for
<em class="parameter"><code>program</code></em>.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_ACTIVE_UNIFORM_MAX_LENGTH</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the
length of the longest active uniform variable name
for <em class="parameter"><code>program</code></em>, including the
null termination character (i.e., the size of the
character buffer required to store the longest
uniform variable name). If no active uniform
variables exist, 0 is returned.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_PROGRAM_BINARY_LENGTH</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the
length of the program binary, in bytes that will be returned by
a call to <a class="citerefentry" href="glGetProgramBinary.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetProgramBinary</span></span></a>.
When a progam's <code class="constant">GL_LINK_STATUS</code> is <code class="constant">GL_FALSE</code>,
its program binary length is zero.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_COMPUTE_WORK_GROUP_SIZE</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns an
array of three integers containing the local work group size of
the compute program as specified by its input layout qualifier(s).
<em class="parameter"><code>program</code></em> must be the name of a program object
that has been previously linked successfully and contains a binary
for the compute shader stage.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER_MODE</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns a symbolic constant
indicating the buffer mode used when transform feedback is active.
This may be <code class="constant">GL_SEPARATE_ATTRIBS</code> or
<code class="constant">GL_INTERLEAVED_ATTRIBS</code>.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_TRANSFORM_FEEDBACK_VARYINGS</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the number of varying
variables to capture in transform feedback mode for the program.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_TRANSFORM_FEEDBACK_VARYING_MAX_LENGTH</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the length of the longest
variable name to be used for transform feedback, including the null-terminator.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_GEOMETRY_VERTICES_OUT</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns the maximum number of vertices
that the geometry shader in <em class="parameter"><code>program</code></em> will output.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_GEOMETRY_INPUT_TYPE</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns a symbolic constant indicating
the primitive type accepted as input to the geometry shader contained in
<em class="parameter"><code>program</code></em>.</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_GEOMETRY_OUTPUT_TYPE</code>
</span>
</dt>
<dd>
<p>
</p>
<p> <em class="parameter"><code>params</code></em> returns a symbolic constant indicating
the primitive type that will be output by the geometry shader contained
in <em class="parameter"><code>program</code></em>.</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
<code class="constant">GL_ACTIVE_UNIFORM_BLOCKS</code> and
<code class="constant">GL_ACTIVE_UNIFORM_BLOCK_MAX_NAME_LENGTH</code>
are available only if the GL version 3.1 or greater.
</p>
<p>
<code class="constant">GL_GEOMETRY_VERTICES_OUT</code>, <code class="constant">GL_GEOMETRY_INPUT_TYPE</code>
and <code class="constant">GL_GEOMETRY_OUTPUT_TYPE</code> are accepted only if the GL
version is 3.2 or greater.
</p>
<p>
<code class="constant">GL_COMPUTE_WORK_GROUP_SIZE</code> is accepted only if the
GL version is 4.3 or greater.
</p>
<p>If an error is generated, no change is made to the
contents of <em class="parameter"><code>params</code></em>.</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 a value generated by OpenGL.</p>
<p><code class="constant">GL_INVALID_OPERATION</code>
is generated if <em class="parameter"><code>program</code></em>
does not refer to a program object.</p>
<p><code class="constant">GL_INVALID_OPERATION</code> is generated if
<em class="parameter"><code>pname</code></em> is <code class="constant">GL_GEOMETRY_VERTICES_OUT</code>,
<code class="constant">GL_GEOMETRY_INPUT_TYPE</code>, or <code class="constant">GL_GEOMETRY_OUTPUT_TYPE</code>,
and <em class="parameter"><code>program</code></em> does not contain a geometry shader.</p>
<p><code class="constant">GL_INVALID_ENUM</code>
is generated if <em class="parameter"><code>pname</code></em>
is not an accepted value.</p>
<p><code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>pname</code></em>
is <code class="constant">GL_COMPUTE_WORK_GROUP_SIZE</code> and <em class="parameter"><code>program</code></em>
does not contain a binary for the compute shader stage.</p>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p><a class="citerefentry" href="glGetActiveAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetActiveAttrib</span></span></a>
with argument <em class="parameter"><code>program</code></em></p>
<p><a class="citerefentry" href="glGetActiveUniform.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetActiveUniform</span></span></a>
with argument <em class="parameter"><code>program</code></em></p>
<p><a class="citerefentry" href="glGetAttachedShaders.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetAttachedShaders</span></span></a>
with argument <em class="parameter"><code>program</code></em></p>
<p><a class="citerefentry" href="glGetProgramInfoLog.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetProgramInfoLog</span></span></a>
with argument <em class="parameter"><code>program</code></em></p>
<p><a class="citerefentry" href="glIsProgram.xhtml"><span class="citerefentry"><span class="refentrytitle">glIsProgram</span></span></a>
<em class="parameter"><code/></em></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">glGetProgramiv</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="glAttachShader.xhtml"><span class="citerefentry"><span class="refentrytitle">glAttachShader</span></span></a>,
<a class="citerefentry" href="glCreateProgram.xhtml"><span class="citerefentry"><span class="refentrytitle">glCreateProgram</span></span></a>,
<a class="citerefentry" href="glDeleteProgram.xhtml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgram</span></span></a>,
<a class="citerefentry" href="glGetShader.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a>,
<a class="citerefentry" href="glLinkProgram.xhtml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>,
<a class="citerefentry" href="glValidateProgram.xhtml"><span class="citerefentry"><span class="refentrytitle">glValidateProgram</span></span></a></p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright <span class="trademark"/>© 2003-2005 3Dlabs Inc. Ltd.
Copyright <span class="trademark"/>© 2010-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>
|
