upstream-doc/man2/xhtml/glColor.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?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" /><title>glColor</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glColor"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glColor — set the current color</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">glColor3b</b>(</code></td><td>GLbyte  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLbyte  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLbyte  </td><td><var class="pdparam">blue</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">glColor3s</b>(</code></td><td>GLshort  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLshort  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLshort  </td><td><var class="pdparam">blue</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">glColor3i</b>(</code></td><td>GLint  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">blue</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">glColor3f</b>(</code></td><td>GLfloat  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLfloat  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLfloat  </td><td><var class="pdparam">blue</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">glColor3d</b>(</code></td><td>GLdouble  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">blue</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">glColor3ub</b>(</code></td><td>GLubyte  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLubyte  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLubyte  </td><td><var class="pdparam">blue</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">glColor3us</b>(</code></td><td>GLushort  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLushort  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLushort  </td><td><var class="pdparam">blue</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">glColor3ui</b>(</code></td><td>GLuint  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">blue</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">glColor4b</b>(</code></td><td>GLbyte  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLbyte  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLbyte  </td><td><var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLbyte  </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">glColor4s</b>(</code></td><td>GLshort  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLshort  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLshort  </td><td><var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLshort  </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">glColor4i</b>(</code></td><td>GLint  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLint  </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">glColor4f</b>(</code></td><td>GLfloat  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLfloat  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLfloat  </td><td><var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLfloat  </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">glColor4d</b>(</code></td><td>GLdouble  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLdouble  </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">glColor4ub</b>(</code></td><td>GLubyte  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLubyte  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLubyte  </td><td><var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLubyte  </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">glColor4us</b>(</code></td><td>GLushort  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLushort  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLushort  </td><td><var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLushort  </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">glColor4ui</b>(</code></td><td>GLuint  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLuint  </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>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></dt><dd><p>
   4                     Specify new red, green, and blue values for the current color.
   5                 </p></dd><dt><span class="term"><em class="parameter"><code>alpha</code></em></span></dt><dd><p>
   6                     Specifies a new alpha value for the current color.
   7                     Included only in the four-argument <code class="function">glColor4</code> commands.
   8                 </p></dd></dl></div></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">glColor3bv</b>(</code></td><td>const GLbyte *  </td><td><var class="pdparam">v</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">glColor3sv</b>(</code></td><td>const GLshort *  </td><td><var class="pdparam">v</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">glColor3iv</b>(</code></td><td>const GLint *  </td><td><var class="pdparam">v</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">glColor3fv</b>(</code></td><td>const GLfloat *  </td><td><var class="pdparam">v</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">glColor3dv</b>(</code></td><td>const GLdouble *  </td><td><var class="pdparam">v</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">glColor3ubv</b>(</code></td><td>const GLubyte *  </td><td><var class="pdparam">v</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">glColor3usv</b>(</code></td><td>const GLushort *  </td><td><var class="pdparam">v</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">glColor3uiv</b>(</code></td><td>const GLuint *  </td><td><var class="pdparam">v</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">glColor4bv</b>(</code></td><td>const GLbyte *  </td><td><var class="pdparam">v</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">glColor4sv</b>(</code></td><td>const GLshort *  </td><td><var class="pdparam">v</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">glColor4iv</b>(</code></td><td>const GLint *  </td><td><var class="pdparam">v</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">glColor4fv</b>(</code></td><td>const GLfloat *  </td><td><var class="pdparam">v</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">glColor4dv</b>(</code></td><td>const GLdouble *  </td><td><var class="pdparam">v</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">glColor4ubv</b>(</code></td><td>const GLubyte *  </td><td><var class="pdparam">v</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">glColor4usv</b>(</code></td><td>const GLushort *  </td><td><var class="pdparam">v</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">glColor4uiv</b>(</code></td><td>const GLuint *  </td><td><var class="pdparam">v</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters2"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>v</code></em></span></dt><dd><p>
   9                     Specifies a pointer to an array that contains red, green, blue,
  10                     and (sometimes) alpha values.
  11                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  12             The GL stores both a current single-valued color index
  13             and a current four-valued RGBA color.
  14             <code class="function">glColor</code> sets a new four-valued RGBA color.
  15             <code class="function">glColor</code> has two major variants:
  16             <code class="function">glColor3</code> and <code class="function">glColor4</code>.
  17             <code class="function">glColor3</code> variants specify new red,
  18             green,
  19             and blue values explicitly
  20             and set the current alpha value to 1.0 (full intensity) implicitly.
  21             <code class="function">glColor4</code> variants specify all four color components explicitly.
  22         </p><p>
  23             <code class="function">glColor3b</code>, <code class="function">glColor4b</code>,
  24             <code class="function">glColor3s</code>, <code class="function">glColor4s</code>, <code class="function">glColor3i</code>, and <code class="function">glColor4i</code> take
  25             three or four signed byte, short, or long integers as arguments.
  26             When <span class="bold"><strong>v</strong></span> is appended to the name,
  27             the color commands can take a pointer to an array of such values.
  28         </p><p>
  29             Current color values are stored in floating-point format,
  30             with unspecified mantissa and exponent sizes.
  31             Unsigned integer color components,
  32             when specified,
  33             are linearly mapped to floating-point values such that the largest
  34             representable value maps to 1.0 (full intensity),
  35             and 0 maps to 0.0 (zero intensity).
  36             Signed integer color components,
  37             when specified,
  38             are linearly mapped to floating-point values such that the most positive
  39             representable value maps to 1.0,
  40             and the most negative representable value maps to
  41             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  42
  43                 <mml:mn>-1.0</mml:mn>
  44             </mml:math>.
  45             (Note that
  46             this mapping does not convert 0 precisely to 0.0.)
  47             Floating-point values are mapped directly.
  48         </p><p>
  49             Neither floating-point nor signed integer values are clamped
  50             to the range
  51             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  52
  53                 <mml:mfenced open="[" close="]">
  54                     <mml:mn>0</mml:mn>
  55                     <mml:mn>1</mml:mn>
  56                 </mml:mfenced>
  57             </mml:math>
  58             before the current color is updated.
  59             However,
  60             color components are clamped to this range before they are interpolated
  61             or written into a color buffer.
  62         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  63             The initial value for the current color is (1, 1, 1, 1).
  64         </p><p>
  65             The current color can be updated at any time.
  66             In particular,
  67             <code class="function">glColor</code> can be called between a call to <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding
  68             call to <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  69         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  70             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_CURRENT_COLOR</code>
  71         </p><p>
  72             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_RGBA_MODE</code>
  73         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  74             <code class="function">glColorPointer</code>,
  75             <a class="citerefentry" href="glIndex.xml"><span class="citerefentry"><span class="refentrytitle">glIndex</span></span></a>,
  76             <a class="citerefentry" href="glSecondaryColor.xml"><span class="citerefentry"><span class="refentrytitle">glSecondaryColor</span></span></a>
  77         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  78             Copyright <span class="trademark"></span>© 1991-2006
  79             Silicon Graphics, Inc. This document is licensed under the SGI
  80             Free Software B License. For details, see
  81             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  82         </p></div></div></body></html>