rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glUniformBlockBinding.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="glUniformBlockBinding">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glUniformBlockBinding</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glUniformBlockBinding</refname>\r
        <refpurpose>assign a binding point to an active uniform block</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glUniformBlockBinding</function></funcdef>\r
                <paramdef>GLuint <parameter>program</parameter></paramdef>\r
                <paramdef>GLuint <parameter>uniformBlockIndex</parameter></paramdef>\r
                <paramdef>GLuint <parameter>uniformBlockBinding</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>program</parameter></term>\r
            <listitem>\r
                <para>\r
                    The name of a program object containing the active uniform block whose binding to assign.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>uniformBlockIndex</parameter></term>\r
            <listitem>\r
                <para>\r
                    The index of the active uniform block within <parameter>program</parameter> whose binding to assign.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>uniformBlockBinding</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the binding point to which to bind the uniform block with index <parameter>uniformBlockIndex</parameter> within <parameter>program</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            Binding points for active uniform blocks are assigned using <function>glUniformBlockBinding</function>. Each of a program's active uniform\r
            blocks has a corresponding uniform buffer binding point. <parameter>program</parameter> is the name of a program object for which the command\r
            <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry> has been issued in the past.\r
        </para>\r
        <para>\r
            If successful, <function>glUniformBlockBinding</function> specifies that <parameter>program</parameter> will use the data store of the\r
            buffer object bound to the binding point <parameter>uniformBlockBinding</parameter> to extract the values of the uniforms in the\r
            uniform block identified by <parameter>uniformBlockIndex</parameter>.\r
        </para>\r
        <para>\r
            When a program object is linked or re-linked, the uniform buffer object binding point assigned to each of its active uniform blocks is reset to zero.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>uniformBlockIndex</parameter> is not an active uniform block index of <parameter>program</parameter>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>uniformBlockBinding</parameter> is greater than or equal to the value of <constant>GL_MAX_UNIFORM_BUFFER_BINDINGS</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated <parameter>program</parameter> is not the name of a program object generated by the GL.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="notes"><title>Notes</title>\r
        <para>\r
            <function>glUniformBlockBinding</function> is available only if the GL version is 3.1 or greater.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="associatedgets"><title>Associated Gets</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGetActiveUniformBlock</refentrytitle></citerefentry> with argument <constant>GL_UNIFORM_BLOCK_BINDING</constant>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBindBufferBase</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGetActiveUniformBlock</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2010 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