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>glGetVertexAttrib
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.73.2" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glGetVertexAttrib"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetVertexAttrib — Return a generic vertex attribute parameter
</p></div><div class=
"refsynopsisdiv"><h2>C Specification
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0" style=
"padding-bottom: 1em"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetVertexAttribdv
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">index
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLdouble *
</td><td><var class=
"pdparam">params
</var><code>)
</code>;
</td></tr></table><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0" style=
"padding-bottom: 1em"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetVertexAttribfv
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">index
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLfloat *
</td><td><var class=
"pdparam">params
</var><code>)
</code>;
</td></tr></table><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetVertexAttribiv
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">index
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLint *
</td><td><var class=
"pdparam">params
</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 generic vertex attribute
4 parameter to be queried.
</p></dd><dt><span class=
"term"><em class=
"parameter"><code>pname
</code></em></span></dt><dd><p>Specifies the symbolic name of the vertex
5 attribute parameter to be queried. Accepted values are
6 <code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING
</code>,
7 <code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_ENABLED
</code>,
8 <code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_SIZE
</code>,
9 <code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_STRIDE
</code>,
10 <code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_TYPE
</code>,
11 <code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_NORMALIZED
</code>, or
12 <code class=
"constant">GL_CURRENT_VERTEX_ATTRIB
</code>.
</p></dd><dt><span class=
"term"><em class=
"parameter"><code>params
</code></em></span></dt><dd><p>Returns the requested data.
</p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p><code class=
"function">glGetVertexAttrib
</code> returns in
13 <em class=
"parameter"><code>params
</code></em> the value of a generic vertex
14 attribute parameter. The generic vertex attribute to be queried
15 is specified by
<em class=
"parameter"><code>index
</code></em>, and the parameter
16 to be queried is specified by
<em class=
"parameter"><code>pname
</code></em>.
</p><p>The accepted parameter names are as follows:
</p><div class=
"variablelist"><dl><dt><span class=
"term"><code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING
</code></span></dt><dd><p>
17 </p><p> <em class=
"parameter"><code>params
</code></em> returns a
18 single value, the name of the buffer object currently bound to
19 the binding point corresponding to generic vertex attribute array
20 <em class=
"parameter"><code>index
</code></em>. If no buffer object is bound,
21 0 is returned. The initial value is
0.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_ENABLED
</code></span></dt><dd><p>
22 </p><p> <em class=
"parameter"><code>params
</code></em> returns a
23 single value that is non-zero (true) if the vertex
24 attribute array for
<em class=
"parameter"><code>index
</code></em> is
25 enabled and
0 (false) if it is disabled. The initial
26 value is
<code class=
"constant">GL_FALSE
</code>.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_SIZE
</code></span></dt><dd><p>
27 </p><p> <em class=
"parameter"><code>params
</code></em> returns a
28 single value, the size of the vertex attribute array
29 for
<em class=
"parameter"><code>index
</code></em>. The size is the
30 number of values for each element of the vertex
31 attribute array, and it will be
1,
2,
3, or
4. The
32 initial value is
4.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_STRIDE
</code></span></dt><dd><p>
33 </p><p> <em class=
"parameter"><code>params
</code></em> returns a
34 single value, the array stride for (number of bytes
35 between successive elements in) the vertex attribute
36 array for
<em class=
"parameter"><code>index
</code></em>. A value of
0
37 indicates that the array elements are stored
38 sequentially in memory. The initial value is
0.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_TYPE
</code></span></dt><dd><p>
39 </p><p> <em class=
"parameter"><code>params
</code></em> returns a
40 single value, a symbolic constant indicating the
41 array type for the vertex attribute array for
42 <em class=
"parameter"><code>index
</code></em>. Possible values are
43 <code class=
"constant">GL_BYTE
</code>,
44 <code class=
"constant">GL_UNSIGNED_BYTE
</code>,
45 <code class=
"constant">GL_SHORT
</code>,
46 <code class=
"constant">GL_UNSIGNED_SHORT
</code>,
47 <code class=
"constant">GL_INT
</code>,
48 <code class=
"constant">GL_UNSIGNED_INT
</code>,
49 <code class=
"constant">GL_FLOAT
</code>, and
50 <code class=
"constant">GL_DOUBLE
</code>. The initial value is
51 <code class=
"constant">GL_FLOAT
</code>.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_VERTEX_ATTRIB_ARRAY_NORMALIZED
</code></span></dt><dd><p>
52 </p><p> <em class=
"parameter"><code>params
</code></em> returns a
53 single value that is non-zero (true) if fixed-point
54 data types for the vertex attribute array indicated
55 by
<em class=
"parameter"><code>index
</code></em> are normalized when
56 they are converted to floating point, and
0 (false)
57 otherwise. The initial value is
58 <code class=
"constant">GL_FALSE
</code>.
</p></dd><dt><span class=
"term"><code class=
"constant">GL_CURRENT_VERTEX_ATTRIB
</code></span></dt><dd><p>
59 </p><p> <em class=
"parameter"><code>params
</code></em> returns four
60 values that represent the current value for the
61 generic vertex attribute specified by index. Generic
62 vertex attribute
0 is unique in that it has no
63 current state, so an error will be generated if
64 <em class=
"parameter"><code>index
</code></em> is
0. The initial value
65 for all other generic vertex attributes is
66 (
0,
0,
0,
1).
</p></dd></dl></div><p>All of the parameters except
<code class=
"constant">GL_CURRENT_VERTEX_ATTRIB
</code>
67 represent client-side state.
</p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p><code class=
"function">glGetVertexAttrib
</code> is available only
68 if the GL version is
2.0 or greater.
</p><p>If an error is generated, no change is made to the
69 contents of
<em class=
"parameter"><code>params
</code></em>.
</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
70 <em class=
"parameter"><code>index
</code></em> is greater than or equal to
71 <code class=
"constant">GL_MAX_VERTEX_ATTRIBS
</code>.
</p><p><code class=
"constant">GL_INVALID_ENUM
</code> is generated if
72 <em class=
"parameter"><code>pname
</code></em> is not an accepted value.
</p><p><code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
73 <em class=
"parameter"><code>index
</code></em> is
0 and
74 <em class=
"parameter"><code>pname
</code></em> is
75 <code class=
"constant">GL_CURRENT_VERTEX_ATTRIB
</code>.
</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>
76 with argument
<code class=
"constant">GL_MAX_VERTEX_ATTRIBS
</code></p><p><a class=
"citerefentry" href=
"glGetVertexAttribPointerv.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetVertexAttribPointerv
</span></span></a>
77 with arguments
<em class=
"parameter"><code>index
</code></em> and
78 <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=
"glBindAttribLocation.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindAttribLocation
</span></span></a>,
79 <a class=
"citerefentry" href=
"glBindBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindBuffer
</span></span></a>,
80 <a class=
"citerefentry" href=
"glDisableVertexAttribArray.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDisableVertexAttribArray
</span></span></a>,
81 <a class=
"citerefentry" href=
"glEnableVertexAttribArray.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnableVertexAttribArray
</span></span></a>,
82 <a class=
"citerefentry" href=
"glVertexAttrib.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glVertexAttrib
</span></span></a>,
83 <a class=
"citerefentry" href=
"glVertexAttribPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glVertexAttribPointer
</span></span></a></p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
84 Copyright
<span class=
"trademark"></span>©
2003-
2005 3Dlabs Inc. Ltd.
85 This material may be distributed subject to the terms and conditions set forth in
86 the Open Publication License, v
1.0,
8 June
1999.
87 <a class=
"ulink" href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
88 </p></div></div></body></html>
HCoop / clinton / guile-figl.git / blob