GLAPI/glClearStencil: Difference between revisions
< GLAPI
m Renaming category: 'API Reference 4' to 'Core API Reference'. |
m Bot: Adding better formatting. |
||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
void '''glClearStencil'''(GLint | void '''glClearStencil'''(GLint {{param|s}}); | ||
; s | ; s | ||
| Line 15: | Line 15: | ||
== Description == | == Description == | ||
'''glClearStencil''' specifies the index used by | '''glClearStencil''' specifies the index used by {{apifunc|glClear}} to clear the stencil buffer. {{param|s}} is masked with 2<sup>m</sup> - 1, where m is the number of bits in the stencil buffer. | ||
== Associated Gets == | == Associated Gets == | ||
{{apifunc|glGet}} with argument {{code|GL_STENCIL_CLEAR_VALUE}} | |||
{{apifunc|glGet}} with argument {{code|GL_STENCIL_BITS}} | |||
== See Also == | == See Also == | ||
{{apifunc|glClear}}, {{apifunc|glStencilFunc}}, {{apifunc|glStencilFuncSeparate}}, {{apifunc|glStencilMask}}, {{apifunc|glStencilMaskSeparate}}, {{apifunc|glStencilOp}}, {{apifunc|glStencilOpSeparate}} | |||
== Copyright == | == Copyright == | ||
Revision as of 01:14, 29 April 2012
| 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/.