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
|
<!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="glGetActiveAttrib">
<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>glGetActiveAttrib</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glGetActiveAttrib</refname>
<refpurpose>Returns information about an active attribute variable for the specified program object</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glGetActiveAttrib</function></funcdef>
<paramdef>GLuint <parameter>program</parameter></paramdef>
<paramdef>GLuint <parameter>index</parameter></paramdef>
<paramdef>GLsizei <parameter>bufSize</parameter></paramdef>
<paramdef>GLsizei *<parameter>length</parameter></paramdef>
<paramdef>GLint *<parameter>size</parameter></paramdef>
<paramdef>GLenum *<parameter>type</parameter></paramdef>
<paramdef>GLchar *<parameter>name</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>index</parameter></term>
<listitem>
<para>Specifies the index of the attribute variable
to be queried.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bufSize</parameter></term>
<listitem>
<para>Specifies the maximum number of characters
OpenGL is allowed to write in the character buffer
indicated by <parameter>name</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>Returns the number of characters actually
written by OpenGL in the string indicated by
<parameter>name</parameter> (excluding the null
terminator) if a value other than
<constant>NULL</constant> is passed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>Returns the size of the attribute
variable.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>Returns the data type of the attribute
variable.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>Returns a null terminated string containing
the name of the attribute variable.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para><function>glGetActiveAttrib</function> returns information
about an active attribute variable in the program object
specified by <parameter>program</parameter>. The number of
active attributes can be obtained by calling
<citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>
with the value <constant>GL_ACTIVE_ATTRIBUTES</constant>. A
value of 0 for <parameter>index</parameter> selects the first
active attribute variable. Permissible values for
<parameter>index</parameter> range from zero to the number of
active attribute variables minus one.</para>
<para>A vertex shader may use either built-in attribute
variables, user-defined attribute variables, or both. Built-in
attribute variables have a prefix of "gl_" and
reference conventional OpenGL vertex attribtes (e.g.,
<parameter>gl_Vertex</parameter>,
<parameter>gl_Normal</parameter>, etc., see the OpenGL Shading
Language specification for a complete list.) User-defined
attribute variables have arbitrary names and obtain their values
through numbered generic vertex attributes. An attribute
variable (either built-in or user-defined) is considered active
if it is determined during the link operation that it may be
accessed during program execution. Therefore,
<parameter>program</parameter> should have previously been the
target of a call to
<citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
but it is not necessary for it to have been linked
successfully.</para>
<para>The size of the character buffer required to store the
longest attribute variable name in
<parameter>program</parameter> can be obtained by calling
<citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>
with the value
<constant>GL_ACTIVE_ATTRIBUTE_MAX_LENGTH</constant>. This value
should be used to allocate a buffer of sufficient size to store
the returned attribute name. The size of this character buffer
is passed in <parameter>bufSize</parameter>, and a pointer to
this character buffer is passed in
<parameter>name</parameter>.</para>
<para><function>glGetActiveAttrib</function> returns the name of
the attribute variable indicated by
<parameter>index</parameter>, storing it in the character buffer
specified by <parameter>name</parameter>. The string returned
will be null terminated. The actual number of characters written
into this buffer is returned in <parameter>length</parameter>,
and this count does not include the null termination character.
If the length of the returned string is not required, a value of
<constant>NULL</constant> can be passed in the
<parameter>length</parameter> argument.</para>
<para>The <parameter>type</parameter> argument specifies a
pointer to a variable into which the attribute variable's data type
will be written. The symbolic
constants <constant>GL_FLOAT</constant>,
<constant>GL_FLOAT_VEC2</constant>,
<constant>GL_FLOAT_VEC3</constant>,
<constant>GL_FLOAT_VEC4</constant>,
<constant>GL_FLOAT_MAT2</constant>,
<constant>GL_FLOAT_MAT3</constant>,
<constant>GL_FLOAT_MAT4</constant>,
<constant>GL_FLOAT_MAT2x3</constant>,
<constant>GL_FLOAT_MAT2x4</constant>,
<constant>GL_FLOAT_MAT3x2</constant>,
<constant>GL_FLOAT_MAT3x4</constant>,
<constant>GL_FLOAT_MAT4x2</constant>,
<constant>GL_FLOAT_MAT4x3</constant>,
<constant>GL_INT</constant>,
<constant>GL_INT_VEC2</constant>,
<constant>GL_INT_VEC3</constant>,
<constant>GL_INT_VEC4</constant>,
<constant>GL_UNSIGNED_INT</constant>,
<constant>GL_UNSIGNED_INT_VEC2</constant>,
<constant>GL_UNSIGNED_INT_VEC3</constant>,
<constant>GL_UNSIGNED_INT_VEC4</constant>,
<constant>GL_DOUBLE</constant>,
<constant>GL_DOUBLE_VEC2</constant>,
<constant>GL_DOUBLE_VEC3</constant>,
<constant>GL_DOUBLE_VEC4</constant>,
<constant>GL_DOUBLE_MAT2</constant>,
<constant>GL_DOUBLE_MAT3</constant>,
<constant>GL_DOUBLE_MAT4</constant>,
<constant>GL_DOUBLE_MAT2x3</constant>,
<constant>GL_DOUBLE_MAT2x4</constant>,
<constant>GL_DOUBLE_MAT3x2</constant>,
<constant>GL_DOUBLE_MAT3x4</constant>,
<constant>GL_DOUBLE_MAT4x2</constant>, or
<constant>GL_DOUBLE_MAT4x3</constant>
may be returned. The
<parameter>size</parameter> argument will return the size of the
attribute, in units of the type returned in
<parameter>type</parameter>.</para>
<para>The list of active attribute variables may include both
built-in attribute variables (which begin with the prefix
"gl_") as well as user-defined attribute variable
names.</para>
<para>This function will return as much information as it can
about the specified active attribute variable. If no information
is available, <parameter>length</parameter> will be 0, and
<parameter>name</parameter> will be an empty string. This
situation could occur if this function is called after a link
operation that failed. If an error occurs, the return values
<parameter>length</parameter>, <parameter>size</parameter>,
<parameter>type</parameter>, and <parameter>name</parameter>
will be unmodified.</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> is not a program object.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>index</parameter> is greater than or equal to the
number of active attribute variables in
<parameter>program</parameter>.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>bufSize</parameter> is less than 0.</para>
</refsect1>
<refsect1 xml:id="associatedgets"><title>Associated Gets</title>
<para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>
with argument <constant>GL_MAX_VERTEX_ATTRIBS</constant>.</para>
<para><citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>
with argument <constant>GL_ACTIVE_ATTRIBUTES</constant> or
<constant>GL_ACTIVE_ATTRIBUTE_MAX_LENGTH</constant>.</para>
<para><citerefentry><refentrytitle>glIsProgram</refentrytitle></citerefentry></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>glGetActiveAttrib</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>glBindAttribLocation</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttrib</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribPointer</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>
|
