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>glStencilMaskSeparate - 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=
"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>
5 Specifies whether the front and/or back stencil writemask is updated.
6 Three symbolic constants are valid:
7 <code class=
"constant">GL_FRONT
</code>,
8 <code class=
"constant">GL_BACK
</code>, and
9 <code class=
"constant">GL_FRONT_AND_BACK
</code>.
10 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>mask
</code></em></span></dt><dd><p>
11 Specifies a bit mask to enable and disable writing of individual bits
12 in the stencil planes.
13 Initially, the mask is all
1's.
14 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
15 <code class=
"function">glStencilMaskSeparate
</code> controls the writing of individual bits in the stencil planes.
17 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll"><mml:mi mathvariant=
"italic">n
</mml:mi></mml:math>
18 bits of
<em class=
"parameter"><code>mask
</code></em>,
20 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll"><mml:mi mathvariant=
"italic">n
</mml:mi></mml:math>
21 is the number of bits in the stencil buffer,
23 Where a
1 appears in the mask,
24 it's possible to write to the corresponding bit in the stencil buffer.
26 the corresponding bit is write-protected.
27 Initially, all bits are enabled for writing.
29 There can be two separate
<em class=
"parameter"><code>mask
</code></em> writemasks; one affects back-facing polygons, and the other
30 affects front-facing polygons as well as other non-polygon primitives.
31 <a href=
"glStencilMask.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilMask
</span></span></a> sets both front
32 and back stencil writemasks to the same values, as if
33 <a href=
"glStencilMaskSeparate.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilMaskSeparate
</span></span></a> were called
34 with
<em class=
"parameter"><code>face
</code></em> set to
<code class=
"constant">GL_FRONT_AND_BACK
</code>.
35 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
36 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>face
</code></em> is not one of the accepted tokens.
37 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
38 <a href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
39 <code class=
"constant">GL_STENCIL_WRITEMASK
</code>,
<code class=
"constant">GL_STENCIL_BACK_WRITEMASK
</code>,
40 or
<code class=
"constant">GL_STENCIL_BITS
</code>
41 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
42 <a href=
"glColorMask.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glColorMask
</span></span></a>,
43 <a href=
"glDepthMask.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDepthMask
</span></span></a>,
44 <a href=
"glStencilFunc.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilFunc
</span></span></a>,
45 <a href=
"glStencilFuncSeparate.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilFuncSeparate
</span></span></a>,
46 <a href=
"glStencilMask.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilMask
</span></span></a>,
47 <a href=
"glStencilOp.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilOp
</span></span></a>,
48 <a href=
"glStencilOpSeparate.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilOpSeparate
</span></span></a>
49 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
50 Copyright
<span class=
"trademark"></span>©
2006 Khronos Group.
51 This material may be distributed subject to the terms and conditions set forth in
52 the Open Publication License, v
1.0,
8 June
1999.
53 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
54 </p></div></div></body></html>