1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glClearStencil">
9 <holder>Silicon Graphics, Inc.
</holder>
12 <refentrytitle>glClearStencil
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glClearStencil
</refname>
17 <refpurpose>specify the clear value for the stencil buffer
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glClearStencil
</function></funcdef>
23 <paramdef>GLint
<parameter>s
</parameter></paramdef>
27 <!-- eqn: ignoring delim $$ -->
28 <refsect1 id=
"parameters"><title>Parameters
</title>
31 <term><parameter>s
</parameter></term>
34 Specifies the index used when the stencil buffer is cleared.
35 The initial value is
0.
41 <refsect1 id=
"description"><title>Description
</title>
43 <function>glClearStencil
</function> specifies the index used by
<citerefentry><refentrytitle>glClear
</refentrytitle></citerefentry> to clear the stencil buffer.
44 <parameter>s
</parameter> is masked with
45 <inlineequation><mml:math>
46 <!-- eqn: 2 sup m - 1: -->
48 <mml:msup><mml:mn>2</mml:mn>
49 <mml:mi mathvariant=
"italic">m
</mml:mi>
54 </mml:math></inlineequation>,
56 <inlineequation><mml:math><mml:mi mathvariant=
"italic">m
</mml:mi></mml:math></inlineequation>
57 is the number of bits in the stencil buffer.
60 <refsect1 id=
"associatedgets"><title>Associated Gets
</title>
62 <citerefentry><refentrytitle>glGet
</refentrytitle></citerefentry> with argument
<constant>GL_STENCIL_CLEAR_VALUE
</constant>
65 <citerefentry><refentrytitle>glGet
</refentrytitle></citerefentry> with argument
<constant>GL_STENCIL_BITS
</constant>
68 <refsect1 id=
"seealso"><title>See Also
</title>
70 <citerefentry><refentrytitle>glClear
</refentrytitle></citerefentry>,
71 <citerefentry><refentrytitle>glStencilFunc
</refentrytitle></citerefentry>,
72 <citerefentry><refentrytitle>glStencilFuncSeparate
</refentrytitle></citerefentry>,
73 <citerefentry><refentrytitle>glStencilMask
</refentrytitle></citerefentry>,
74 <citerefentry><refentrytitle>glStencilMaskSeparate
</refentrytitle></citerefentry>,
75 <citerefentry><refentrytitle>glStencilOp
</refentrytitle></citerefentry>,
76 <citerefentry><refentrytitle>glStencilOpSeparate
</refentrytitle></citerefentry>
79 <refsect1 id=
"Copyright"><title>Copyright
</title>
81 Copyright
<trademark class=
"copyright"></trademark> 1991-
2006
82 Silicon Graphics, Inc. This document is licensed under the SGI
83 Free Software B License. For details, see
84 <ulink url=
"http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/
</ulink>.