upstream-man-pages/man2/xhtml/glStencilMaskSeparate.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?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" /><title>glStencilMaskSeparate</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glStencilMaskSeparate"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glStencilMaskSeparate — control the front and/or back writing of individual bits in the stencil planes</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">glStencilMaskSeparate</b>(</code></td><td>GLenum  </td><td><var class="pdparam">face</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">mask</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>face</code></em></span></dt><dd><p>
   4                     Specifies whether the front and/or back stencil writemask is updated.
   5                     Three symbolic constants are valid:
   6                     <code class="constant">GL_FRONT</code>,
   7                     <code class="constant">GL_BACK</code>, and
   8                     <code class="constant">GL_FRONT_AND_BACK</code>.
   9                 </p></dd><dt><span class="term"><em class="parameter"><code>mask</code></em></span></dt><dd><p>
  10                     Specifies a bit mask to enable and disable writing of individual bits
  11                     in the stencil planes.
  12                     Initially, the mask is all 1's.
  13                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  14             <code class="function">glStencilMaskSeparate</code> controls the writing of individual bits in the stencil planes.
  15             The least significant
  16             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>
  17             bits of <em class="parameter"><code>mask</code></em>,
  18             where
  19             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>
  20             is the number of bits in the stencil buffer,
  21             specify a mask.
  22             Where a 1 appears in the mask,
  23             it's possible to write to the corresponding bit in the stencil buffer.
  24             Where a 0 appears,
  25             the corresponding bit is write-protected.
  26             Initially, all bits are enabled for writing.
  27         </p><p>
  28             There can be two separate <em class="parameter"><code>mask</code></em> writemasks; one affects back-facing polygons, and the other
  29             affects front-facing polygons as well as other non-polygon primitives.
  30             <a class="citerefentry" href="glStencilMask.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a> sets both front
  31             and back stencil writemasks to the same values, as if
  32             <a class="citerefentry" href="glStencilMaskSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMaskSeparate</span></span></a> were called
  33             with <em class="parameter"><code>face</code></em> set to <code class="constant">GL_FRONT_AND_BACK</code>.
  34         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  35             <code class="function">glStencilMaskSeparate</code> is available only if
  36             the GL version is 2.0 or greater.
  37         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  38             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glStencilMaskSeparate</code>
  39             is executed between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
  40             and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  41         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  42             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument
  43             <code class="constant">GL_STENCIL_WRITEMASK</code>, <code class="constant">GL_STENCIL_BACK_WRITEMASK</code>,
  44             or <code class="constant">GL_STENCIL_BITS</code>
  45         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  46             <a class="citerefentry" href="glColorMask.xml"><span class="citerefentry"><span class="refentrytitle">glColorMask</span></span></a>,
  47             <a class="citerefentry" href="glDepthMask.xml"><span class="citerefentry"><span class="refentrytitle">glDepthMask</span></span></a>,
  48             <a class="citerefentry" href="glIndexMask.xml"><span class="citerefentry"><span class="refentrytitle">glIndexMask</span></span></a>,
  49             <a class="citerefentry" href="glStencilFunc.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>,
  50             <a class="citerefentry" href="glStencilFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>,
  51             <a class="citerefentry" href="glStencilMask.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a>,
  52             <a class="citerefentry" href="glStencilOp.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>,
  53             <a class="citerefentry" href="glStencilOpSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>
  54         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  55             Copyright <span class="trademark"></span>© 2006 Khronos Group.
  56             This material may be distributed subject to the terms and conditions set forth in
  57             the Open Publication License, v 1.0, 8 June 1999.
  58             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  59         </p></div></div></body></html>