Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
3 | <!-- saved from url=(0013)about:internet --> | |
4 | <?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" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glColorMask - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></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, glColorMaski — 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 class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><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> | |
5 | For <code class="function">glColorMaski</code>, specifies the index of the | |
6 | draw buffer whose color mask to set. | |
7 | </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> | |
8 | Specify whether red, green, blue, and alpha are to be written | |
9 | into the frame buffer. | |
10 | The initial values are all <code class="constant">GL_TRUE</code>, | |
11 | indicating that the color components are written. | |
12 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
13 | <code class="function">glColorMask</code> and <code class="function">glColorMaski</code> specify whether the individual color components in the frame buffer | |
14 | can or cannot be written. <code class="function">glColorMaski</code> sets the mask for a specific draw buffer, whereas | |
15 | <code class="function">glColorMask</code> sets the mask for all draw buffers. | |
16 | If <em class="parameter"><code>red</code></em> is <code class="constant">GL_FALSE</code>, | |
17 | for example, | |
18 | no change is made to the red component of any pixel in any of the | |
19 | color buffers, | |
20 | regardless of the drawing operation attempted. | |
21 | </p><p> | |
22 | Changes to individual bits of components cannot be controlled. | |
23 | Rather, | |
24 | changes are either enabled or disabled for entire color components. | |
25 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
26 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COLOR_WRITEMASK</code> | |
27 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
28 | <a href="glClear.xml"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a>, | |
29 | <a href="glDepthMask.xml"><span class="citerefentry"><span class="refentrytitle">glDepthMask</span></span></a>, | |
30 | <a href="glStencilMask.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a> | |
31 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
32 | Copyright <span class="trademark"></span>© 1991-2006 | |
33 | Silicon Graphics, Inc. | |
34 | Copyright <span class="trademark"></span>© 2010-2011 Khronos Group. | |
35 | This document is licensed under the SGI | |
36 | Free Software B License. For details, see | |
37 | <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. | |
38 | </p></div></div></body></html> |