1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
2 <!-- saved from url=(0013)about:internet -->
3 <?xml-stylesheet type=
"text/xsl" href=
"mathml.xsl"?><html xmlns=
"http://www.w3.org/1999/xhtml" xmlns:
pref=
"http://www.w3.org/2002/Math/preference" pref:
renderer=
"mathplayer-dl"><head><meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" /><title>glColorMask
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.73.2" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glColorMask"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glColorMask — enable and disable writing of frame buffer color components
</p></div><div class=
"refsynopsisdiv"><h2>C Specification
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glColorMask
</b>(
</code></td><td>GLboolean
</td><td><var class=
"pdparam">red
</var>,
</td></tr><tr><td> </td><td>GLboolean
</td><td><var class=
"pdparam">green
</var>,
</td></tr><tr><td> </td><td>GLboolean
</td><td><var class=
"pdparam">blue
</var>,
</td></tr><tr><td> </td><td>GLboolean
</td><td><var class=
"pdparam">alpha
</var><code>)
</code>;
</td></tr></table></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"parameters"></a><h2>Parameters
</h2><div class=
"variablelist"><dl><dt><span class=
"term"><em class=
"parameter"><code>red
</code></em>,
</span><span class=
"term"><em class=
"parameter"><code>green
</code></em>,
</span><span class=
"term"><em class=
"parameter"><code>blue
</code></em>,
</span><span class=
"term"><em class=
"parameter"><code>alpha
</code></em></span></dt><dd><p>
4 Specify whether red, green, blue, and alpha can or cannot be written
6 The initial values are all
<code class=
"constant">GL_TRUE
</code>,
7 indicating that the color components can be written.
8 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
9 <code class=
"function">glColorMask
</code> specifies whether the individual color components in the frame buffer
10 can or cannot be written.
11 If
<em class=
"parameter"><code>red
</code></em> is
<code class=
"constant">GL_FALSE
</code>,
13 no change is made to the red component of any pixel in any of the
15 regardless of the drawing operation attempted.
17 Changes to individual bits of components cannot be controlled.
19 changes are either enabled or disabled for entire color components.
20 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
21 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
<code class=
"function">glColorMask
</code>
22 is executed between the execution of
<a class=
"citerefentry" href=
"glBegin.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBegin
</span></span></a>
23 and the corresponding execution of
<a class=
"citerefentry" href=
"glEnd.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnd
</span></span></a>.
24 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
25 <a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_COLOR_WRITEMASK
</code>
27 <a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_RGBA_MODE
</code>
28 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
29 <a class=
"citerefentry" href=
"glClear.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClear
</span></span></a>,
30 <a class=
"citerefentry" href=
"glColor.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glColor
</span></span></a>,
31 <a class=
"citerefentry" href=
"glColorPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glColorPointer
</span></span></a>,
32 <a class=
"citerefentry" href=
"glDepthMask.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glDepthMask
</span></span></a>,
33 <a class=
"citerefentry" href=
"glIndex.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIndex
</span></span></a>,
34 <a class=
"citerefentry" href=
"glIndexPointer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIndexPointer
</span></span></a>,
35 <a class=
"citerefentry" href=
"glIndexMask.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIndexMask
</span></span></a>,
36 <a class=
"citerefentry" href=
"glStencilMask.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glStencilMask
</span></span></a>
37 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
38 Copyright
<span class=
"trademark"></span>©
1991-
2006
39 Silicon Graphics, Inc. This document is licensed under the SGI
40 Free Software B License. For details, see
41 <a class=
"ulink" href=
"http://oss.sgi.com/projects/FreeB/" target=
"_top">http://oss.sgi.com/projects/FreeB/
</a>.
42 </p></div></div></body></html>