rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glVertexBindingDivisor.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
<refentry id="glVertexBindingDivisor">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glVertexBindingDivisor</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glVertexBindingDivisor</refname>\r
        <refpurpose>modify the rate at which generic vertex attributes advance</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glVertexBindingDivisor</function></funcdef>\r
                <paramdef>GLuint <parameter>bindingindex</parameter></paramdef>\r
                <paramdef>GLuint <parameter>divisor</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>bindingindex</parameter></term>\r
            <listitem>\r
                <para>\r
                    The index of the binding whose divisor to modify.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>divisor</parameter></term>\r
            <listitem>\r
                <para>\r
                    The new value for the instance step rate to apply.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glVertexBindingDivisor</function>, modifies the rate at which generic vertex attributes advance when\r
            rendering multiple instances of primitives in a single draw command. If\r
            <parameter>divisor</parameter> is zero, the attributes using the buffer bound to <parameter>bindingindex</parameter>\r
            advance once per vertex. If <parameter>divisor</parameter> is non-zero, the attributes advance\r
            once per <parameter>divisor</parameter> instances of the set(s) of vertices being rendered. An\r
            attribute is referred to as <emphasis>instanced</emphasis> if the corresponding <parameter>divisor</parameter>\r
            value is non-zero.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVAILD_VALUE</constant> is generated if <parameter>bindingindex</parameter> is greater than\r
            or equal to the value of <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if no vertex array object is bound.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="associatedgets"><title>Associated Gets</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with arguments <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>,\r
            <constant>GL_VERTEX_BINDING_DIVISOR</constant>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glBindVertexBuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glVertexAttribBinding</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glVertexBindingDivisor</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
            This material may be distributed subject to the terms and conditions set forth in \r
            the Open Publication License, v 1.0, 8 June 1999.\r
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
        </para>\r
    </refsect1>\r
</refentry>\r