rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glGetUniformIndices.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="glGetUniformIndices">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glGetUniformIndices</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glGetUniformIndices</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>glGetUniformIndices</function></funcdef>\r
                <paramdef>GLuint <parameter>program</parameter></paramdef>\r
                <paramdef>GLsizei <parameter>uniformCount</parameter></paramdef>\r
                <paramdef>const GLchar **<parameter>uniformNames</parameter></paramdef>\r
                <paramdef>GLuint *<parameter>uniformIndices</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 uniforms whose indices to query.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>uniformCount</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the number of uniforms whose indices to query.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>uniformNames</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the address of an array of pointers to buffers containing the names of the queried uniforms.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>uniformIndices</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the address of an array that will receive the indices of the uniforms.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glGetUniformIndices</function> retrieves the indices of a number of uniforms 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>uniformCount</parameter> indicates both the number of elements in the array of names <parameter>uniformNames</parameter> and the\r
            number of indices that may be written to <parameter>uniformIndices</parameter>.\r
        </para>\r
        <para>\r
            <parameter>uniformNames</parameter> contains a list of <parameter>uniformCount</parameter> name strings identifying the uniform names to be\r
            queried for indices. For each name string in <parameter>uniformNames</parameter>, the index assigned to the active uniform of that name will\r
            be written to the corresponding element of <parameter>uniformIndices</parameter>. If a string in <parameter>uniformNames</parameter> is not\r
            the name of an active uniform, the special value <constant>GL_INVALID_INDEX</constant> will be written to the corresponding element of\r
            <parameter>uniformIndices</parameter>.\r
        </para>\r
        <para>\r
            If an error occurs, nothing is written to <parameter>uniformIndices</parameter>.\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>glGetUniformIndices</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>glGetActiveUniform</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGetActiveUniformName</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