upstream-man-pages/man4/glVertexBindingDivisor.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="glVertexBindingDivisor">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glVertexBindingDivisor</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glVertexBindingDivisor</refname>
  17         <refpurpose>modify the rate at which generic vertex attributes advance</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glVertexBindingDivisor</function></funcdef>
  23                 <paramdef>GLuint <parameter>bindingindex</parameter></paramdef>
  24                 <paramdef>GLuint <parameter>divisor</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>bindingindex</parameter></term>
  32             <listitem>
  33                 <para>
  34                     The index of the binding whose divisor to modify.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>divisor</parameter></term>
  40             <listitem>
  41                 <para>
  42                     The new value for the instance step rate to apply.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>glVertexBindingDivisor</function>, modifies the rate at which generic vertex attributes advance when
  51             rendering multiple instances of primitives in a single draw command. If
  52             <parameter>divisor</parameter> is zero, the attributes using the buffer bound to <parameter>bindingindex</parameter>
  53             advance once per vertex. If <parameter>divisor</parameter> is non-zero, the attributes advance
  54             once per <parameter>divisor</parameter> instances of the set(s) of vertices being rendered. An
  55             attribute is referred to as <emphasis>instanced</emphasis> if the corresponding <parameter>divisor</parameter>
  56             value is non-zero.
  57         </para>
  58     </refsect1>
  59     <refsect1 id="errors"><title>Errors</title>
  60         <para>
  61             <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>bindingindex</parameter> is greater than
  62             or equal to the value of <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>.
  63         </para>
  64         <para>
  65             <constant>GL_INVALID_OPERATION</constant> is generated if no vertex array object is bound.
  66         </para>
  67     </refsect1>
  68     <refsect1 id="associatedgets"><title>Associated Gets</title>
  69         <para>
  70             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with arguments <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>,
  71             <constant>GL_VERTEX_BINDING_DIVISOR</constant>.
  72         </para>
  73     </refsect1>
  74     <refsect1 id="seealso"><title>See Also</title>
  75         <para>
  76             <citerefentry><refentrytitle>glBindVertexBuffer</refentrytitle></citerefentry>,
  77             <citerefentry><refentrytitle>glVertexAttribBinding</refentrytitle></citerefentry>,
  78             <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>,
  79             <citerefentry><refentrytitle>glVertexBindingDivisor</refentrytitle></citerefentry>,
  80             <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>.
  81         </para>
  82     </refsect1>
  83     <refsect1 id="Copyright"><title>Copyright</title>
  84         <para>
  85             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
  86             This material may be distributed subject to the terms and conditions set forth in
  87             the Open Publication License, v 1.0, 8 June 1999.
  88             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  89         </para>
  90     </refsect1>
  91 </refentry>