GLAPI/glClearStencil: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
m Renaming category: 'GL 4 API Whole Framebuffer' to 'Core API Ref Whole Framebuffer'.
m Renaming category: 'API Reference 4' to 'Core API Reference'.
Line 31: Line 31:
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/ http://oss.sgi.com/projects/FreeB/].
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/ http://oss.sgi.com/projects/FreeB/].


[[Category:API Reference 4|ClearStencil]]
[[Category:Core API Ref Whole Framebuffer|ClearStencil]]
[[Category:Core API Ref Whole Framebuffer|ClearStencil]]
[[Category:Core API Reference|ClearStencil]]

Revision as of 07:36, 26 February 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/.