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>glClearStencil
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.73.2" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glClearStencil"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glClearStencil — specify the clear value for the stencil buffer
</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">glClearStencil
</b>(
</code></td><td>GLint
</td><td><var class=
"pdparam">s
</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>s
</code></em></span></dt><dd><p>
4 Specifies the index used when the stencil buffer is cleared.
5 The initial value is
0.
6 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
7 <code class=
"function">glClearStencil
</code> specifies the index used by
<a class=
"citerefentry" href=
"glClear.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClear
</span></span></a> to clear the stencil buffer.
8 <em class=
"parameter"><code>s
</code></em> is masked with
9 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
12 <mml:msup><mml:mn>2</mml:mn>
13 <mml:mi mathvariant=
"italic">m
</mml:mi>
20 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll"><mml:mi mathvariant=
"italic">m
</mml:mi></mml:math>
21 is the number of bits in the stencil buffer.
22 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
23 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
<code class=
"function">glClearStencil
</code>
24 is executed between the execution of
<a class=
"citerefentry" href=
"glBegin.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBegin
</span></span></a>
25 and the corresponding execution of
<a class=
"citerefentry" href=
"glEnd.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnd
</span></span></a>.
26 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
27 <a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_STENCIL_CLEAR_VALUE
</code>
29 <a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_STENCIL_BITS
</code>
30 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
31 <a class=
"citerefentry" href=
"glClear.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClear
</span></span></a>,
32 <a class=
"citerefentry" href=
"glStencilFunc.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilFunc
</span></span></a>,
33 <a class=
"citerefentry" href=
"glStencilFuncSeparate.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilFuncSeparate
</span></span></a>,
34 <a class=
"citerefentry" href=
"glStencilMask.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilMask
</span></span></a>,
35 <a class=
"citerefentry" href=
"glStencilMaskSeparate.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilMaskSeparate
</span></span></a>,
36 <a class=
"citerefentry" href=
"glStencilOp.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilOp
</span></span></a>,
37 <a class=
"citerefentry" href=
"glStencilOpSeparate.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilOpSeparate
</span></span></a>
38 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
39 Copyright
<span class=
"trademark"></span>©
1991-
2006
40 Silicon Graphics, Inc. This document is licensed under the SGI
41 Free Software B License. For details, see
42 <a class=
"ulink" href=
"http://oss.sgi.com/projects/FreeB/" target=
"_top">http://oss.sgi.com/projects/FreeB/
</a>.
43 </p></div></div></body></html>