glColorMask

From OpenGL Reference
Jump to navigation Jump to search

Enable and disable writing of frame buffer color components.

C Specification[edit]

void glColorMask( GLboolean red, GLboolean green, GLboolean blue, GLboolean alpha );
void glColorMaski( GLuint buf, GLboolean red, GLboolean green, GLboolean blue, GLboolean alpha );


Parameters[edit]

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[edit]

 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.


Associated Gets[edit]

 glGet with argument GL_COLOR_WRITEMASK 


Version Support[edit]

 glColorMask  2.0+
 glColorMaski  3.0+

See Also[edit]

 glClear , glDepthMask , glStencilMask 


Copyright[edit]

Copyright© 1991-2006 Silicon Graphics, Inc. Copyright© 2010-2014 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.