Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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="glGetVertexAttribPointerv"> | |
5 | <refmeta> | |
6 | <refentrytitle>glGetVertexAttribPointerv</refentrytitle> | |
7 | <manvolnum>3G</manvolnum> | |
8 | </refmeta> | |
9 | <refnamediv> | |
10 | <refname>glGetVertexAttribPointerv</refname> | |
11 | <refpurpose>return the address of the specified generic vertex attribute pointer</refpurpose> | |
12 | </refnamediv> | |
13 | <refsynopsisdiv><title>C Specification</title> | |
14 | <funcsynopsis> | |
15 | <funcprototype> | |
16 | <funcdef>void <function>glGetVertexAttribPointerv</function></funcdef> | |
17 | <paramdef>GLuint <parameter>index</parameter></paramdef> | |
18 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
19 | <paramdef>GLvoid **<parameter>pointer</parameter></paramdef> | |
20 | </funcprototype> | |
21 | </funcsynopsis> | |
22 | </refsynopsisdiv> | |
23 | <refsect1 id="parameters"><title>Parameters</title> | |
24 | <variablelist> | |
25 | <varlistentry> | |
26 | <term><parameter>index</parameter></term> | |
27 | <listitem> | |
28 | <para>Specifies the generic vertex attribute | |
29 | parameter to be returned.</para> | |
30 | </listitem> | |
31 | </varlistentry> | |
32 | <varlistentry> | |
33 | <term><parameter>pname</parameter></term> | |
34 | <listitem> | |
35 | <para>Specifies the symbolic name of the generic | |
36 | vertex attribute parameter to be returned. Must be | |
37 | <constant>GL_VERTEX_ATTRIB_ARRAY_POINTER</constant>.</para> | |
38 | </listitem> | |
39 | </varlistentry> | |
40 | <varlistentry> | |
41 | <term><parameter>pointer</parameter></term> | |
42 | <listitem> | |
43 | <para>Returns the pointer value.</para> | |
44 | </listitem> | |
45 | </varlistentry> | |
46 | </variablelist> | |
47 | </refsect1> | |
48 | <refsect1 id="description"><title>Description</title> | |
49 | <para><function>glGetVertexAttribPointerv</function> returns | |
50 | pointer information. <parameter>index</parameter> is the generic | |
51 | vertex attribute to be queried, <parameter>pname</parameter> is | |
52 | a symbolic constant indicating the pointer to be returned, and | |
53 | <parameter>params</parameter> is a pointer to a location in | |
54 | which to place the returned data.</para> | |
55 | ||
56 | <para>The <parameter>pointer</parameter> returned is a byte offset into the data store of the buffer object | |
57 | that was bound to the <constant>GL_ARRAY_BUFFER</constant> target | |
58 | (see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) when the desired pointer was previously specified. | |
59 | </para> | |
60 | </refsect1> | |
61 | <refsect1 id="notes"><title>Notes</title> | |
62 | <para>The state returned is retrieved from the currently bound vertex array object.</para> | |
63 | <para>The initial value for each pointer is 0.</para> | |
64 | </refsect1> | |
65 | <refsect1 id="errors"><title>Errors</title> | |
66 | <para><constant>GL_INVALID_OPERATION</constant> is generated if no vertex array object is currently bound.</para> | |
67 | ||
68 | <para><constant>GL_INVALID_VALUE</constant> | |
69 | is generated if <parameter>index</parameter> | |
70 | is greater than or equal to <constant>GL_MAX_VERTEX_ATTRIBS</constant>.</para> | |
71 | ||
72 | <para><constant>GL_INVALID_ENUM</constant> | |
73 | is generated if <parameter>pname</parameter> | |
74 | is not an accepted value.</para> | |
75 | </refsect1> | |
76 | <refsect1 id="associatedgets"><title>Associated Gets</title> | |
77 | <para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> | |
78 | with argument <constant>GL_MAX_VERTEX_ATTRIBS</constant></para> | |
79 | </refsect1> | |
80 | <refsect1 id="seealso"><title>See Also</title> | |
81 | <para><citerefentry><refentrytitle>glGetVertexAttrib</refentrytitle></citerefentry>, | |
82 | <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry></para> | |
83 | </refsect1> | |
84 | <refsect1 id="Copyright"><title>Copyright</title> | |
85 | <para> | |
86 | Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd. | |
87 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. | |
88 | This material may be distributed subject to the terms and conditions set forth in | |
89 | the Open Publication License, v 1.0, 8 June 1999. | |
90 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>. | |
91 | </para> | |
92 | </refsect1> | |
93 | </refentry> |