1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
2 <!-- saved from url=(0013)about:internet -->
3 <?xml-stylesheet type=
"text/xsl" href=
"mathml.xsl"?><html xmlns=
"http://www.w3.org/1999/xhtml" xmlns:
pref=
"http://www.w3.org/2002/Math/preference" pref:
renderer=
"mathplayer-dl"><head><meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" /><title>glVertexAttribPointer
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.73.2" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glVertexAttribPointer"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glVertexAttribPointer — define an array of generic vertex attribute data
</p></div><div class=
"refsynopsisdiv"><h2>C Specification
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glVertexAttribPointer
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">index
</var>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">size
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">type
</var>,
</td></tr><tr><td> </td><td>GLboolean
</td><td><var class=
"pdparam">normalized
</var>,
</td></tr><tr><td> </td><td>GLsizei
</td><td><var class=
"pdparam">stride
</var>,
</td></tr><tr><td> </td><td>const GLvoid *
</td><td><var class=
"pdparam">pointer
</var><code>)
</code>;
</td></tr></table></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"parameters"></a><h2>Parameters
</h2><div class=
"variablelist"><dl><dt><span class=
"term"><em class=
"parameter"><code>index
</code></em></span></dt><dd><p>Specifies the index of the generic vertex
4 attribute to be modified.
</p></dd><dt><span class=
"term"><em class=
"parameter"><code>size
</code></em></span></dt><dd><p>Specifies the number of components per
5 generic vertex attribute. Must
6 be
1,
2,
3, or
4. The initial value is
4.
</p></dd><dt><span class=
"term"><em class=
"parameter"><code>type
</code></em></span></dt><dd><p>Specifies the data type of each component in
7 the array. Symbolic constants
8 <code class=
"constant">GL_BYTE
</code>,
9 <code class=
"constant">GL_UNSIGNED_BYTE
</code>,
10 <code class=
"constant">GL_SHORT
</code>,
11 <code class=
"constant">GL_UNSIGNED_SHORT
</code>,
12 <code class=
"constant">GL_INT
</code>,
13 <code class=
"constant">GL_UNSIGNED_INT
</code>,
14 <code class=
"constant">GL_FLOAT
</code>, or
15 <code class=
"constant">GL_DOUBLE
</code> are
16 accepted. The initial value is
<code class=
"constant">GL_FLOAT
</code>.
</p></dd><dt><span class=
"term"><em class=
"parameter"><code>normalized
</code></em></span></dt><dd><p>Specifies whether fixed-point data values
17 should be normalized (
<code class=
"constant">GL_TRUE
</code>)
18 or converted directly as fixed-point values
19 (
<code class=
"constant">GL_FALSE
</code>) when they are
20 accessed.
</p></dd><dt><span class=
"term"><em class=
"parameter"><code>stride
</code></em></span></dt><dd><p>Specifies the byte offset between consecutive
21 generic vertex attributes. If
<em class=
"parameter"><code>stride
</code></em>
22 is
0, the generic vertex attributes are
23 understood to be tightly packed in the
24 array. The initial value is
0.
</p></dd><dt><span class=
"term"><em class=
"parameter"><code>pointer
</code></em></span></dt><dd><p>Specifies a pointer to the first component of
25 the first generic vertex attribute in the array. The initial value is
0.
</p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p><code class=
"function">glVertexAttribPointer
</code> specifies the
26 location and data format of the array of generic vertex attributes at index
<em class=
"parameter"><code>index
</code></em>
27 to use when rendering.
<em class=
"parameter"><code>size
</code></em>
28 specifies the number of components per attribute and must be
1,
29 2,
3, or
4.
<em class=
"parameter"><code>type
</code></em> specifies the data type
30 of each component, and
<em class=
"parameter"><code>stride
</code></em> specifies
31 the byte stride from one attribute to the next, allowing vertices and
32 attributes to be packed into a single array or
33 stored in separate arrays.
34 If set to
<code class=
"constant">GL_TRUE
</code>,
35 <em class=
"parameter"><code>normalized
</code></em> indicates that values stored
36 in an integer format are to be mapped to the range [-
1,
1] (for
37 signed values) or [
0,
1] (for unsigned values) when they are
38 accessed and converted to floating point. Otherwise, values will
39 be converted to floats directly without normalization.
</p><p>If a non-zero named buffer object is bound to the
<code class=
"constant">GL_ARRAY_BUFFER
</code> target
40 (see
<a class=
"citerefentry" href=
"glBindBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindBuffer
</span></span></a>) while a generic vertex attribute array is
41 specified,
<em class=
"parameter"><code>pointer
</code></em> is treated as a byte offset into the buffer object's data store.
42 Also, the buffer object binding (
<code class=
"constant">GL_ARRAY_BUFFER_BINDING
</code>) is saved as generic vertex attribute array
43 client-side state (
<code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING
</code>) for index
<em class=
"parameter"><code>index
</code></em>.
</p><p>When a generic vertex attribute array is specified,
44 <em class=
"parameter"><code>size
</code></em>,
<em class=
"parameter"><code>type
</code></em>,
45 <em class=
"parameter"><code>normalized
</code></em>,
46 <em class=
"parameter"><code>stride
</code></em>, and
47 <em class=
"parameter"><code>pointer
</code></em> are saved as client-side
48 state, in addition to the current vertex array buffer object binding.
</p><p>To enable and disable a generic vertex attribute array,
50 <a class=
"citerefentry" href=
"glEnableVertexAttribArray.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnableVertexAttribArray
</span></span></a>
52 <a class=
"citerefentry" href=
"glDisableVertexAttribArray.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDisableVertexAttribArray
</span></span></a>
53 with
<em class=
"parameter"><code>index
</code></em>. If enabled, the generic
54 vertex attribute array is used when
55 <a class=
"citerefentry" href=
"glArrayElement.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glArrayElement
</span></span></a>,
56 <a class=
"citerefentry" href=
"glDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawArrays
</span></span></a>,
57 <a class=
"citerefentry" href=
"glMultiDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawArrays
</span></span></a>,
58 <a class=
"citerefentry" href=
"glDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawElements
</span></span></a>,
59 <a class=
"citerefentry" href=
"glMultiDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawElements
</span></span></a>, or
60 <a class=
"citerefentry" href=
"glDrawRangeElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawRangeElements
</span></span></a>
61 is called.
</p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p><code class=
"function">glVertexAttribPointer
</code> is available
62 only if the GL version is
2.0 or greater.
</p><p>Each generic vertex attribute array is initially disabled
63 and isn't accessed when
64 <a class=
"citerefentry" href=
"glArrayElement.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glArrayElement
</span></span></a>,
<a class=
"citerefentry" href=
"glDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawElements
</span></span></a>,
<a class=
"citerefentry" href=
"glDrawRangeElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawRangeElements
</span></span></a>,
65 <a class=
"citerefentry" href=
"glDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawArrays
</span></span></a>,
<a class=
"citerefentry" href=
"glMultiDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawArrays
</span></span></a>, or
<a class=
"citerefentry" href=
"glMultiDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawElements
</span></span></a>
66 is called.
</p><p>Execution of
<code class=
"function">glVertexAttribPointer
</code> is
67 not allowed between the execution of
68 <a class=
"citerefentry" href=
"glBegin.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBegin
</span></span></a>
69 and the corresponding execution of
70 <a class=
"citerefentry" href=
"glEnd.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnd
</span></span></a>,
71 but an error may or may not be generated. If no error is
72 generated, the operation is undefined.
</p><p><code class=
"function">glVertexAttribPointer
</code> is typically
73 implemented on the client side.
</p><p>Generic vertex attribute array parameters are client-side
74 state and are therefore not saved or restored by
75 <a class=
"citerefentry" href=
"glPushAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPushAttrib
</span></span></a>
77 <a class=
"citerefentry" href=
"glPopAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPopAttrib
</span></span></a>.
79 <a class=
"citerefentry" href=
"glPushClientAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPushClientAttrib
</span></span></a>
81 <a class=
"citerefentry" href=
"glPopClientAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPopClientAttrib
</span></span></a>
82 instead.
</p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p><code class=
"constant">GL_INVALID_VALUE
</code> is generated if
83 <em class=
"parameter"><code>index
</code></em> is greater than or equal to
84 <code class=
"constant">GL_MAX_VERTEX_ATTRIBS
</code>.
</p><p><code class=
"constant">GL_INVALID_VALUE
</code> is generated if
85 <em class=
"parameter"><code>size
</code></em> is not
1,
2,
3, or
4.
</p><p><code class=
"constant">GL_INVALID_ENUM
</code> is generated if
86 <em class=
"parameter"><code>type
</code></em> is not an accepted value.
</p><p><code class=
"constant">GL_INVALID_VALUE
</code> is generated if
87 <em class=
"parameter"><code>stride
</code></em> is negative.
</p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p><a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a>
88 with argument
<code class=
"constant">GL_MAX_VERTEX_ATTRIBS
</code></p><p><a class=
"citerefentry" href=
"glGetVertexAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetVertexAttrib
</span></span></a>
89 with arguments
<em class=
"parameter"><code>index
</code></em> and
<code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_ENABLED
</code></p><p><a class=
"citerefentry" href=
"glGetVertexAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetVertexAttrib
</span></span></a>
90 with arguments
<em class=
"parameter"><code>index
</code></em> and
<code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_SIZE
</code></p><p><a class=
"citerefentry" href=
"glGetVertexAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetVertexAttrib
</span></span></a>
91 with arguments
<em class=
"parameter"><code>index
</code></em> and
<code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_TYPE
</code></p><p><a class=
"citerefentry" href=
"glGetVertexAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetVertexAttrib
</span></span></a>
92 with arguments
<em class=
"parameter"><code>index
</code></em> and
<code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_NORMALIZED
</code></p><p><a class=
"citerefentry" href=
"glGetVertexAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetVertexAttrib
</span></span></a>
93 with arguments
<em class=
"parameter"><code>index
</code></em> and
<code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_STRIDE
</code></p><p><a class=
"citerefentry" href=
"glGetVertexAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetVertexAttrib
</span></span></a>
94 with arguments
<em class=
"parameter"><code>index
</code></em> and
<code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING
</code></p><p><a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
95 <code class=
"constant">GL_ARRAY_BUFFER_BINDING
</code></p><p><a class=
"citerefentry" href=
"glGetVertexAttribPointerv.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetVertexAttribPointerv
</span></span></a>
96 with arguments
<em class=
"parameter"><code>index
</code></em> and
97 <code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_POINTER
</code></p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p><a class=
"citerefentry" href=
"glArrayElement.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glArrayElement
</span></span></a>,
98 <a class=
"citerefentry" href=
"glBindAttribLocation.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindAttribLocation
</span></span></a>,
99 <a class=
"citerefentry" href=
"glBindBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindBuffer
</span></span></a>,
100 <a class=
"citerefentry" href=
"glColorPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glColorPointer
</span></span></a>,
101 <a class=
"citerefentry" href=
"glDisableVertexAttribArray.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDisableVertexAttribArray
</span></span></a>,
102 <a class=
"citerefentry" href=
"glDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawArrays
</span></span></a>,
103 <a class=
"citerefentry" href=
"glDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawElements
</span></span></a>,
104 <a class=
"citerefentry" href=
"glDrawRangeElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDrawRangeElements
</span></span></a>,
105 <a class=
"citerefentry" href=
"glEnableVertexAttribArray.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnableVertexAttribArray
</span></span></a>,
106 <a class=
"citerefentry" href=
"glEdgeFlagPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEdgeFlagPointer
</span></span></a>,
107 <a class=
"citerefentry" href=
"glFogCoordPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glFogCoordPointer
</span></span></a>,
108 <a class=
"citerefentry" href=
"glIndexPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIndexPointer
</span></span></a>,
109 <a class=
"citerefentry" href=
"glInterleavedArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glInterleavedArrays
</span></span></a>,
110 <a class=
"citerefentry" href=
"glMultiDrawArrays.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawArrays
</span></span></a>,
111 <a class=
"citerefentry" href=
"glMultiDrawElements.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMultiDrawElements
</span></span></a>,
112 <a class=
"citerefentry" href=
"glNormalPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glNormalPointer
</span></span></a>,
113 <a class=
"citerefentry" href=
"glPopClientAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPopClientAttrib
</span></span></a>,
114 <a class=
"citerefentry" href=
"glPushClientAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPushClientAttrib
</span></span></a>,
115 <a class=
"citerefentry" href=
"glSecondaryColorPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glSecondaryColorPointer
</span></span></a>,
116 <a class=
"citerefentry" href=
"glTexCoordPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexCoordPointer
</span></span></a>,
117 <a class=
"citerefentry" href=
"glVertexAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glVertexAttrib
</span></span></a>,
118 <a class=
"citerefentry" href=
"glVertexPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glVertexPointer
</span></span></a>
119 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
120 Copyright
<span class=
"trademark"></span>©
2003-
2005 3Dlabs Inc. Ltd.
121 This material may be distributed subject to the terms and conditions set forth in
122 the Open Publication License, v
1.0,
8 June
1999.
123 <a class=
"ulink" href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
124 </p></div></div></body></html>