glColorMask

The glColorMask function enables and disables writing of frame-buffer color components.

void glColorMask(
  GLboolean red,    
  GLboolean green,  
  GLboolean blue,   
  GLboolean alpha   
);
 

Parameters

red, green, blue, alpha

Specify whether red, green, blue, and alpha can or cannot be written into the frame buffer. The default values are all GL_TRUE, indicating that the color components can be written.

Remarks

The glColorMask function specifies whether the individual color components in the frame buffer can or cannot be written. 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.

The following functions retrieve information related to glColorMask:

glGet with argument GL_COLOR_WRITEMASK

glGet with argument GL_RGBA_MODE

Error Codes

The following are the error codes generated and their conditions.

QuickInfo

  Windows NT: Use version 3.5 and later.
  Windows: Use Windows 95 and later.
  Windows CE: Unsupported.
  Header: Declared in gl.h.
  Import Library: Link with opengl32.lib.

See Also

glBegin, glColor, glDepthMask, glEnd, glGet, glIndex, glIndexMask, glStencilMask