GLAPI/glColorMask: Difference between revisions
m Bot: Adding better formatting. |
JeffKhronos (talk | contribs) |
||
| Line 38: | Line 38: | ||
== Copyright == | == Copyright == | ||
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2011 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [ | Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2011 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:Core API Ref Whole Framebuffer|ColorMask]] | [[Category:Core API Ref Whole Framebuffer|ColorMask]] | ||
[[Category:Core API Reference|ColorMask]] | [[Category:Core API Reference|ColorMask]] | ||
Latest revision as of 21:44, 5 February 2021
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 1.0, 3.0 for glColorMaski | |
glColorMask, glColorMaski: enable and disable writing of frame buffer color components
Function Definition
void glColorMask(GLboolean red, GLboolean green, GLboolean blue, GLboolean alpha); void glColorMaski(GLuint buf, GLboolean red, GLboolean green, GLboolean blue, GLboolean alpha);
- buf
- For glColorMaski, specifies the index of the draw buffer whose color mask to set.
- red, green, blue, alpha
- Specify whether red, green, blue, and alpha are to be written into the frame buffer. The initial values are all GL_TRUE, indicating that the color components are written.
Description
glColorMask and glColorMaski specify whether the individual color components in the frame buffer can or cannot be written. glColorMaski sets the mask for a specific draw buffer, whereas glColorMask sets the mask for all draw buffers. If red is GL_FALSE, for example, no change is made to the red component of any pixel in any of the color buffers, regardless of the drawing operation attempted.
Changes to individual bits of components cannot be controlled. Rather, changes are either enabled or disabled for entire color components.
Errors
GL_INVALID_VALUE is generated if buf is greater than GL_MAX_DRAW_BUFFERS minus 1.
Associated Gets
glGet with argument GL_COLOR_WRITEMASK
See Also
glClear, glClearBuffer, glDepthMask, glStencilMask
Copyright
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2011 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see LicenseRef-FreeB.