rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glVertexAttribBinding.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="glVertexAttribBinding">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glVertexAttribBinding</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glVertexAttribBinding</refname>\r
        <refpurpose>associate a vertex attribute and a vertex buffer binding</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glVertexAttribBinding</function></funcdef>\r
                <paramdef>GLuint <parameter>attribindex</parameter></paramdef>\r
                <paramdef>GLuint <parameter>bindingindex</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>attribindex</parameter></term>\r
            <listitem>\r
                <para>\r
                    The index of the attribute to associate with a vertex buffer binding.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>bindingindex</parameter></term>\r
            <listitem>\r
                <para>\r
                    The index of the vertex buffer binding with which to associate the generic vertex attribute.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glVertexAttribBinding</function>, establishes an association between the generic vertex\r
            attribute whose index is given by <parameter>attribindex</parameter> and a vertex buffer binding\r
            whose index is given by <parameter>bindingindex</parameter>. <parameter>attribindex</parameter>\r
            must be less than the value of <constant>GL_MAX_VERTEX_ATTRIBS</constant> and <parameter>bindingindex</parameter>\r
            must be less than the value of <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>attribindex</parameter> is greater than\r
            or equal to the value of <constant>GL_MAX_VERTEX_ATTRIBS</constant>.\r
        </para>\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>glVertexAttribFormat</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