rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glSampleCoverage.xml
diff --git a/upstream-doc/man4/xhtml/glSampleCoverage.xml b/upstream-doc/man4/xhtml/glSampleCoverage.xml
new file mode 100644 (file)
index 0000000..40ae495
--- /dev/null
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
+<!-- saved from url=(0013)about:internet -->
+<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glSampleCoverage - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glSampleCoverage"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glSampleCoverage — specify multisample coverage parameters</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glSampleCoverage</b>(</code></td><td>GLfloat  </td><td><var class="pdparam">value</var>, </td></tr><tr><td> </td><td>GLboolean  </td><td><var class="pdparam">invert</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>value</code></em></span></dt><dd><p>
+                    Specify a single floating-point sample coverage value.  The value is
+                    clamped to the range 
+                    <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+                        
+                        <mml:mfenced open="[" close="]">
+                            <mml:mn>0</mml:mn>
+                            <mml:mn>1</mml:mn>
+                        </mml:mfenced>
+                    </mml:math>.
+                    The initial value is 1.0.
+                </p></dd><dt><span class="term"><em class="parameter"><code>invert</code></em></span></dt><dd><p>
+                    Specify a single boolean value representing if the coverage masks should be
+                    inverted.  <code class="constant">GL_TRUE</code> and <code class="constant">GL_FALSE</code> are accepted.  The initial value
+                    is <code class="constant">GL_FALSE</code>.
+                </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
+            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.
+        </p><p>
+            <em class="parameter"><code>value</code></em> 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 <em class="parameter"><code>invert</code></em> flag is set, the temporary mask is inverted
+            (all bits flipped) and then the bitwise-and is computed.
+        </p><p>
+            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.
+        </p><p>
+            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.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
+            The type of the <em class="parameter"><code>value</code></em> parameter was
+            changed from GLclampf to GLfloat. This change is transparent
+            to user code and is described in detail on the
+            <a href="removedTypes.xml"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
+            page.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
+            <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_SAMPLE_COVERAGE_VALUE</code>
+        </p><p>
+            <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_SAMPLE_COVERAGE_INVERT</code>
+        </p><p>
+            <a href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_MULTISAMPLE</code>
+        </p><p>
+            <a href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_SAMPLE_ALPHA_TO_COVERAGE</code>
+        </p><p>
+            <a href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_SAMPLE_ALPHA_TO_ONE</code>
+        </p><p>
+            <a href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_SAMPLE_COVERAGE</code>
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
+            <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a>,
+            <a href="removedTypes.xml"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
+            Copyright <span class="trademark"></span>© 1991-2006
+            Silicon Graphics, Inc. This document is licensed under the SGI
+            Free Software B License. For details, see
+            <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
+        </p></div></div></body></html>