GLAPI/glClearStencil: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
m Bot: Adding better formatting.
 
(2 intermediate revisions by one other user not shown)
Line 19: Line 19:
== Associated Gets ==
== Associated Gets ==


{{apifunc|glGet}} with argument {{code|GL_STENCIL_CLEAR_VALUE}}
{{apifunc|glGet}} with argument {{enum|GL_STENCIL_CLEAR_VALUE}}


{{apifunc|glGet}} with argument {{code|GL_STENCIL_BITS}}
{{apifunc|glGet}} with argument {{enum|GL_STENCIL_BITS}}


== See Also ==
== See Also ==


{{apifunc|glClear}}, {{apifunc|glStencilFunc}}, {{apifunc|glStencilFuncSeparate}}, {{apifunc|glStencilMask}}, {{apifunc|glStencilMaskSeparate}}, {{apifunc|glStencilOp}}, {{apifunc|glStencilOpSeparate}}
{{apifunc|glClear}}


== Copyright ==
== 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/ 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 [https://khronos.org/registry/OpenGL-Refpages/LICENSES/LicenseRef-FreeB.txt LicenseRef-FreeB].


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

Latest revision as of 22:11, 5 February 2021

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

Copyright

Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see LicenseRef-FreeB.