File: glColorMask.3G.xml

package info (click to toggle)
pyopengl 2.0.1.08-5.1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 19,484 kB
  • ctags: 9,036
  • sloc: pascal: 64,950; xml: 28,088; ansic: 20,696; python: 19,761; tcl: 668; makefile: 240; sh: 25
file content (26 lines) | stat: -rw-r--r-- 5,027 bytes parent folder | download 
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
 
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
	xmlns="http://www.w3.org/1999/xhtml"
	xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>glColorMask</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GL.xml" title="GL"/><link rel="previous" href="glColor.3G.xml" title="glColor"/><link rel="next" href="glColorMaterial.3G.xml" title="glColorMaterial"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">glColorMask</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glColor.3G.xml">Prev</a></td><th width="60%" align="center">GL</th><td width="20%" align="right"><a accesskey="n" href="glColorMaterial.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glColorMask.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glColorMask.3G-name"/><h2>Name</h2><p>glColorMask &#8212; enable and disable writing of frame buffer color components</p></div><div class="refsynopsisdiv"><a name="glColorMask.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void<tt>glColorMask</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLboolean<i><tt>red</tt></i>, GLboolean<i><tt>green</tt></i>, GLboolean<i><tt>blue</tt></i>, GLboolean<i><tt>alpha</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glColorMask.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glColorMask</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>red</tt></i>, <i><tt>green</tt></i>, <i><tt>blue</tt></i>, <i><tt>alpha</tt></i>) &#8594;<tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glColorMask.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>red</tt></i>, </span><span class="term"><i><tt>green</tt></i>, </span><span class="term"><i><tt>blue</tt></i>, </span><span class="term"><i><tt>alpha</tt></i></span></dt><dd>
						Specify whether red, green, blue, and alpha can or cannot be written into the frame buffer. The initial
						values are all <tt>GL_TRUE</tt>, indicating that the color components can be written.
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="glColorMask.3G-description"/><h2>Description</h2><p>
			<tt>glColorMask</tt> specifies whether the individual color components in the frame buffer can or cannot be
			written. If <i><tt>red</tt></i> is <tt>GL_FALSE</tt>, 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"><a name="glColorMask.3G-errors"/><h2>Errors</h2><p>
			<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glColorMask</tt> is executed between the
			execution of <a href="glBegin.3G.xml"><tt>glBegin</tt></a> and the corresponding execution of <a href="glBegin.3G.xml"><tt>glEnd</tt></a>.
		</p></div><div class="refsect1" lang="en"><a name="glColorMask.3G-associated_gets"/><h2>Associated Gets</h2><p>
			<tt>glGet</tt> with argument <tt>GL_COLOR_WRITEMASK</tt>
		</p><p>
			<tt>glGet</tt> with argument <tt>GL_RGBA_MODE</tt>
		</p></div><div class="refsect1" lang="en"><a name="glColorMask.3G-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="glClear.3G.xml">glClear</a>, <a href="glColor.3G.xml">glColor</a>, <a href="glColorPointer.3G.xml">glColorPointer</a>, <a href="glDepthMask.3G.xml">glDepthMask</a>, <a href="glIndex.3G.xml">glIndex</a>, <a href="glIndexPointer.3G.xml">glIndexPointer</a>, <a href="glIndexMask.3G.xml">glIndexMask</a>, <a href="glStencilMask.3G.xml">glStencilMask</a></span>
		</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glColor.3G.xml">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="reference-GL.xml">Up</a></td><td width="40%" align="right"><a accesskey="n" href="glColorMaterial.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glColor</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glColorMaterial</td></tr></table></div></body></html>