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
|
<!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="glVertexAttribFormat">
<info>
<copyright>
<year>2013-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glVertexAttribFormat</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glVertexAttribFormat</refname>
<refname>glVertexArrayAttribFormat</refname>
<refpurpose>specify the organization of vertex arrays</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glVertexAttribFormat</function></funcdef>
<paramdef>GLuint <parameter>attribindex</parameter></paramdef>
<paramdef>GLint <parameter>size</parameter></paramdef>
<paramdef>GLenum <parameter>type</parameter></paramdef>
<paramdef>GLboolean <parameter>normalized</parameter></paramdef>
<paramdef>GLuint <parameter>relativeoffset</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glVertexAttribIFormat</function></funcdef>
<paramdef>GLuint <parameter>attribindex</parameter></paramdef>
<paramdef>GLint <parameter>size</parameter></paramdef>
<paramdef>GLenum <parameter>type</parameter></paramdef>
<paramdef>GLuint <parameter>relativeoffset</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glVertexAttribLFormat</function></funcdef>
<paramdef>GLuint <parameter>attribindex</parameter></paramdef>
<paramdef>GLint <parameter>size</parameter></paramdef>
<paramdef>GLenum <parameter>type</parameter></paramdef>
<paramdef>GLuint <parameter>relativeoffset</parameter></paramdef>
</funcprototype>
<!-- DSA commands -->
<funcprototype>
<funcdef>void <function>glVertexArrayAttribFormat</function></funcdef>
<paramdef>GLuint <parameter>vaobj</parameter></paramdef>
<paramdef>GLuint <parameter>attribindex</parameter></paramdef>
<paramdef>GLint <parameter>size</parameter></paramdef>
<paramdef>GLenum <parameter>type</parameter></paramdef>
<paramdef>GLboolean <parameter>normalized</parameter></paramdef>
<paramdef>GLuint <parameter>relativeoffset</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glVertexArrayAttribIFormat</function></funcdef>
<paramdef>GLuint <parameter>vaobj</parameter></paramdef>
<paramdef>GLuint <parameter>attribindex</parameter></paramdef>
<paramdef>GLint <parameter>size</parameter></paramdef>
<paramdef>GLenum <parameter>type</parameter></paramdef>
<paramdef>GLuint <parameter>relativeoffset</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glVertexArrayAttribLFormat</function></funcdef>
<paramdef>GLuint <parameter>vaobj</parameter></paramdef>
<paramdef>GLuint <parameter>attribindex</parameter></paramdef>
<paramdef>GLint <parameter>size</parameter></paramdef>
<paramdef>GLenum <parameter>type</parameter></paramdef>
<paramdef>GLuint <parameter>relativeoffset</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>vaobj</parameter></term>
<listitem>
<para>Specifies the name of the vertex array object for
<function>glVertexArrayAttrib{I, L}Format</function>
functions.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>attribindex</parameter></term>
<listitem>
<para>The generic vertex attribute array being described.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>The number of values per vertex that are stored in the
array.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>The type of the data stored in the array.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>normalized</parameter></term>
<listitem>
<para>The distance between elements within the buffer.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>relativeoffset</parameter></term>
<listitem>
<para>The distance between elements within the buffer.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description">
<title>Description</title>
<para><function>glVertexAttribFormat</function>,
<function>glVertexAttribIFormat</function> and
<function>glVertexAttribLFormat</function>, as well as
<function>glVertexArrayAttribFormat</function>,
<function>glVertexArrayAttribIFormat</function> and
<function>glVertexArrayAttribLFormat</function> specify the organization
of data in vertex arrays. The first three calls operate on the bound
vertex array object, whereas the last three ones modify the state of a
vertex array object with ID <parameter>vaobj</parameter>.
<parameter>attribindex</parameter> specifies the index of the generic
vertex attribute array whose data layout is being described, and must be
less than the value of <constant>GL_MAX_VERTEX_ATTRIBS</constant>.</para>
<para><parameter>size</parameter> determines the number of components per
vertex are allocated to the specified attribute and must be 1, 2, 3 or 4.
<parameter>type</parameter> indicates the type of the data. If
<parameter>type</parameter> is one of <constant>GL_BYTE</constant>,
<constant>GL_SHORT</constant>, <constant>GL_INT</constant>,
<constant>GL_FIXED</constant>, <constant>GL_FLOAT</constant>,
<constant>GL_HALF_FLOAT</constant>, and <constant>GL_DOUBLE</constant>
indicate types <code>GLbyte</code>, <code>GLshort</code>,
<code>GLint</code>, <code>GLfixed</code>, <code>GLfloat</code>,
<code>GLhalf</code>, and <code>GLdouble</code>, respectively; the values
<constant>GL_UNSIGNED_BYTE</constant>,
<constant>GL_UNSIGNED_SHORT</constant>, and
<constant>GL_UNSIGNED_INT</constant> indicate types <code>GLubyte</code>,
<code>GLushort</code>, and <code>GLuint</code>, respectively; the values
<constant>GL_INT_2_10_10_10_REV</constant> and
<constant>GL_UNSIGNED_INT_2_10_10_10_REV</constant> indicating
respectively four signed or unsigned elements packed into a single
<code>GLuint</code>; and the value
<constant>GL_UNSIGNED_INT_10F_11F_11F_REV</constant> indicating three
floating point values packed into a single <code>GLuint</code>.</para>
<para><function>glVertexAttribLFormat</function> and
<function>glVertexArrayAttribLFormat</function> is used to specify layout
for data associated with a generic attribute variable declared as 64-bit
double precision components. For
<function>glVertexAttribLFormat</function> and
<function>glVertexArrayAttribLFormat</function>,
<parameter>type</parameter> must be <constant>GL_DOUBLE</constant>. In
contrast to <function>glVertexAttribFormat</function> or
<function>glVertexArrayAttribFormat</function>, which will cause data
declared as <constant>GL_DOUBLE</constant> to be converted to 32-bit
representation, <function>glVertexAttribLFormat</function> and
<function>glVertexArrayAttribLFormat</function> cause such data to be left
in its natural, 64-bit representation.</para>
<para>For <function>glVertexAttribFormat</function> and
<function>glVertexArrayAttribFormat</function>, if
<parameter>normalized</parameter> is <constant>GL_TRUE</constant>, then
integer data is normalized to the range [-1, 1] or [0, 1] if it is signed
or unsigned, respectively. If <parameter>normalized</parameter> is
<constant>GL_FALSE</constant> then integer data is directly converted to
floating point.</para>
<para><parameter>relativeoffset</parameter> is the offset, measured in
basic machine units of the first element relative to the start of the
vertex buffer binding this attribute fetches from.</para>
<para><function>glVertexAttribFormat</function> and
<function>glVertexArrayAttribFormat</function> should be used to describe
vertex attribute layout for floating-point vertex attributes,
<function>glVertexAttribIFormat</function> and
<function>glVertexArrayAttribIFormat</function> should be used to describe
vertex attribute layout for integer vertex attribute, and
<function>glVertexAttribLFormat</function> and
<function>glVertexArrayAttribLFormat</function> should be used to describe
the layout for 64-bit vertex attributes. Data for an array specified by
<function>glVertexAttribIFormat</function> and
<function>glVertexArrayAttribIFormat</function> will always be left as
integer values; such data are referred to as pure integers.</para>
</refsect1>
<refsect1 xml:id="notes">
<title>Notes</title>
<para><constant>GL_UNSIGNED_INT_10F_11F_11F_REV</constant> is accepted for
<parameter>type</parameter> only if the GL version is 4.4 or
higher.</para>
</refsect1>
<refsect1 xml:id="errors">
<title>Errors</title>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>attribindex</parameter> is greater than or equal to the value
of <constant>GL_MAX_VERTEX_ATTRIBS</constant>.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>size</parameter> is not one of the accepted values.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>relativeoffset</parameter> is greater than the value of
<constant>GL_MAX_VERTEX_ATTRIB_RELATIVE_OFFSET</constant>.</para>
<para><constant>GL_INVALID_ENUM</constant> is generated if
<parameter>type</parameter> is not one of the accepted tokens.</para>
<para><constant>GL_INVALID_ENUM</constant> is generated by
<function>glVertexAttribIFormat</function>,
<function>glVertexAttribLFormat</function>,
<function>glVertexArrayAttribIFormat</function> and
<function>glVertexArrayAttribLFormat</function> if
<parameter>type</parameter> is
<constant>GL_UNSIGNED_INT_10F_11F_11F_REV</constant>.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated by
<function>glVertexAttribFormat</function>,
<function>glVertexAttribIFormat</function> and
<function>glVertexAttribLFormat</function> if no vertex array object is
bound.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated by
<function>glVertexArrayAttribFormat</function>,
<function>glVertexArrayAttribIFormat</function> and
<function>glVertexArrayAttribLFormat</function> if
<parameter>vaobj</parameter> is not the name of an existing vertex array
object.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated under any of
the following conditions:</para>
<para><itemizedlist>
<listitem>
<para><parameter>size</parameter> is <constant>GL_BGRA</constant>
and <parameter>type</parameter> is not
<constant>GL_UNSIGNED_BYTE</constant>,
<constant>GL_INT_2_10_10_10_REV</constant> or
<constant>GL_UNSIGNED_INT_2_10_10_10_REV</constant>.</para>
</listitem>
<listitem>
<para><parameter>type</parameter> is
<constant>GL_INT_2_10_10_10_REV</constant> or
<constant>GL_UNSIGNED_INT_2_10_10_10_REV</constant>, and
<parameter>size</parameter> is neither 4 nor
<constant>GL_BGRA</constant>.</para>
</listitem>
<listitem>
<para><parameter>type</parameter> is
<constant>GL_UNSIGNED_INT_10F_11F_11F_REV</constant> and
<parameter>size</parameter> is not 3.</para>
</listitem>
<listitem>
<para><parameter>size</parameter> is <constant>GL_BGRA</constant>
and <parameter>normalized</parameter> is
<constant>GL_FALSE</constant>.</para>
</listitem>
</itemizedlist></para>
</refsect1>
<refsect1 xml:id="associatedgets">
<title>Associated Gets</title>
<para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>
with arguments <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>, or
<constant>GL_MAX_VERTEX_ATTRIB_RELATIVE_OFFSET</constant>.</para>
<para><citerefentry><refentrytitle>glGetVertexAttrib</refentrytitle></citerefentry>
with argument <constant>GL_VERTEX_ATTRIB_RELATIVE_OFFSET</constant>.
</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>glVertexArrayAttribFormat</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='45']/*)"/>
</row>
<row>
<entry><function>glVertexArrayAttribIFormat</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='45']/*)"/>
</row>
<row>
<entry><function>glVertexArrayAttribLFormat</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='45']/*)"/>
</row>
<row>
<entry><function>glVertexAttribFormat</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='43']/*)"/>
</row>
<row>
<entry><function>glVertexAttribIFormat</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='43']/*)"/>
</row>
<row>
<entry><function>glVertexAttribLFormat</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='43']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glBindVertexBuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribBinding</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexBindingDivisor</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>.
</para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 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.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>
|
