upstream-doc/man4/glVertexAttribBinding.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="glVertexAttribBinding">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glVertexAttribBinding</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glVertexAttribBinding</refname>
  17         <refpurpose>associate a vertex attribute and a vertex buffer binding</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glVertexAttribBinding</function></funcdef>
  23                 <paramdef>GLuint <parameter>attribindex</parameter></paramdef>
  24                 <paramdef>GLuint <parameter>bindingindex</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>attribindex</parameter></term>
  32             <listitem>
  33                 <para>
  34                     The index of the attribute to associate with a vertex buffer binding.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>bindingindex</parameter></term>
  40             <listitem>
  41                 <para>
  42                     The index of the vertex buffer binding with which to associate the generic vertex attribute.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>glVertexAttribBinding</function>, establishes an association between the generic vertex
  51             attribute whose index is given by <parameter>attribindex</parameter> and a vertex buffer binding
  52             whose index is given by <parameter>bindingindex</parameter>. <parameter>attribindex</parameter>
  53             must be less than the value of <constant>GL_MAX_VERTEX_ATTRIBS</constant> and <parameter>bindingindex</parameter>
  54             must be less than the value of <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>.
  55         </para>
  56     </refsect1>
  57     <refsect1 id="errors"><title>Errors</title>
  58         <para>
  59             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>attribindex</parameter> is greater than
  60             or equal to the value of <constant>GL_MAX_VERTEX_ATTRIBS</constant>.
  61         </para>
  62         <para>
  63             <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>bindingindex</parameter> is greater than
  64             or equal to the value of <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>.
  65         </para>
  66         <para>
  67             <constant>GL_INVALID_OPERATION</constant> is generated if no vertex array object is bound.
  68         </para>
  69     </refsect1>
  70     <refsect1 id="associatedgets"><title>Associated Gets</title>
  71         <para>
  72             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with arguments <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>,
  73             <constant>GL_VERTEX_BINDING_DIVISOR</constant>.
  74         </para>
  75     </refsect1>
  76     <refsect1 id="seealso"><title>See Also</title>
  77         <para>
  78             <citerefentry><refentrytitle>glBindVertexBuffer</refentrytitle></citerefentry>,
  79             <citerefentry><refentrytitle>glVertexAttribFormat</refentrytitle></citerefentry>,
  80             <citerefentry><refentrytitle>glVertexBindingDivisor</refentrytitle></citerefentry>,
  81             <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>.
  82         </para>
  83     </refsect1>
  84     <refsect1 id="Copyright"><title>Copyright</title>
  85         <para>
  86             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
  87             This material may be distributed subject to the terms and conditions set forth in
  88             the Open Publication License, v 1.0, 8 June 1999.
  89             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  90         </para>
  91     </refsect1>
  92 </refentry>