glClearStencil

From OpenGL Reference
Jump to navigation Jump to search

Specify the clear value for the stencil buffer.

C Specification[edit]

void glClearStencil( GLint s );


Parameters[edit]

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


Description[edit]

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


Associated Gets[edit]

 glGet with argument GL_STENCIL_CLEAR_VALUE 

 glGet with argument GL_STENCIL_BITS 


Version Support[edit]

 glClearStencil  2.0+

See Also[edit]

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


Copyright[edit]

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/.