Light | Dark

# docs.GL

OpenGL 4
OpenGL 3
OpenGL 2
OpenGL ES 3
OpenGL ES 2

# glClearStencil

## Name

glClearStencil — specify the clear value for the stencil buffer

## C Specification

`void glClearStencil(` | GLint s`)`;

## Parameters

`s`

  Specifies the index used when the stencil buffer is cleared. The initial value is 0.

## Description

`glClearStencil` specifies the index used by glClear to clear the stencil buffer. `s` is masked with 2 m - 1 , where m is the number of bits in the stencil buffer.

## Associated Gets

glGet with argument `GL_STENCIL_CLEAR_VALUE`

glGet with argument `GL_STENCIL_BITS`

## Version Support

| OpenGL Version
--- | ---
Function / Feature Name | 2.0 | 2.1 | 3.0 | 3.1 | 3.2 | 3.3 | 4.0 | 4.1 | 4.2 | 4.3 | 4.4 | 4.5
`glClearStencil` | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔

## See Also

glClear, glStencilFunc, glStencilFuncSeparate, glStencilMask, glStencilMaskSeparate, glStencilOp, glStencilOpSeparate

## Copyright

Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2014 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/.

Think you can improve this page? Edit this page on GitHub.