rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glBindSampler.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="glBindSampler">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glBindSampler</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glBindSampler</refname>\r
        <refpurpose>bind a named sampler to a texturing target</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glBindSampler</function></funcdef>\r
                <paramdef>GLuint <parameter>unit</parameter></paramdef>\r
                <paramdef>GLuint <parameter>sampler</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>unit</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the index of the texture unit to which the sampler is bound.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>sampler</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the name of a sampler.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glBindSampler</function> binds <parameter>sampler</parameter> to the texture unit at index <parameter>unit</parameter>.\r
            <parameter>sampler</parameter> must be zero or the name of a sampler object previously returned from a call to\r
            <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>. <parameter>unit</parameter> must be less than the value\r
            of <constant>GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS</constant>.\r
        </para>\r
        <para>\r
            When a sampler object is bound to a texture unit, its state supersedes that of\r
            the texture object bound to that texture unit. If the sampler name zero is bound to\r
            a texture unit, the currently bound texture's sampler state becomes active. A single\r
            sampler object may be bound to multiple texture units simultaneously.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="notes"><title>Notes</title>\r
        <para>\r
            <function>glBindSampler</function> is available only if the GL version is 3.3 or higher.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>unit</parameter> is greater than or equal to the value of\r
            <constant>GL_MAX_COMBIED_TEXTURE_IMAGE_UNITS</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>sampler</parameter> is not zero or a name previously\r
            returned from a call to <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>, or if such a name has\r
            been deleted by a call to <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="associatedgets"><title>Associated Gets</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_SAMPLER_BINDING</constant>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGetSamplerParameter</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGenTextures</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glDeleteTextures</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