---
name: "glClearStencil"
section: "3x"
platform: "linux"
package: "xlibmesa-gl-dev"
version: "4.3.0.dfsg.1-14sarge7"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/glClearStencil"
---

# glClearStencil(3x)

specify the clear value for the stencil buffer

## NAME

**glClearStencil** - specify the clear value for the stencil buffer

## C SPECIFICATION

void **glClearStencil**( GLint *s* )

```

```

delim $$

## 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 sup m^-^1$, where $m$ is the number of bits in the stencil buffer.

## ERRORS

**GL\_INVALID\_OPERATION** is generated if **glClearStencil** is executed between the execution of **glBegin** and the corresponding execution of **glEnd**.

## ASSOCIATED GETS

**glGet** with argument **GL\_STENCIL\_CLEAR\_VALUE**\
 **glGet** with argument **GL\_STENCIL\_BITS**

## SEE ALSO

**glClear(3G)**, **glStencilFunc(3G)**, **glStencilOp(3G)**, **glStencilMask(3G)**