forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glColorMask.xhtml
32 lines (32 loc) · 3.5 KB
/
glColorMask.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<div class="refentry" title="glColorMask"><a id="glColorMask"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glColorMask — enable and disable writing of color buffer
components</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glColorMask</b>(</code></td><td>GLboolean <var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLboolean <var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLboolean <var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLboolean <var class="pdparam">alpha</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term">
<em class="parameter"><code>red</code></em>,
<em class="parameter"><code>green</code></em>,
<em class="parameter"><code>blue</code></em>,
<em class="parameter"><code>alpha</code></em>
</span></dt><dd><p>Specify whether red, green, blue, and alpha can or
cannot be written into the color buffer. The initial
values are all <code class="constant">GL_TRUE</code>,
indicating that all color components can be written.</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
<code class="function">glColorMask</code>
specifies whether the individual components in the color
buffer can or cannot be written. 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 the color buffer, regardless of the drawing operation
attempted, including
<a class="citerefentry" href="glClear"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a>.
</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" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glClear"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a>,
<a class="citerefentry" href="glColor"><span class="citerefentry"><span class="refentrytitle">glColor</span></span></a>,
<a class="citerefentry" href="glColorPointer"><span class="citerefentry"><span class="refentrytitle">glColorPointer</span></span></a>,
<a class="citerefentry" href="glDepthMask"><span class="citerefentry"><span class="refentrytitle">glDepthMask</span></span></a>,
<a class="citerefentry" href="glStencilMask"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a>
</p></div><div class="refsect1" title="Copyright"><a id="copyright"></a><h2>Copyright</h2><p>
Copyright © 2003-2004
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<a class="ulink" 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>