glClearStencil(3x)

glClearStencil3x

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.

Overview

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

From xlibmesa-gl-dev 4.3.0.dfsg.1-14sarge7 in Debian 3.1 (Sarge). Parsed by carta from the page's man source.