glClearStencil - OpenGL ES 3 Reference Pages

## 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. When clearing a 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`

## API Version Support

| OpenGL ES API Version
--- | ---
Function Name | 2.0 | 3.0
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 http://oss.sgi.com/projects/FreeB/.