| 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> |
| 3 | <!-- saved from url=(0013)about:internet --> |
| 4 | <?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>glStencilMask</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glStencilMask"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glStencilMask — control the front and back writing of individual bits in the stencil planes</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><p><code class="funcdef">void <b class="fsfunc">glStencilMask</b>(</code>GLuint <var class="pdparam">mask</var><code>)</code>;</p></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>mask</code></em></span></dt><dd><p> |
| 5 | Specifies a bit mask to enable and disable writing of individual bits |
| 6 | in the stencil planes. |
| 7 | Initially, the mask is all 1's. |
| 8 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> |
| 9 | <code class="function">glStencilMask</code> controls the writing of individual bits in the stencil planes. |
| 10 | The least significant |
| 11 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math> |
| 12 | bits of <em class="parameter"><code>mask</code></em>, |
| 13 | where |
| 14 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math> |
| 15 | is the number of bits in the stencil buffer, |
| 16 | specify a mask. |
| 17 | Where a 1 appears in the mask, |
| 18 | it's possible to write to the corresponding bit in the stencil buffer. |
| 19 | Where a 0 appears, |
| 20 | the corresponding bit is write-protected. |
| 21 | Initially, all bits are enabled for writing. |
| 22 | </p><p> |
| 23 | There can be two separate <em class="parameter"><code>mask</code></em> writemasks; one affects back-facing polygons, and the other |
| 24 | affects front-facing polygons as well as other non-polygon primitives. |
| 25 | <a href="glStencilMask.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a> sets both front |
| 26 | and back stencil writemasks to the same values. Use <a href="glStencilMaskSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMaskSeparate</span></span></a> |
| 27 | to set front and back stencil writemasks to different values. |
| 28 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> |
| 29 | <a href="glStencilMask.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a> is the same as |
| 30 | calling <a href="glStencilMaskSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMaskSeparate</span></span></a> |
| 31 | with <em class="parameter"><code>face</code></em> set to <code class="constant">GL_FRONT_AND_BACK</code>. |
| 32 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> |
| 33 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument |
| 34 | <code class="constant">GL_STENCIL_WRITEMASK</code>, <code class="constant">GL_STENCIL_BACK_WRITEMASK</code>, |
| 35 | or <code class="constant">GL_STENCIL_BITS</code> |
| 36 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> |
| 37 | <a href="glColorMask.xml"><span class="citerefentry"><span class="refentrytitle">glColorMask</span></span></a>, |
| 38 | <a href="glDepthMask.xml"><span class="citerefentry"><span class="refentrytitle">glDepthMask</span></span></a>, |
| 39 | <a href="glStencilFunc.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>, |
| 40 | <a href="glStencilFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>, |
| 41 | <a href="glStencilMaskSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMaskSeparate</span></span></a>, |
| 42 | <a href="glStencilOp.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>, |
| 43 | <a href="glStencilOpSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a> |
| 44 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> |
| 45 | Copyright <span class="trademark"></span>© 1991-2006 |
| 46 | Silicon Graphics, Inc. This document is licensed under the SGI |
| 47 | Free Software B License. For details, see |
| 48 | <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. |
| 49 | </p></div></div></body></html> |