Opentk/Source/Bind/Specifications/Docs/glVertexBindingDivisor.xml
2013-12-15 22:32:32 +01:00

92 lines
4.2 KiB
XML

<?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="glVertexBindingDivisor">
<refentryinfo>
<copyright>
<year>2013</year>
<holder>Khronos Group</holder>
</copyright>
</refentryinfo>
<refmeta>
<refentrytitle>glVertexBindingDivisor</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glVertexBindingDivisor</refname>
<refpurpose>modify the rate at which generic vertex attributes advance</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glVertexBindingDivisor</function></funcdef>
<paramdef>GLuint <parameter>bindingindex</parameter></paramdef>
<paramdef>GLuint <parameter>divisor</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>bindingindex</parameter></term>
<listitem>
<para>
The index of the binding whose divisor to modify.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>divisor</parameter></term>
<listitem>
<para>
The new value for the instance step rate to apply.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glVertexBindingDivisor</function>, modifies the rate at which generic vertex attributes advance when
rendering multiple instances of primitives in a single draw command. If
<parameter>divisor</parameter> is zero, the attributes using the buffer bound to <parameter>bindingindex</parameter>
advance once per vertex. If <parameter>divisor</parameter> is non-zero, the attributes advance
once per <parameter>divisor</parameter> instances of the set(s) of vertices being rendered. An
attribute is referred to as <emphasis>instanced</emphasis> if the corresponding <parameter>divisor</parameter>
value is non-zero.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVAILD_VALUE</constant> is generated if <parameter>bindingindex</parameter> is greater than
or equal to the value of <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if no vertex array object is bound.
</para>
</refsect1>
<refsect1 id="associatedgets"><title>Associated Gets</title>
<para>
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with arguments <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>,
<constant>GL_VERTEX_BINDING_DIVISOR</constant>.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glBindVertexBuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribBinding</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexBindingDivisor</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>.
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2013 Khronos Group.
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>