upstream-man-pages/man3/glEnableVertexAttribArray.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="glEnableVertexAttribArray">
   5     <refmeta>
   6     <refentrytitle>glEnableVertexAttribArray</refentrytitle>
   7     <manvolnum>3G</manvolnum>
   8     </refmeta>
   9     <refnamediv>
  10     <refdescriptor>glEnableVertexAttribArray</refdescriptor>
  11     <refname>glEnableVertexAttribArray</refname>
  12     <refname>glDisableVertexAttribArray</refname>
  13     <refpurpose>Enable or disable a generic vertex attribute array</refpurpose>
  14     </refnamediv>
  15     <refsynopsisdiv><title>C Specification</title>
  16     <funcsynopsis>
  17         <funcprototype>
  18         <funcdef>void <function>glEnableVertexAttribArray</function></funcdef>
  19         <paramdef>GLuint <parameter>index</parameter></paramdef>
  20         </funcprototype>
  21         <funcprototype>
  22         <funcdef>void <function>glDisableVertexAttribArray</function></funcdef>
  23         <paramdef>GLuint <parameter>index</parameter></paramdef>
  24         </funcprototype>
  25     </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28     <variablelist>
  29         <varlistentry>
  30         <term><parameter>index</parameter></term>
  31         <listitem>
  32             <para>Specifies the index of the generic vertex
  33             attribute to be enabled or disabled.</para>
  34         </listitem>
  35         </varlistentry>
  36     </variablelist>
  37     </refsect1>
  38     <refsect1 id="description"><title>Description</title>
  39     <para><function>glEnableVertexAttribArray</function> enables the
  40     generic vertex attribute array specified by
  41     <parameter>index</parameter>.
  42     <function>glDisableVertexAttribArray</function> disables the
  43     generic vertex attribute array specified by
  44     <parameter>index</parameter>. By default, all client-side
  45     capabilities are disabled, including all generic vertex
  46     attribute arrays. If enabled, the values in the generic vertex
  47     attribute array will be accessed and used for rendering when
  48     calls are made to vertex array commands such as
  49     <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,
  50     <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
  51     <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>,
  52     <citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry>,
  53     or
  54     <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>.</para>
  55     </refsect1>
  56     <refsect1 id="errors"><title>Errors</title>
  57     <para><constant>GL_INVALID_VALUE</constant> is generated if
  58     <parameter>index</parameter> is greater than or equal to
  59     <constant>GL_MAX_VERTEX_ATTRIBS</constant>.</para>
  60
  61     </refsect1>
  62     <refsect1 id="associatedgets"><title>Associated Gets</title>
  63     <para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>
  64     with argument <constant>GL_MAX_VERTEX_ATTRIBS</constant></para>
  65
  66     <para><citerefentry><refentrytitle>glGetVertexAttrib</refentrytitle></citerefentry>
  67     with arguments <parameter>index</parameter> and
  68     <constant>GL_VERTEX_ATTRIB_ARRAY_ENABLED</constant>
  69     <parameter></parameter></para>
  70
  71     <para><citerefentry><refentrytitle>glGetVertexAttribPointerv</refentrytitle></citerefentry>
  72     with arguments <parameter>index</parameter> and
  73     <constant>GL_VERTEX_ATTRIB_ARRAY_POINTER</constant></para>
  74     </refsect1>
  75     <refsect1 id="seealso"><title>See Also</title>
  76     <para>
  77     <citerefentry><refentrytitle>glBindAttribLocation</refentrytitle></citerefentry>,
  78     <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,
  79     <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
  80     <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>,
  81     <citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry>,
  82     <citerefentry><refentrytitle>glVertexAttrib</refentrytitle></citerefentry>,
  83     <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>
  84     </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>