Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> | |
4 | <refentry id="glColorMask"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glColorMask</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glColorMask</refname> | |
17 | <refpurpose>enable and disable writing of frame buffer color components</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>glColorMask</function></funcdef> | |
23 | <paramdef>GLboolean <parameter>red</parameter></paramdef> | |
24 | <paramdef>GLboolean <parameter>green</parameter></paramdef> | |
25 | <paramdef>GLboolean <parameter>blue</parameter></paramdef> | |
26 | <paramdef>GLboolean <parameter>alpha</parameter></paramdef> | |
27 | </funcprototype> | |
28 | </funcsynopsis> | |
29 | </refsynopsisdiv> | |
30 | <refsect1 id="parameters"><title>Parameters</title> | |
31 | <variablelist> | |
32 | <varlistentry> | |
33 | <term><parameter>red</parameter></term> | |
34 | <term><parameter>green</parameter></term> | |
35 | <term><parameter>blue</parameter></term> | |
36 | <term><parameter>alpha</parameter></term> | |
37 | <listitem> | |
38 | <para> | |
39 | Specify whether red, green, blue, and alpha can or cannot be written | |
40 | into the frame buffer. | |
41 | The initial values are all <constant>GL_TRUE</constant>, | |
42 | indicating that the color components can be written. | |
43 | </para> | |
44 | </listitem> | |
45 | </varlistentry> | |
46 | </variablelist> | |
47 | </refsect1> | |
48 | <refsect1 id="description"><title>Description</title> | |
49 | <para> | |
50 | <function>glColorMask</function> specifies whether the individual color components in the frame buffer | |
51 | can or cannot be written. | |
52 | If <parameter>red</parameter> is <constant>GL_FALSE</constant>, | |
53 | for example, | |
54 | no change is made to the red component of any pixel in any of the | |
55 | color buffers, | |
56 | regardless of the drawing operation attempted. | |
57 | </para> | |
58 | <para> | |
59 | Changes to individual bits of components cannot be controlled. | |
60 | Rather, | |
61 | changes are either enabled or disabled for entire color components. | |
62 | </para> | |
63 | </refsect1> | |
64 | <refsect1 id="errors"><title>Errors</title> | |
65 | <para> | |
66 | <constant>GL_INVALID_OPERATION</constant> is generated if <function>glColorMask</function> | |
67 | is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> | |
68 | and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>. | |
69 | </para> | |
70 | </refsect1> | |
71 | <refsect1 id="associatedgets"><title>Associated Gets</title> | |
72 | <para> | |
73 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_COLOR_WRITEMASK</constant> | |
74 | </para> | |
75 | <para> | |
76 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_RGBA_MODE</constant> | |
77 | </para> | |
78 | </refsect1> | |
79 | <refsect1 id="seealso"><title>See Also</title> | |
80 | <para> | |
81 | <citerefentry><refentrytitle>glClear</refentrytitle></citerefentry>, | |
82 | <citerefentry><refentrytitle>glColor</refentrytitle></citerefentry>, | |
83 | <citerefentry><refentrytitle>glColorPointer</refentrytitle></citerefentry>, | |
84 | <citerefentry><refentrytitle>glDepthMask</refentrytitle></citerefentry>, | |
85 | <citerefentry><refentrytitle>glIndex</refentrytitle></citerefentry>, | |
86 | <citerefentry><refentrytitle>glIndexPointer</refentrytitle></citerefentry>, | |
87 | <citerefentry><refentrytitle>glIndexMask</refentrytitle></citerefentry>, | |
88 | <citerefentry><refentrytitle>glStencilMask</refentrytitle></citerefentry> | |
89 | </para> | |
90 | </refsect1> | |
91 | <refsect1 id="Copyright"><title>Copyright</title> | |
92 | <para> | |
93 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
94 | Silicon Graphics, Inc. This document is licensed under the SGI | |
95 | Free Software B License. For details, see | |
96 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
97 | </para> | |
98 | </refsect1> | |
99 | </refentry> |