<div class="refentry" lang="en" xml:lang="en"><a id="glColorMask"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glColorMask, glColorMaski — enable and disable writing of frame buffer color components</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table><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 class="funcsynopsis"><table><tr><td><code class="funcdef">void <b class="fsfunc">glColorMaski</b>(</code></td><td>GLuint  </td><td><var class="pdparam">buf</var>, </td></tr><tr><td> </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>buf</code></em></span></dt><dd><p>

For <code class="function">glColorMaski</code>, specifies the index of the

draw buffer whose color mask to set.

</p></dd><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>

Specify whether red, green, blue, and alpha are to be written

into the frame buffer.

The initial values are all <code class="constant">GL_TRUE</code>,

indicating that the color components are written.

</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>

<code class="function">glColorMask</code> and <code class="function">glColorMaski</code> specify whether the individual color components in the frame buffer

can or cannot be written. <code class="function">glColorMaski</code> sets the mask for a specific draw buffer, whereas

<code class="function">glColorMask</code> sets the mask for all draw buffers.

If <em class="parameter"><code>red</code></em> is <code class="constant">GL_FALSE</code>,

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.

</p><p>

Changes to individual bits of components cannot be controlled.

Rather,

changes are either enabled or disabled for entire color components.

</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>

<a href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COLOR_WRITEMASK</code>

</p></div>

{$pipelinestall}{$examples}

<div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>

<a href="glClear"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a>,

<a href="glDepthMask"><span class="citerefentry"><span class="refentrytitle">glDepthMask</span></span></a>,

<a href="glStencilMask"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a>

</p></div><div class="refsect1" lang="en" xml:lang="en"><div id="Copyright"><h2>Copyright</h2><p>

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

<a href="https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/" target="_top">https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/</a>.

</p></div></div></div>