rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / gl_SampleMaskIn.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="gl_SampleMaskIn">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>gl_SampleMaskIn</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>gl_SampleMaskIn</refname>\r
        <refpurpose>contains the computed sample coverage mask for the current fragment</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <function>in int gl_SampleMaskIn[];</function>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>gl_SampleMaskIn</function> is a fragment language that indicates the\r
            set of samples covered by the primitive generating the fragment during\r
            multisample rasterization. It has a sample bit set if and only if the sample\r
            is considered covered for this fragment shader invocation. Bit\r
            <emphasis>B</emphasis> of mask <function>gl_SampleMask[M]</function>\r
            corresponds to sample 32 * <emphasis>M</emphasis> + <emphasis>B</emphasis>.\r
            The array has <function>ceil</function>(<emphasis>s</emphasis> / 32) elements\r
            where <emphasis>s</emphasis> is the maximum number of color samples supported\r
            by the implementation.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="versions"><title>Version Support</title>\r
        <informaltable frame="topbot">\r
            <tgroup cols="10" align="left">\r
                <colspec colwidth="1.1*" />\r
                <colspec colwidth="1*" align="center" />\r
                <colspec colwidth="1*" align="center" />\r
                <colspec colwidth="1*" align="center" />\r
                <colspec colwidth="1*" align="center" />\r
                <colspec colwidth="1*" align="center" />\r
                <colspec colwidth="1*" align="center" />\r
                <colspec colwidth="1*" align="center" />\r
                <colspec colwidth="1*" align="center" />\r
                <colspec colwidth="1*" align="center" />\r
                <thead>\r
                    #VARTABLEHEADER#\r
                    <row>\r
                        <entry>\r
                            gl_SampleMaskIn\r
                        </entry>\r
                        #newin40#\r
                    </row>\r
                </thead>\r
            </tgroup>\r
        </informaltable>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>gl_SampleMask</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>gl_SampleID</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>gl_SamplePosition</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>gl_FragCoord</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2011 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