<?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>glClearStencil</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="glClearIndex.3G.xml" title="glClearIndex"/><link rel="next" href="glClientActiveTextureARB.3G.xml" title="glClientActiveTextureARB"/></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">glClearStencil</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glClearIndex.3G.xml">Prev</a> </td><th width="60%" align="center">GL</th><td width="20%" align="right"> <a accesskey="n" href="glClientActiveTextureARB.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glClearStencil.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glClearStencil.3G-name"/><h2>Name</h2><p>glClearStencil &#8212; specify the clear value for the stencil buffer</p></div><div class="refsynopsisdiv"><a name="glClearStencil.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void <tt>glClearStencil</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLint <i><tt>s</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glClearStencil.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glClearStencil</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>s</tt></i>) &#8594; <tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glClearStencil.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>s</tt></i></span></dt><dd>
						Specifies the index used when the stencil buffer is cleared. The initial value is 0.
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="glClearStencil.3G-description"/><h2>Description</h2><p>
			<tt>glClearStencil</tt> specifies the index used by <a href="glClear.3G.xml"><tt>glClear</tt></a> to
			clear the stencil buffer. <i><tt>s</tt></i> is masked with <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:msup>
						<mml:mn>2</mml:mn>
						<mml:mi>m</mml:mi>
					</mml:msup>
					<mml:mo>-</mml:mo>
					<mml:mn>1</mml:mn>
				</mml:math>, where <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mi>m</mml:mi>
				</mml:math> is the number of bits in the stencil buffer.
		</p></div><div class="refsect1" lang="en"><a name="glClearStencil.3G-errors"/><h2>Errors</h2><p>
			<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glClearStencil</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="glClearStencil.3G-associated_gets"/><h2>Associated Gets</h2><p>
			<tt>glGet</tt> with argument <tt>GL_STENCIL_CLEAR_VALUE</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_STENCIL_BITS</tt>
		</p></div><div class="refsect1" lang="en"><a name="glClearStencil.3G-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="glClear.3G.xml">glClear</a>, <a href="glStencilFunc.3G.xml">glStencilFunc</a>, <a href="glStencilOp.3G.xml">glStencilOp</a>, <a href="glStencilMask.3G.xml">glStencilMask</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="glClearIndex.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="glClientActiveTextureARB.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glClearIndex </td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top"> glClientActiveTextureARB</td></tr></table></div></body></html>
