Opentk/Source/Bind/Specifications/Docs/ES31/glSampleCoverage.xml

<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glSampleCoverage">
    <info>
        <copyright>
            <year>1991-2006</year>
            <holder>Silicon Graphics, Inc.</holder>
        </copyright>
        <copyright>
            <year>2010-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>glSampleCoverage</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glSampleCoverage</refname>
        <refpurpose>specify multisample coverage parameters</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glSampleCoverage</function></funcdef>
                <paramdef>GLfloat <parameter>value</parameter></paramdef>
                <paramdef>GLboolean <parameter>invert</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>value</parameter></term>
            <listitem>
                <para>
                    Specify a single floating-point sample coverage value.  The value is
                    clamped to the range
                    <inlineequation><mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
                        <!-- eqn: [0 ,1]: -->
                        <mml:mfenced open="[" close="]">
                            <mml:mn>0</mml:mn>
                            <mml:mn>1</mml:mn>
                        </mml:mfenced>
                    </mml:math></inlineequation>.
                    The initial value is 1.0.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>invert</parameter></term>
            <listitem>
                <para>
                    Specify a single boolean value representing if the coverage masks should be
                    inverted.  <constant>GL_TRUE</constant> and <constant>GL_FALSE</constant> are accepted.  The initial value
                    is <constant>GL_FALSE</constant>.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            Multisampling samples a pixel multiple times at various
            implementation-dependent subpixel locations to generate antialiasing
            effects.  Multisampling transparently antialiases points, lines, polygons,
            and images if it is enabled.
        </para>
        <para>
            <parameter>value</parameter> is used in constructing a temporary mask used in determining which
            samples will be used in resolving the final fragment color.  This mask is
            bitwise-anded with the coverage mask generated from the multisampling
            computation.  If the <parameter>invert</parameter> flag is set, the temporary mask is inverted
            (all bits flipped) and then the bitwise-and is computed.
        </para>
        <para>
            If an implementation does not have any multisample buffers available, or
            multisampling is disabled, rasterization occurs with only a single sample
            computing a pixel's final RGB color.
        </para>
        <para>
            Provided an implementation supports multisample buffers, and multisampling
            is enabled, then a pixel's final color is generated by combining several
            samples per pixel.  Each sample contains color, depth, and stencil
            information, allowing those operations to be performed on each sample.
        </para>
    </refsect1>
    <refsect1 xml:id="associatedgets"><title>Associated Gets</title>
        <para>
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_SAMPLE_COVERAGE_VALUE</constant>
        </para>
        <para>
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_SAMPLE_COVERAGE_INVERT</constant>
        </para>
        <para>
            <citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> with argument <constant>GL_MULTISAMPLE</constant>
        </para>
        <para>
            <citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> with argument <constant>GL_SAMPLE_ALPHA_TO_COVERAGE</constant>
        </para>
        <para>
            <citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> with argument <constant>GL_SAMPLE_COVERAGE</constant>
        </para>
    </refsect1>
    <refsect1 xml:id="versions">
        <title>API Version Support</title>
        <informaltable>
            <tgroup cols="4" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry>glSampleCoverage</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='es20']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 1991-2006 Silicon Graphics, Inc.
            Copyright <trademark class="copyright"/> 2010-2014 Khronos Group.
            This document is licensed under the SGI Free Software B License.
            For details, see
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</link>.
        </para>
    </refsect1>
</refentry>