Blame |
Last modification |
View Log
| RSS feed
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glGetVertexAttribPointerv">
<refmeta>
<refentrytitle>glGetVertexAttribPointerv</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glGetVertexAttribPointerv</refname>
<refpurpose>return the address of the specified generic vertex attribute pointer</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glGetVertexAttribPointerv</function></funcdef>
<paramdef>GLuint <parameter>index</parameter></paramdef>
<paramdef>GLenum <parameter>pname</parameter></paramdef>
<paramdef>GLvoid **<parameter>pointer</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>Specifies the generic vertex attribute
parameter to be returned.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pname</parameter></term>
<listitem>
<para>Specifies the symbolic name of the generic
vertex attribute parameter to be returned. Must be
<constant>GL_VERTEX_ATTRIB_ARRAY_POINTER</constant>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pointer</parameter></term>
<listitem>
<para>Returns the pointer value.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para><function>glGetVertexAttribPointerv</function> returns
pointer information. <parameter>index</parameter> is the generic
vertex attribute to be queried, <parameter>pname</parameter> is
a symbolic constant indicating the pointer to be returned, and
<parameter>params</parameter> is a pointer to a location in
which to place the returned data.</para>
<para>If a non-zero named buffer object was bound to the <constant>GL_ARRAY_BUFFER</constant> target
(see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) when the desired pointer was previously
specified, the <parameter>pointer</parameter> returned is a byte offset into the buffer object's data store.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para><function>glGetVertexAttribPointerv</function>
is available only if the GL version is 2.0 or greater.</para>
<para>The pointer returned is client-side state.</para>
<para>The initial value for each pointer is 0.</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para><constant>GL_INVALID_VALUE</constant>
is generated if <parameter>index</parameter>
is greater than or equal to <constant>GL_MAX_VERTEX_ATTRIBS</constant>.</para>
<para><constant>GL_INVALID_ENUM</constant>
is generated if <parameter>pname</parameter>
is not an accepted value.</para>
</refsect1>
<refsect1 id="associatedgets"><title>Associated Gets</title>
<para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>
with argument <constant>GL_MAX_VERTEX_ATTRIBS</constant></para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para><citerefentry><refentrytitle>glGetVertexAttrib</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry></para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
</para>
</refsect1>
</refentry>