rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glGetUniformBlockIndex.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="glGetUniformBlockIndex">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glGetUniformBlockIndex</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glGetUniformBlockIndex</refname>\r
        <refpurpose>retrieve the index of a named uniform block</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>GLuint <function>glGetUniformBlockIndex</function></funcdef>\r
                <paramdef>GLuint <parameter>program</parameter></paramdef>\r
                <paramdef>const GLchar *<parameter>uniformBlockName</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
                    Specifies the name of a program containing the uniform block.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>uniformBlockName</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the address an array of characters to containing the name of the uniform block whose index to retrieve.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glGetUniformBlockIndex</function> retrieves the index of a uniform block within <parameter>program</parameter>.\r
        </para>\r
        <para>\r
            <parameter>program</parameter> must be the name of a program object for which the command\r
            <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry> must have been called in the past, although it is not required that\r
            <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry> must have succeeded. The link could have failed because the number\r
            of active uniforms exceeded the limit.\r
        </para>\r
        <para>\r
            <parameter>uniformBlockName</parameter> must contain a nul-terminated string specifying the name of the uniform block.\r
        </para>\r
        <para>\r
            <function>glGetUniformBlockIndex</function> returns the uniform block index for the uniform block named <parameter>uniformBlockName</parameter>\r
            of <parameter>program</parameter>. If <parameter>uniformBlockName</parameter> does not identify an active uniform block of <parameter>program</parameter>,\r
            <function>glGetUniformBlockIndex</function> returns the special identifier, <constant>GL_INVALID_INDEX</constant>. Indices of the active uniform\r
            blocks of a program are assigned in consecutive order, beginning with zero.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>program</parameter> is not the name of a program object for which\r
            <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry> has been called in the past.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="notes"><title>Notes</title>\r
        <para>\r
            <function>glGetUniformBlockIndex</function> is available only if the GL version is 3.1 or greater.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGetActiveUniformBlockName</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGetActiveUniformBlock</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\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