GLAPI/glDepthMask: Difference between revisions
4.0 API. |
JeffKhronos (talk | contribs) |
||
| (7 intermediate revisions by one other user not shown) | |||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
void '''glDepthMask'''(GLboolean | void '''glDepthMask'''(GLboolean {{param|flag}}); | ||
; flag | ; flag | ||
: Specifies whether the depth buffer is enabled for writing. If | : Specifies whether the depth buffer is enabled for writing. If {{param|flag}} is {{enum|GL_FALSE}}, depth buffer writing is disabled. Otherwise, it is enabled. Initially, depth buffer writing is enabled. | ||
== Description == | == Description == | ||
'''glDepthMask''' specifies whether the depth buffer is enabled for writing. If | '''glDepthMask''' specifies whether the depth buffer is enabled for writing. If {{param|flag}} is {{enum|GL_FALSE}}, depth buffer writing is disabled. Otherwise, it is enabled. Initially, depth buffer writing is enabled. | ||
== Associated Gets == | == Associated Gets == | ||
{{apifunc|glGet}} with argument {{enum|GL_DEPTH_WRITEMASK}} | |||
== Notes == | |||
Even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled. In order to unconditionally write to the depth buffer, the depth test should be enabled and set to {{enum|GL_ALWAYS}} (see {{apifunc|glDepthFunc}}). | |||
== See Also == | == See Also == | ||
{{apifunc|glColorMask}}, {{apifunc|glClearBuffer}}, {{apifunc|glDepthFunc}}, {{apifunc|glDepthRange}}, {{apifunc|glStencilMask}} | |||
== Copyright == | == Copyright == | ||
Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see [ | Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2012 Khronos Group. 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:API Reference | [[Category:Core API Ref Whole Framebuffer|DepthMask]] | ||
[[Category:Core API Reference|DepthMask]] | |||
Latest revision as of 21:48, 5 February 2021
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 1.0 | |
glDepthMask: enable or disable writing into the depth buffer
Function Definition
void glDepthMask(GLboolean flag);
- flag
- Specifies whether the depth buffer is enabled for writing. If flag is GL_FALSE, depth buffer writing is disabled. Otherwise, it is enabled. Initially, depth buffer writing is enabled.
Description
glDepthMask specifies whether the depth buffer is enabled for writing. If flag is GL_FALSE, depth buffer writing is disabled. Otherwise, it is enabled. Initially, depth buffer writing is enabled.
Associated Gets
glGet with argument GL_DEPTH_WRITEMASK
Notes
Even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled. In order to unconditionally write to the depth buffer, the depth test should be enabled and set to GL_ALWAYS (see glDepthFunc).
See Also
glColorMask, glClearBuffer, glDepthFunc, glDepthRange, glStencilMask
Copyright
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2012 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see LicenseRef-FreeB.