upstream-doc/man2/glGetVertexAttribPointerv.xml

   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>If a non-zero named buffer object was bound to the <constant>GL_ARRAY_BUFFER</constant> target
  57         (see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) when the desired pointer was previously
  58         specified, the <parameter>pointer</parameter> returned is a byte offset into the buffer object's data store.
  59         </para>
  60     </refsect1>
  61     <refsect1 id="notes"><title>Notes</title>
  62         <para><function>glGetVertexAttribPointerv</function>
  63         is available only if the GL version is 2.0 or greater.</para>
  64
  65         <para>The pointer returned is client-side state.</para>
  66
  67         <para>The initial value for each pointer is 0.</para>
  68     </refsect1>
  69     <refsect1 id="errors"><title>Errors</title>
  70         <para><constant>GL_INVALID_VALUE</constant>
  71         is generated if <parameter>index</parameter>
  72         is greater than or equal to <constant>GL_MAX_VERTEX_ATTRIBS</constant>.</para>
  73
  74         <para><constant>GL_INVALID_ENUM</constant>
  75         is generated if <parameter>pname</parameter>
  76         is not an accepted value.</para>
  77     </refsect1>
  78     <refsect1 id="associatedgets"><title>Associated Gets</title>
  79         <para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>
  80         with argument <constant>GL_MAX_VERTEX_ATTRIBS</constant></para>
  81     </refsect1>
  82     <refsect1 id="seealso"><title>See Also</title>
  83         <para><citerefentry><refentrytitle>glGetVertexAttrib</refentrytitle></citerefentry>,
  84         <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry></para>
  85     </refsect1>
  86     <refsect1 id="Copyright"><title>Copyright</title>
  87         <para>
  88             Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
  89             This material may be distributed subject to the terms and conditions set forth in
  90             the Open Publication License, v 1.0, 8 June 1999.
  91             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  92         </para>
  93     </refsect1>
  94 </refentry>