rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glSampleMaski.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="glSampleMaski">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glSampleMaski</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glSampleMaski</refname>\r
        <refpurpose>set the value of a sub-word of the sample mask</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glSampleMaski</function></funcdef>\r
                <paramdef>GLuint <parameter>maskNumber</parameter></paramdef>\r
                <paramdef>GLbitfield <parameter>mask</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>maskNumber</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies which 32-bit sub-word of the sample mask to update.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>mask</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the new value of the mask sub-word.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glSampleMaski</function> sets one 32-bit sub-word of the multi-word sample mask, <constant>GL_SAMPLE_MASK_VALUE</constant>.\r
        </para>\r
        <para>\r
            <parameter>maskIndex</parameter> specifies which 32-bit sub-word of the sample mask to update, and <parameter>mask</parameter> specifies\r
            the new value to use for that sub-word. <parameter>maskIndex</parameter> must be less than the value of\r
            <constant>GL_MAX_SAMPLE_MASK_WORDS</constant>. Bit <emphasis>B</emphasis> of mask word <emphasis>M</emphasis> corresponds to sample\r
            32 x <emphasis>M</emphasis> + <emphasis>B</emphasis>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="notes"><title>Notes</title>\r
        <para>\r
            <function>glSampleMaski</function> is available only if the GL version is 3.2 or greater, or if the <code>ARB_texture_multisample</code>\r
            extension is supported.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>maskIndex</parameter> is greater than or equal to the value\r
            of <constant>GL_MAX_SAMPLE_MASK_WORDS</constant>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glRenderbufferStorageMultisample</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glDeleteRenderbuffers</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