1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glGetActiveUniformsiv">
6 <refentrytitle>glGetActiveUniformsiv
</refentrytitle>
7 <manvolnum>3G
</manvolnum>
10 <refname>glGetActiveUniformsiv
</refname>
11 <refpurpose>Returns information about several active uniform variables for the specified program object
</refpurpose>
13 <refsynopsisdiv><title>C Specification
</title>
16 <funcdef>void
<function>glGetActiveUniformsiv
</function></funcdef>
17 <paramdef>GLuint
<parameter>program
</parameter></paramdef>
18 <paramdef>GLsizei
<parameter>uniformCount
</parameter></paramdef>
19 <paramdef>const GLuint *
<parameter>uniformIndices
</parameter></paramdef>
20 <paramdef>GLenum
<parameter>pname
</parameter></paramdef>
21 <paramdef>GLint *
<parameter>params
</parameter></paramdef>
25 <refsect1 id=
"parameters"><title>Parameters
</title>
28 <term><parameter>program
</parameter></term>
30 <para>Specifies the program object to be queried.
</para>
34 <term><parameter>uniformCount
</parameter></term>
36 <para>Specifies both the number of elements in the array of indices
<parameter>uniformIndices
</parameter> and the
37 number of parameters written to
<parameter>params
</parameter> upon successful return.
</para>
41 <term><parameter>uniformIndices
</parameter></term>
43 <para>Specifies the address of an array of
<parameter>uniformCount
</parameter> integers containing the indices of
44 uniforms within
<parameter>program
</parameter> whose parameter
<parameter>pname
</parameter> pname.
</para>
48 <term><parameter>pname
</parameter></term>
50 <para>Specifies the property of the each uniform in
<parameter>uniformIndices
</parameter> that should be
51 written into the corresponding element of
<parameter>params
</parameter>.
</para>
55 <term><parameter>params
</parameter></term>
57 <para>Specifies the address of an array of
<parameter>uniformCount
</parameter> integers which are to
58 receive the value of
<parameter>pname
</parameter> for each uniform in
<parameter>uniformIndices
</parameter>.
</para>
63 <refsect1 id=
"description"><title>Description
</title>
65 <function>glGetActiveUniformsiv
</function> queries the value of the parameter named
<parameter>pname
</parameter>
66 for each of the uniforms within
<parameter>program
</parameter> whose indices are specified in the array of
67 <parameter>uniformCount
</parameter> unsigned integers
<parameter>uniformIndices
</parameter>. Upon success,
68 the value of the parameter for each uniform is written into the corresponding entry in the array whose
69 address is given in
<parameter>params
</parameter>. If an error is generated, nothing is written into
70 <parameter>params
</parameter>.
73 If
<parameter>pname
</parameter> is
<constant>GL_UNIFORM_TYPE
</constant>, then an array identifying the types
74 of uniforms specified by the corresponding array of
<parameter>uniformIndices
</parameter> is returned. The
75 returned types can be any of the values from the following table:
76 <informaltable frame=
"topbot">
77 <tgroup cols=
"2" align=
"left">
78 <colspec colwidth=
"1.1*" />
79 <colspec colwidth=
"1*" />
82 <entry rowsep=
"1" align=
"left"><emphasis role=
"bold">
83 Returned Symbolic Contant
85 <entry rowsep=
"1" align=
"left"><emphasis role=
"bold">
93 <constant>GL_FLOAT
</constant>
96 <constant>float
</constant>
101 <constant>GL_FLOAT_VEC2
</constant>
104 <constant>vec2
</constant>
109 <constant>GL_FLOAT_VEC3
</constant>
112 <constant>vec3
</constant>
117 <constant>GL_FLOAT_VEC4
</constant>
120 <constant>vec4
</constant>
125 <constant>GL_DOUBLE
</constant>
128 <constant>double
</constant>
133 <constant>GL_DOUBLE_VEC2
</constant>
136 <constant>dvec2
</constant>
141 <constant>GL_DOUBLE_VEC3
</constant>
144 <constant>dvec3
</constant>
149 <constant>GL_DOUBLE_VEC4
</constant>
152 <constant>dvec4
</constant>
157 <constant>GL_INT
</constant>
160 <constant>int
</constant>
165 <constant>GL_INT_VEC2
</constant>
168 <constant>ivec2
</constant>
173 <constant>GL_INT_VEC3
</constant>
176 <constant>ivec3
</constant>
181 <constant>GL_INT_VEC4
</constant>
184 <constant>ivec4
</constant>
189 <constant>GL_UNSIGNED_INT
</constant>
192 <constant>unsigned int
</constant>
197 <constant>GL_UNSIGNED_INT_VEC2
</constant>
200 <constant>uvec2
</constant>
205 <constant>GL_UNSIGNED_INT_VEC3
</constant>
208 <constant>uvec3
</constant>
213 <constant>GL_UNSIGNED_INT_VEC4
</constant>
216 <constant>uvec4
</constant>
221 <constant>GL_BOOL
</constant>
224 <constant>bool
</constant>
229 <constant>GL_BOOL_VEC2
</constant>
232 <constant>bvec2
</constant>
237 <constant>GL_BOOL_VEC3
</constant>
240 <constant>bvec3
</constant>
245 <constant>GL_BOOL_VEC4
</constant>
248 <constant>bvec4
</constant>
253 <constant>GL_FLOAT_MAT2
</constant>
256 <constant>mat2
</constant>
261 <constant>GL_FLOAT_MAT3
</constant>
264 <constant>mat3
</constant>
269 <constant>GL_FLOAT_MAT4
</constant>
272 <constant>mat4
</constant>
277 <constant>GL_FLOAT_MAT2x3
</constant>
280 <constant>mat2x3
</constant>
285 <constant>GL_FLOAT_MAT2x4
</constant>
288 <constant>mat2x4
</constant>
293 <constant>GL_FLOAT_MAT3x2
</constant>
296 <constant>mat3x2
</constant>
301 <constant>GL_FLOAT_MAT3x4
</constant>
304 <constant>mat3x4
</constant>
309 <constant>GL_FLOAT_MAT4x2
</constant>
312 <constant>mat4x2
</constant>
317 <constant>GL_FLOAT_MAT4x3
</constant>
320 <constant>mat4x3
</constant>
325 <constant>GL_DOUBLE_MAT2
</constant>
328 <constant>dmat2
</constant>
333 <constant>GL_DOUBLE_MAT3
</constant>
336 <constant>dmat3
</constant>
341 <constant>GL_DOUBLE_MAT4
</constant>
344 <constant>dmat4
</constant>
349 <constant>GL_DOUBLE_MAT2x3
</constant>
352 <constant>dmat2x3
</constant>
357 <constant>GL_DOUBLE_MAT2x4
</constant>
360 <constant>dmat2x4
</constant>
365 <constant>GL_DOUBLE_MAT3x2
</constant>
368 <constant>dmat3x2
</constant>
373 <constant>GL_DOUBLE_MAT3x4
</constant>
376 <constant>dmat3x4
</constant>
381 <constant>GL_DOUBLE_MAT4x2
</constant>
384 <constant>dmat4x2
</constant>
389 <constant>GL_DOUBLE_MAT4x3
</constant>
392 <constant>dmat4x3
</constant>
397 <constant>GL_SAMPLER_1D
</constant>
400 <constant>sampler1D
</constant>
405 <constant>GL_SAMPLER_2D
</constant>
408 <constant>sampler2D
</constant>
413 <constant>GL_SAMPLER_3D
</constant>
416 <constant>sampler3D
</constant>
421 <constant>GL_SAMPLER_CUBE
</constant>
424 <constant>samplerCube
</constant>
429 <constant>GL_SAMPLER_1D_SHADOW
</constant>
432 <constant>sampler1DShadow
</constant>
437 <constant>GL_SAMPLER_2D_SHADOW
</constant>
440 <constant>sampler2DShadow
</constant>
445 <constant>GL_SAMPLER_1D_ARRAY
</constant>
448 <constant>sampler1DArray
</constant>
453 <constant>GL_SAMPLER_2D_ARRAY
</constant>
456 <constant>sampler2DArray
</constant>
461 <constant>GL_SAMPLER_1D_ARRAY_SHADOW
</constant>
464 <constant>sampler1DArrayShadow
</constant>
469 <constant>GL_SAMPLER_2D_ARRAY_SHADOW
</constant>
472 <constant>sampler2DArrayShadow
</constant>
477 <constant>GL_SAMPLER_2D_MULTISAMPLE
</constant>
480 <constant>sampler2DMS
</constant>
485 <constant>GL_SAMPLER_2D_MULTISAMPLE_ARRAY
</constant>
488 <constant>sampler2DMSArray
</constant>
493 <constant>GL_SAMPLER_CUBE_SHADOW
</constant>
496 <constant>samplerCubeShadow
</constant>
501 <constant>GL_SAMPLER_BUFFER
</constant>
504 <constant>samplerBuffer
</constant>
509 <constant>GL_SAMPLER_2D_RECT
</constant>
512 <constant>sampler2DRect
</constant>
517 <constant>GL_SAMPLER_2D_RECT_SHADOW
</constant>
520 <constant>sampler2DRectShadow
</constant>
525 <constant>GL_INT_SAMPLER_1D
</constant>
528 <constant>isampler1D
</constant>
533 <constant>GL_INT_SAMPLER_2D
</constant>
536 <constant>isampler2D
</constant>
541 <constant>GL_INT_SAMPLER_3D
</constant>
544 <constant>isampler3D
</constant>
549 <constant>GL_INT_SAMPLER_CUBE
</constant>
552 <constant>isamplerCube
</constant>
557 <constant>GL_INT_SAMPLER_1D_ARRAY
</constant>
560 <constant>isampler1DArray
</constant>
565 <constant>GL_INT_SAMPLER_2D_ARRAY
</constant>
568 <constant>isampler2DArray
</constant>
573 <constant>GL_INT_SAMPLER_2D_MULTISAMPLE
</constant>
576 <constant>isampler2DMS
</constant>
581 <constant>GL_INT_SAMPLER_2D_MULTISAMPLE_ARRAY
</constant>
584 <constant>isampler2DMSArray
</constant>
589 <constant>GL_INT_SAMPLER_BUFFER
</constant>
592 <constant>isamplerBuffer
</constant>
597 <constant>GL_INT_SAMPLER_2D_RECT
</constant>
600 <constant>isampler2DRect
</constant>
605 <constant>GL_UNSIGNED_INT_SAMPLER_1D
</constant>
608 <constant>usampler1D
</constant>
613 <constant>GL_UNSIGNED_INT_SAMPLER_2D
</constant>
616 <constant>usampler2D
</constant>
621 <constant>GL_UNSIGNED_INT_SAMPLER_3D
</constant>
624 <constant>usampler3D
</constant>
629 <constant>GL_UNSIGNED_INT_SAMPLER_CUBE
</constant>
632 <constant>usamplerCube
</constant>
637 <constant>GL_UNSIGNED_INT_SAMPLER_1D_ARRAY
</constant>
640 <constant>usampler2DArray
</constant>
645 <constant>GL_UNSIGNED_INT_SAMPLER_2D_ARRAY
</constant>
648 <constant>usampler2DArray
</constant>
653 <constant>GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE
</constant>
656 <constant>usampler2DMS
</constant>
661 <constant>GL_UNSIGNED_INT_SAMPLER_2D_MULTISAMPLE_ARRAY
</constant>
664 <constant>usampler2DMSArray
</constant>
669 <constant>GL_UNSIGNED_INT_SAMPLER_BUFFER
</constant>
672 <constant>usamplerBuffer
</constant>
677 <constant>GL_UNSIGNED_INT_SAMPLER_2D_RECT
</constant>
680 <constant>usampler2DRect
</constant>
688 If
<parameter>pname
</parameter> is
<constant>GL_UNIFORM_SIZE
</constant>, then an array identifying the
689 size of the uniforms specified by the corresponding array of
<parameter>uniformIndices
</parameter> is
690 returned. The sizes returned are in units of the type returned by a query of
<constant>GL_UNIFORM_TYPE
</constant>.
691 For active uniforms that are arrays, the size is the number of active elements in the array;
692 for all other uniforms, the size is one.
695 If
<parameter>pname
</parameter> is
<constant>GL_UNIFORM_NAME_LENGTH
</constant>, then an array identifying the
696 length, including the terminating null character, of the uniform name strings specified by the corresponding
697 array of
<parameter>uniformIndices
</parameter> is returned.
700 If
<parameter>pname
</parameter> is
<constant>GL_UNIFORM_BLOCK_INDEX
</constant>, then an array identifying the
701 the uniform block index of each of the uniforms specified by the corresponding array of
<parameter>uniformIndices
</parameter>
702 is returned. The uniform block index of a uniform associated with the default uniform block is -
1.
705 If
<parameter>pname
</parameter> is
<constant>GL_UNIFORM_OFFSET
</constant>, then an array of uniform buffer
706 offsets is returned. For uniforms in a named uniform block, the returned value will be its offset, in basic
707 machine units, relative to the beginning of the uniform block in the buffer object data store.
708 For atomic counter uniforms, the returned value will be its offset relative to the beginning of its active
709 atomic counter buffer.
710 For all other uniforms, -
1 will be returned.
713 If
<parameter>pname
</parameter> is
<constant>GL_UNIFORM_ARRAY_STRIDE
</constant>, then an array identifying the
714 stride between elements of each of the uniforms specified by the corresponding array of
715 <parameter>uniformIndices
</parameter> is returned.
716 For uniforms in named uniform blocks and for uniforms declared as atomic counters, the stride is the difference,
717 in basic machine units, of consecutive elements in an array, or zero for uniforms not declared as an array.
718 For all other uniforms, a stride of -
1 will be returned.
721 If
<parameter>pname
</parameter> is
<constant>GL_UNIFORM_MATRIX_STRIDE
</constant>, then an array identifying the stride
722 between columns of a column-major matrix or rows of a row-major matrix, in basic machine units, of each of the uniforms
723 specified by the corresponding array of
<parameter>uniformIndices
</parameter> is returned. The matrix stride of a
724 uniform associated with the default uniform block is -
1. Note that this information only makes sense for uniforms
725 that are matrices. For uniforms that are not matrices, but are declared in a named uniform block, a matrix stride of
729 If
<parameter>pname
</parameter> is
<constant>GL_UNIFORM_IS_ROW_MAJOR
</constant>, then an array identifying whether each
730 of the uniforms specified by the corresponding array of
<parameter>uniformIndices
</parameter> is a row-major matrix or not is returned. A
731 value of one indicates a row-major matrix, and a value of zero indicates a column-major matrix, a matrix in the default
732 uniform block, or a non-matrix.
735 If
<parameter>pname
</parameter> is
<constant>GL_UNIFORM_ATOMIC_COUNTER_BUFFER_INDEX
</constant>, then an array
736 identifying the active atomic counter buffer index of each of the uniforms specified by the corresponding array
737 of
<parameter>uniformIndices
</parameter> is returned. For uniforms other than atomic counters, the returned buffer
738 index is -
1. The returned indices may be passed to
<citerefentry><refentrytitle>glGetActiveAtomicCounterBufferiv
</refentrytitle></citerefentry>
739 to query the properties of the associated buffer, and not necessarily the binding point specified in the uniform declaration.
742 <refsect1 id=
"notes"><title>Notes
</title>
744 The double types,
<constant>GL_DOUBLE
</constant>,
<constant>GL_DOUBLE_VEC2
</constant>,
745 <constant>GL_DOUBLE_VEC3
</constant>,
<constant>GL_DOUBLE_VEC4
</constant>,
746 <constant>GL_DOUBLE_MAT2
</constant>,
<constant>GL_DOUBLE_MAT3
</constant>,
747 <constant>GL_DOUBLE_MAT4
</constant>,
<constant>GL_DOUBLE_MAT2x3
</constant>,
748 <constant>GL_DOUBLE_MAT2x4
</constant>,
<constant>GL_DOUBLE_MAT3x2
</constant>,
749 <constant>GL_DOUBLE_MAT3x4
</constant>,
<constant>GL_DOUBLE_MAT4x2
</constant>,
750 and
<constant>GL_DOUBLE_MAT4x3
</constant> are only available if the GL
751 version is
4.1 or higher.
754 <constant>GL_UNIFORM_ATOMIC_COUNTER_BUFFER_INDEX
</constant> is only accepted by
<parameter>pname
</parameter>
755 if the GL version is
4.2 or higher.
758 <refsect1 id=
"errors"><title>Errors
</title>
759 <para><constant>GL_INVALID_VALUE
</constant> is generated if
760 <parameter>program
</parameter> is not a value generated by
763 <para><constant>GL_INVALID_OPERATION
</constant> is generated if
764 <parameter>program
</parameter> is not a program object.
</para>
766 <para><constant>GL_INVALID_VALUE
</constant> is generated if
767 <parameter>uniformCount
</parameter> is greater than or equal to the
768 value of
<constant>GL_ACTIVE_UNIFORMS
</constant> for
769 <parameter>program
</parameter>.
</para>
771 <para><constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>pname
</parameter>
772 is not an accepted token.
</para>
774 <refsect1 id=
"associatedgets"><title>Associated Gets
</title>
775 <para><citerefentry><refentrytitle>glGet
</refentrytitle></citerefentry>
776 with argument
<constant>GL_MAX_VERTEX_UNIFORM_COMPONENTS
</constant>,
777 <constant>GL_MAX_TESS_CONTROL_UNIFORM_COMPONENTS
</constant>,
778 <constant>GL_MAX_TESS_EVALUATION_UNIFORM_COMPONENTS
</constant>,
779 <constant>GL_MAX_GEOMETRY_UNIFORM_COMPONENTS
</constant>,
780 <constant>GL_MAX_FRAGMENT_UNIFORM_COMPONENTS
</constant>, or
781 <constant>GL_MAX_COMBINED_UNIFORM_COMPONENTS
</constant>.
</para>
783 <para><citerefentry><refentrytitle>glGetProgram
</refentrytitle></citerefentry>
784 with argument
<constant>GL_ACTIVE_UNIFORMS
</constant> or
785 <constant>GL_ACTIVE_UNIFORM_MAX_LENGTH
</constant>.
</para>
787 <para><citerefentry><refentrytitle>glIsProgram
</refentrytitle></citerefentry></para>
789 <refsect1 id=
"seealso"><title>See Also
</title>
790 <para><citerefentry><refentrytitle>glGetUniform
</refentrytitle></citerefentry>,
791 <citerefentry><refentrytitle>glGetActiveUniform
</refentrytitle></citerefentry>,
792 <citerefentry><refentrytitle>glGetUniformLocation
</refentrytitle></citerefentry>,
793 <citerefentry><refentrytitle>glLinkProgram
</refentrytitle></citerefentry>,
794 <citerefentry><refentrytitle>glUniform
</refentrytitle></citerefentry>,
795 <citerefentry><refentrytitle>glUseProgram
</refentrytitle></citerefentry></para>
797 <refsect1 id=
"Copyright"><title>Copyright
</title>
799 Copyright
<trademark class=
"copyright"></trademark> 2011 Khronos Group
800 This material may be distributed subject to the terms and conditions set forth in
801 the Open Publication License, v
1.0,
8 June
1999.
802 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.
HCoop / clinton / guile-figl.git / blob