upstream-man-pages/man2/xhtml/glColorMaterial.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>glColorMaterial</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glColorMaterial"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glColorMaterial — cause a material color to track 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">glColorMaterial</b>(</code></td><td>GLenum  </td><td><var class="pdparam">face</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">mode</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>face</code></em></span></dt><dd><p>
   4                     Specifies whether front,
   5                     back,
   6                     or both front and back material parameters should track the current color.
   7                     Accepted values are
   8                     <code class="constant">GL_FRONT</code>,
   9                     <code class="constant">GL_BACK</code>,
  10                     and <code class="constant">GL_FRONT_AND_BACK</code>.
  11                     The initial value is <code class="constant">GL_FRONT_AND_BACK</code>.
  12                 </p></dd><dt><span class="term"><em class="parameter"><code>mode</code></em></span></dt><dd><p>
  13                     Specifies which of several material parameters track the current color.
  14                     Accepted values are
  15                     <code class="constant">GL_EMISSION</code>,
  16                     <code class="constant">GL_AMBIENT</code>,
  17                     <code class="constant">GL_DIFFUSE</code>,
  18                     <code class="constant">GL_SPECULAR</code>,
  19                     and <code class="constant">GL_AMBIENT_AND_DIFFUSE</code>.
  20                     The initial value is <code class="constant">GL_AMBIENT_AND_DIFFUSE</code>.
  21                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  22             <code class="function">glColorMaterial</code> specifies which material parameters track the current color.
  23             When <code class="constant">GL_COLOR_MATERIAL</code> is enabled,
  24             the material parameter or parameters specified by <em class="parameter"><code>mode</code></em>,
  25             of the material or materials specified by <em class="parameter"><code>face</code></em>,
  26             track the current color at all times.
  27         </p><p>
  28             To enable and disable <code class="constant">GL_COLOR_MATERIAL</code>, call
  29             <a class="citerefentry" href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> and <a class="citerefentry" href="glDisable.xml"><span class="citerefentry"><span class="refentrytitle">glDisable</span></span></a> with argument <code class="constant">GL_COLOR_MATERIAL</code>.
  30             <code class="constant">GL_COLOR_MATERIAL</code> is initially disabled.
  31         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  32             <code class="function">glColorMaterial</code> makes it possible to change a subset of material parameters for each
  33             vertex using only the <a class="citerefentry" href="glColor.xml"><span class="citerefentry"><span class="refentrytitle">glColor</span></span></a> command,
  34             without calling <a class="citerefentry" href="glMaterial.xml"><span class="citerefentry"><span class="refentrytitle">glMaterial</span></span></a>.
  35             If only such a subset of parameters is to be specified for each
  36             vertex, calling <code class="function">glColorMaterial</code> is preferable to calling <a class="citerefentry" href="glMaterial.xml"><span class="citerefentry"><span class="refentrytitle">glMaterial</span></span></a>.
  37         </p><p>
  38             Call <code class="function">glColorMaterial</code> before enabling <code class="constant">GL_COLOR_MATERIAL</code>.
  39         </p><p>
  40             Calling <a class="citerefentry" href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>, <a class="citerefentry" href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>, or <a class="citerefentry" href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>
  41             may leave the current color indeterminate, if the color array is enabled.
  42             If
  43             <code class="function">glColorMaterial</code> is enabled while the current color is indeterminate, the
  44             lighting material state specified by <em class="parameter"><code>face</code></em> and <em class="parameter"><code>mode</code></em> is also indeterminate.
  45         </p><p>
  46             If the GL version is 1.1 or greater, and <code class="constant">GL_COLOR_MATERIAL</code> is
  47             enabled, evaluated color values affect the results of the lighting
  48             equation as if the current color were being modified, but no change is
  49             made to the tracking lighting parameter of the current color.
  50         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  51             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>face</code></em> or <em class="parameter"><code>mode</code></em> is not an
  52             accepted value.
  53         </p><p>
  54             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glColorMaterial</code> is executed between
  55             the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  56         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  57             <a class="citerefentry" href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_COLOR_MATERIAL</code>
  58         </p><p>
  59             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COLOR_MATERIAL_PARAMETER</code>
  60         </p><p>
  61             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COLOR_MATERIAL_FACE</code>
  62         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  63             <a class="citerefentry" href="glColor.xml"><span class="citerefentry"><span class="refentrytitle">glColor</span></span></a>,
  64             <a class="citerefentry" href="glColorPointer.xml"><span class="citerefentry"><span class="refentrytitle">glColorPointer</span></span></a>,
  65             <a class="citerefentry" href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>,
  66             <a class="citerefentry" href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,
  67             <a class="citerefentry" href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,
  68             <a class="citerefentry" href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a>,
  69             <a class="citerefentry" href="glLight.xml"><span class="citerefentry"><span class="refentrytitle">glLight</span></span></a>,
  70             <a class="citerefentry" href="glLightModel.xml"><span class="citerefentry"><span class="refentrytitle">glLightModel</span></span></a>,
  71             <a class="citerefentry" href="glMaterial.xml"><span class="citerefentry"><span class="refentrytitle">glMaterial</span></span></a>
  72         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  73             Copyright <span class="trademark"></span>© 1991-2006
  74             Silicon Graphics, Inc. This document is licensed under the SGI
  75             Free Software B License. For details, see
  76             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  77         </p></div></div></body></html>