1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
xmlns="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>glStencilMask</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GL.xml" title="GL"/><link rel="previous" href="glStencilFunc.3G.xml" title="glStencilFunc"/><link rel="next" href="glStencilOp.3G.xml" title="glStencilOp"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">glStencilMask</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glStencilFunc.3G.xml">Prev</a></td><th width="60%" align="center">GL</th><td width="20%" align="right"><a accesskey="n" href="glStencilOp.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glStencilMask.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glStencilMask.3G-name"/><h2>Name</h2><p>glStencilMask — control the writing of individual bits in the stencil planes</p></div><div class="refsynopsisdiv"><a name="glStencilMask.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void<tt>glStencilMask</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLuint<i><tt>mask</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glStencilMask.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glStencilMask</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>mask</tt></i>) →<tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glStencilMask.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>mask</tt></i></span></dt><dd>
Specifies a bit mask to enable and disable writing of individual bits in the stencil planes. Initially, the
mask is all 1's.
</dd></dl></div></div><div class="refsect1" lang="en"><a name="glStencilMask.3G-description"/><h2>Description</h2><p>
<tt>glStencilMask</tt> controls the writing of individual bits in the stencil planes. The least significant
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mi>n</mml:mi>
</mml:math> bits of <i><tt>mask</tt></i>, where <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mi>n</mml:mi>
</mml:math> 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.
</p></div><div class="refsect1" lang="en"><a name="glStencilMask.3G-errors"/><h2>Errors</h2><p>
<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glStencilMask</tt> is executed between the
execution of <a href="glBegin.3G.xml"><tt>glBegin</tt></a> and the corresponding execution of <a href="glBegin.3G.xml"><tt>glEnd</tt></a>.
</p></div><div class="refsect1" lang="en"><a name="glStencilMask.3G-associated_gets"/><h2>Associated Gets</h2><p>
<tt>glGet</tt> with argument <tt>GL_STENCIL_WRITEMASK</tt>
</p><p>
<tt>glGet</tt> with argument <tt>GL_STENCIL_BITS</tt>
</p></div><div class="refsect1" lang="en"><a name="glStencilMask.3G-see_also"/><h2>See Also</h2><p>
<span class="simplelist"><a href="glColorMask.3G.xml">glColorMask</a>, <a href="glDepthMask.3G.xml">glDepthMask</a>, <a href="glIndexMask.3G.xml">glIndexMask</a>, <a href="glStencilFunc.3G.xml">glStencilFunc</a>, <a href="glStencilOp.3G.xml">glStencilOp</a></span>
</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glStencilFunc.3G.xml">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="reference-GL.xml">Up</a></td><td width="40%" align="right"><a accesskey="n" href="glStencilOp.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glStencilFunc</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glStencilOp</td></tr></table></div></body></html>
|
