Return to glColorMask.xml CVS log

Up to [Development] / projects / ogl-sample / main / doc / gles / xml

OpenGL ES 1.0 and EGL 1.0 reference manual and man pages (written by
Claude Knaus, based on OpenGL SI man pages).

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "DTD/docbook/docbookx.dtd">

<!--
  License Applicability. Except to the extent portions of this file are
  made subject to an alternative license as permitted in the SGI Free
  Software License B, Version 1.1 (the "License"), the contents of this
  file are subject only to the provisions of the License. You may not use
  this file except in compliance with the License. You may obtain a copy
  of the License at Silicon Graphics, Inc., attn: Legal Services, 1600
  Amphitheatre Parkway, Mountain View, CA 94043-1351, or at:

  http://oss.sgi.com/projects/FreeB

  Note that, as provided in the License, the Software is distributed on an
  "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS
  DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND
  CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A
  PARTICULAR PURPOSE, AND NON-INFRINGEMENT.

  Original Code. The Original Code is: OpenGL ES Reference Manual,
  Version 1.0, released September 2003, developed by Silicon Graphics,
  Inc.  The Original Code is Copyright (c) 2003 Silicon Graphics, Inc.
  Copyright in any portions created by third parties is as indicated
  elsewhere herein.  All Rights Reserved.
-->

<refentry id="glColorMask">
  <refmeta>
    <refentrytitle>glColorMask</refentrytitle>
    <manvolnum>3G</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>glColorMask</refname>
    <refpurpose>enable and disable writing of color buffer
    components</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>C Specification</title>

    <funcsynopsis>
      <funcprototype>
        <funcdef>void <function>glColorMask</function></funcdef>
        <paramdef>GLboolean <parameter>red</parameter></paramdef>
        <paramdef>GLboolean <parameter>green</parameter></paramdef>
        <paramdef>GLboolean <parameter>blue</parameter></paramdef>
        <paramdef>GLboolean <parameter>alpha</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>
        <parameter>red</parameter>, 
        <parameter>green</parameter>, 
        <parameter>blue</parameter>, 
        <parameter>alpha</parameter>
        </term>

        <listitem>
          <para>Specify whether red, green, blue, and alpha can or
          cannot be written into the color buffer. The initial
          values are all <constant>GL_TRUE</constant>,
          indicating that all color components can be written.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>
    <function>glColorMask</function>
    specifies whether the individual components in the color
    buffer can or cannot be written. If <parameter>red</parameter> is 
    <constant>GL_FALSE</constant>,
    for example, no change is made to the red component of any
    pixel in the color buffer, regardless of the drawing operation
    attempted, including
    <citerefentry><refentrytitle>glClear</refentrytitle></citerefentry>.
    </para>

    <para>Changes to individual bits of components cannot be
    controlled. Rather, changes are either enabled or disabled for
    entire color components.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <para>
    <citerefentry><refentrytitle>glClear</refentrytitle></citerefentry>, 
    <citerefentry><refentrytitle>glColor</refentrytitle></citerefentry>, 
    <citerefentry><refentrytitle>glColorPointer</refentrytitle></citerefentry>, 
    <citerefentry><refentrytitle>glDepthMask</refentrytitle></citerefentry>, 
    <citerefentry><refentrytitle>glStencilMask</refentrytitle></citerefentry>
    </para>
  </refsect1>
</refentry>