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
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glGetProgram">
<info>
<copyright>
<year>2003-2005</year>
<holder>3Dlabs Inc. Ltd.</holder>
</copyright>
<copyright>
<year>2010-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glGetProgram</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glGetProgramiv</refname>
<refpurpose>Returns a parameter from a program object</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glGetProgramiv</function></funcdef>
<paramdef>GLuint <parameter>program</parameter></paramdef>
<paramdef>GLenum <parameter>pname</parameter></paramdef>
<paramdef>GLint *<parameter>params</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>program</parameter></term>
<listitem>
<para>Specifies the program object to be
queried.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pname</parameter></term>
<listitem>
<para>Specifies the object parameter. Accepted
symbolic names are
<constant>GL_DELETE_STATUS</constant>,
<constant>GL_LINK_STATUS</constant>,
<constant>GL_VALIDATE_STATUS</constant>,
<constant>GL_INFO_LOG_LENGTH</constant>,
<constant>GL_ATTACHED_SHADERS</constant>,
<constant>GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</constant>,
<constant>GL_ACTIVE_ATTRIBUTES</constant>,
<constant>GL_ACTIVE_ATTRIBUTE_MAX_LENGTH</constant>,
<constant>GL_ACTIVE_UNIFORMS</constant>,
<constant>GL_ACTIVE_UNIFORM_BLOCKS</constant>,
<constant>GL_ACTIVE_UNIFORM_BLOCK_MAX_NAME_LENGTH</constant>,
<constant>GL_ACTIVE_UNIFORM_MAX_LENGTH</constant>,
<constant>GL_COMPUTE_WORK_GROUP_SIZE</constant>
<constant>GL_PROGRAM_BINARY_LENGTH</constant>,
<constant>GL_TRANSFORM_FEEDBACK_BUFFER_MODE</constant>,
<constant>GL_TRANSFORM_FEEDBACK_VARYINGS</constant>,
<constant>GL_TRANSFORM_FEEDBACK_VARYING_MAX_LENGTH</constant>,
<constant>GL_GEOMETRY_VERTICES_OUT</constant>,
<constant>GL_GEOMETRY_INPUT_TYPE</constant>, and
<constant>GL_GEOMETRY_OUTPUT_TYPE</constant>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>params</parameter></term>
<listitem>
<para>Returns the requested object parameter.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para><function>glGetProgram</function>
returns in <parameter>params</parameter>
the value of a parameter for a specific program object. The following parameters are defined:</para>
<variablelist>
<varlistentry>
<term><constant>GL_DELETE_STATUS</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns
<constant>GL_TRUE</constant> if
<parameter>program</parameter> is currently flagged
for deletion, and <constant>GL_FALSE</constant>
otherwise.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_LINK_STATUS</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns
<constant>GL_TRUE</constant> if the last link
operation on <parameter>program</parameter> was
successful, and <constant>GL_FALSE</constant>
otherwise.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_VALIDATE_STATUS</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns
<constant>GL_TRUE</constant> or if the last
validation operation on
<parameter>program</parameter> was successful, and
<constant>GL_FALSE</constant>
otherwise.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_INFO_LOG_LENGTH</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the
number of characters in the information log for
<parameter>program</parameter> including the null
termination character (i.e., the size of the
character buffer required to store the information
log). If <parameter>program</parameter> has no
information log, a value of 0 is
returned.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_ATTACHED_SHADERS</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the
number of shader objects attached to
<parameter>program</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the
number of active attribute atomic counter buffers used by
<parameter>program</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_ACTIVE_ATTRIBUTES</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the
number of active attribute variables for
<parameter>program</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_ACTIVE_ATTRIBUTE_MAX_LENGTH</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the
length of the longest active attribute name for
<parameter>program</parameter>, 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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_ACTIVE_UNIFORMS</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the
number of active uniform variables for
<parameter>program</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_ACTIVE_UNIFORM_MAX_LENGTH</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the
length of the longest active uniform variable name
for <parameter>program</parameter>, 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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_PROGRAM_BINARY_LENGTH</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the
length of the program binary, in bytes that will be returned by
a call to <citerefentry><refentrytitle>glGetProgramBinary</refentrytitle></citerefentry>.
When a progam's <constant>GL_LINK_STATUS</constant> is <constant>GL_FALSE</constant>,
its program binary length is zero.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_COMPUTE_WORK_GROUP_SIZE</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns an
array of three integers containing the local work group size of
the compute program as specified by its input layout qualifier(s).
<parameter>program</parameter> must be the name of a program object
that has been previously linked successfully and contains a binary
for the compute shader stage.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_TRANSFORM_FEEDBACK_BUFFER_MODE</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns a symbolic constant
indicating the buffer mode used when transform feedback is active.
This may be <constant>GL_SEPARATE_ATTRIBS</constant> or
<constant>GL_INTERLEAVED_ATTRIBS</constant>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_TRANSFORM_FEEDBACK_VARYINGS</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the number of varying
variables to capture in transform feedback mode for the program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_TRANSFORM_FEEDBACK_VARYING_MAX_LENGTH</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the length of the longest
variable name to be used for transform feedback, including the null-terminator.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_GEOMETRY_VERTICES_OUT</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns the maximum number of vertices
that the geometry shader in <parameter>program</parameter> will output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_GEOMETRY_INPUT_TYPE</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns a symbolic constant indicating
the primitive type accepted as input to the geometry shader contained in
<parameter>program</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_GEOMETRY_OUTPUT_TYPE</constant></term>
<listitem>
<para>
</para>
<para> <parameter>params</parameter> returns a symbolic constant indicating
the primitive type that will be output by the geometry shader contained
in <parameter>program</parameter>.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="notes"><title>Notes</title>
<para>
<constant>GL_ACTIVE_UNIFORM_BLOCKS</constant> and
<constant>GL_ACTIVE_UNIFORM_BLOCK_MAX_NAME_LENGTH</constant>
are available only if the GL version 3.1 or greater.
</para>
<para>
<constant>GL_GEOMETRY_VERTICES_OUT</constant>, <constant>GL_GEOMETRY_INPUT_TYPE</constant>
and <constant>GL_GEOMETRY_OUTPUT_TYPE</constant> are accepted only if the GL
version is 3.2 or greater.
</para>
<para>
<constant>GL_COMPUTE_WORK_GROUP_SIZE</constant> is accepted 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>
</refsect1>
<refsect1 xml:id="errors"><title>Errors</title>
<para><constant>GL_INVALID_VALUE</constant>
is generated if <parameter>program</parameter>
is not a value generated by OpenGL.</para>
<para><constant>GL_INVALID_OPERATION</constant>
is generated if <parameter>program</parameter>
does not refer to a program object.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated if
<parameter>pname</parameter> is <constant>GL_GEOMETRY_VERTICES_OUT</constant>,
<constant>GL_GEOMETRY_INPUT_TYPE</constant>, or <constant>GL_GEOMETRY_OUTPUT_TYPE</constant>,
and <parameter>program</parameter> does not contain a geometry shader.</para>
<para><constant>GL_INVALID_ENUM</constant>
is generated if <parameter>pname</parameter>
is not an accepted value.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated if <parameter>pname</parameter>
is <constant>GL_COMPUTE_WORK_GROUP_SIZE</constant> and <parameter>program</parameter>
does not contain a binary for the compute shader stage.</para>
</refsect1>
<refsect1 xml:id="associatedgets"><title>Associated Gets</title>
<para><citerefentry><refentrytitle>glGetActiveAttrib</refentrytitle></citerefentry>
with argument <parameter>program</parameter></para>
<para><citerefentry><refentrytitle>glGetActiveUniform</refentrytitle></citerefentry>
with argument <parameter>program</parameter></para>
<para><citerefentry><refentrytitle>glGetAttachedShaders</refentrytitle></citerefentry>
with argument <parameter>program</parameter></para>
<para><citerefentry><refentrytitle>glGetProgramInfoLog</refentrytitle></citerefentry>
with argument <parameter>program</parameter></para>
<para><citerefentry><refentrytitle>glIsProgram</refentrytitle></citerefentry>
<parameter/></para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry><function>glGetProgramiv</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='20']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para><citerefentry><refentrytitle>glAttachShader</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCreateProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGetShader</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glValidateProgram</refentrytitle></citerefentry></para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 2003-2005 3Dlabs Inc. Ltd.
Copyright <trademark class="copyright"/> 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.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>
|
