GLAPI/glClearStencil: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
m fixed sort key
Line 15: Line 15:
== Description ==
== Description ==


'''glClearStencil''' specifies the index used by [[GLAPI/glClear|glClear]] to clear the stencil buffer. ''s'' is masked with <!--Missing Equation-->, where <!--Missing Equation--> is the number of bits in the stencil buffer.
'''glClearStencil''' specifies the index used by [[GLAPI/glClear|glClear]] to clear the stencil buffer. ''s'' is masked with 2<sup>m</sup> - 1, where m is the number of bits in the stencil buffer.


== Associated Gets ==
== Associated Gets ==

Revision as of 13:49, 27 January 2012

glClearStencil
Core in version 4.6
Core since version 1.0

glClearStencil: specify the clear value for the stencil buffer

Function Definition

 void glClearStencil(GLint s);
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 2m - 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

See Also

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

Copyright

Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.