Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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>glClearStencil - 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="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"><p><code class="funcdef">void <b class="fsfunc">glClearStencil</b>(</code>GLint <var class="pdparam">s</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>s</code></em></span></dt><dd><p> | |
5 | Specifies the index used when the stencil buffer is cleared. | |
6 | The initial value is 0. | |
7 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
8 | <code class="function">glClearStencil</code> specifies the index used by <a href="glClear.xml"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a> to clear the stencil buffer. | |
9 | <em class="parameter"><code>s</code></em> is masked with | |
10 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> | |
11 | ||
12 | <mml:mrow> | |
13 | <mml:msup><mml:mn>2</mml:mn> | |
14 | <mml:mi mathvariant="italic">m</mml:mi> | |
15 | </mml:msup> | |
16 | <mml:mo>-</mml:mo> | |
17 | <mml:mn>1</mml:mn> | |
18 | </mml:mrow> | |
19 | </mml:math>, | |
20 | where | |
21 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">m</mml:mi></mml:math> | |
22 | is the number of bits in the stencil buffer. | |
23 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
24 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_STENCIL_CLEAR_VALUE</code> | |
25 | </p><p> | |
26 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_STENCIL_BITS</code> | |
27 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
28 | <a href="glClear.xml"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a>, | |
29 | <a href="glStencilFunc.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>, | |
30 | <a href="glStencilFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>, | |
31 | <a href="glStencilMask.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a>, | |
32 | <a href="glStencilMaskSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMaskSeparate</span></span></a>, | |
33 | <a href="glStencilOp.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>, | |
34 | <a href="glStencilOpSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a> | |
35 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
36 | Copyright <span class="trademark"></span>© 1991-2006 | |
37 | Silicon Graphics, Inc. This document is licensed under the SGI | |
38 | Free Software B License. For details, see | |
39 | <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. | |
40 | </p></div></div></body></html> |