rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glStencilMask.xml

diff --git a/upstream-doc/man4/glStencilMask.xml b/upstream-doc/man4/glStencilMask.xml
new file mode 100644 (file)
index 0000000..65b13db
--- /dev/null
+++ b/upstream-doc/man4/glStencilMask.xml
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
+<refentry id="glStencilMask">
+    <refmeta>
+        <refmetainfo>
+            <copyright>
+                <year>1991-2006</year>
+                <holder>Silicon Graphics, Inc.</holder>
+            </copyright>
+        </refmetainfo>
+        <refentrytitle>glStencilMask</refentrytitle>
+        <manvolnum>3G</manvolnum>
+    </refmeta>
+    <refnamediv>
+        <refname>glStencilMask</refname>
+        <refpurpose>control the front and back writing of individual bits in the stencil planes</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv><title>C Specification</title>
+        <funcsynopsis>
+            <funcprototype>
+                <funcdef>void <function>glStencilMask</function></funcdef>
+                <paramdef>GLuint <parameter>mask</parameter></paramdef>
+            </funcprototype>
+        </funcsynopsis>
+    </refsynopsisdiv>
+    <!-- eqn: ignoring delim $$ -->
+    <refsect1 id="parameters"><title>Parameters</title>
+        <variablelist>
+        <varlistentry>
+            <term><parameter>mask</parameter></term>
+            <listitem>
+                <para>
+                    Specifies a bit mask to enable and disable writing of individual bits
+                    in the stencil planes.
+                    Initially, the mask is all 1's.
+                </para>
+            </listitem>
+        </varlistentry>
+        </variablelist>
+    </refsect1>
+    <refsect1 id="description"><title>Description</title>
+        <para>
+            <function>glStencilMask</function> controls the writing of individual bits in the stencil planes.
+            The least significant 
+            <inlineequation><mml:math><mml:mi mathvariant="italic">n</mml:mi></mml:math></inlineequation>
+            bits of <parameter>mask</parameter>,
+            where 
+            <inlineequation><mml:math><mml:mi mathvariant="italic">n</mml:mi></mml:math></inlineequation>
+            is the number of bits in the stencil buffer,
+            specify a mask.
+            Where a 1 appears in the mask,
+            it's possible to write to the corresponding bit in the stencil buffer.
+            Where a 0 appears,
+            the corresponding bit is write-protected.
+            Initially, all bits are enabled for writing.
+        </para>
+        <para>
+            There can be two separate <parameter>mask</parameter> writemasks; one affects back-facing polygons, and the other
+            affects front-facing polygons as well as other non-polygon primitives. 
+            <citerefentry><refentrytitle>glStencilMask</refentrytitle></citerefentry> sets both front
+            and back stencil writemasks to the same values. Use <citerefentry><refentrytitle>glStencilMaskSeparate</refentrytitle></citerefentry>
+            to set front and back stencil writemasks to different values.
+        </para>
+    </refsect1>
+    <refsect1 id="notes"><title>Notes</title>
+        <para>
+            <citerefentry><refentrytitle>glStencilMask</refentrytitle></citerefentry> is the same as
+            calling <citerefentry><refentrytitle>glStencilMaskSeparate</refentrytitle></citerefentry>
+            with <parameter>face</parameter> set to <constant>GL_FRONT_AND_BACK</constant>.
+        </para>
+    </refsect1>
+    <refsect1 id="associatedgets"><title>Associated Gets</title>
+        <para>
+            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument 
+            <constant>GL_STENCIL_WRITEMASK</constant>, <constant>GL_STENCIL_BACK_WRITEMASK</constant>, 
+            or <constant>GL_STENCIL_BITS</constant>
+        </para>
+    </refsect1>
+    <refsect1 id="seealso"><title>See Also</title>
+        <para>
+            <citerefentry><refentrytitle>glColorMask</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glDepthMask</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glStencilFunc</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glStencilFuncSeparate</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glStencilMaskSeparate</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glStencilOp</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glStencilOpSeparate</refentrytitle></citerefentry>
+        </para>
+    </refsect1>
+    <refsect1 id="Copyright"><title>Copyright</title>
+        <para>
+            Copyright <trademark class="copyright"></trademark> 1991-2006
+            Silicon Graphics, Inc. This document is licensed under the SGI
+            Free Software B License. For details, see
+            <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
+        </para>
+    </refsect1>
+</refentry>