ADC Home > Reference Library > Reference > Mac OS X > Mac OS X Man Pages

 

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).



GLCOLORMASK(3G)                                                                              GLCOLORMASK(3G)



NAME
       glColorMask - enable and disable writing of frame buffer color components


C SPECIFICATION
       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 initial values are all GL_TRUE, indicating  that  the  color
                             components can be written.

DESCRIPTION
       glColorMask  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.

ERRORS
       GL_INVALID_OPERATION is generated if glColorMask is executed between the execution of glBegin and the
       corresponding execution of glEnd.

ASSOCIATED GETS
       glGet with argument GL_COLOR_WRITEMASK
       glGet with argument GL_RGBA_MODE

SEE ALSO
       glClear(3G), glColor(3G), glColorPointer(3G), glDepthMask(3G), glIndex(3G), glIndexPointer(3G), glIndexMask(3G), glStencilMask(3G)




                                                                                             GLCOLORMASK(3G)

Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.