rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man2 / xhtml / glBlendColor.xml
CommitLineData
7faf1d71
AW
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>glBlendColor</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glBlendColor"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBlendColor — set the blend 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">glBlendColor</b>(</code></td><td>GLclampf  </td><td><var class="pdparam">red</var>, </td></tr><tr><td> </td><td>GLclampf  </td><td><var class="pdparam">green</var>, </td></tr><tr><td> </td><td>GLclampf  </td><td><var class="pdparam">blue</var>, </td></tr><tr><td> </td><td>GLclampf  </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><span class="term"><em class="parameter"><code>alpha</code></em></span></dt><dd><p>
4 specify the components of <code class="constant">GL_BLEND_COLOR</code>
5 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
6 The <code class="constant">GL_BLEND_COLOR</code> may be used to calculate the source and destination
7 blending factors. The color components are clamped to the range
8 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
9
10 <mml:mfenced open="[" close="]">
11 <mml:mn>0</mml:mn>
12 <mml:mn>1</mml:mn>
13 </mml:mfenced>
14 </mml:math>
15 before being stored. See <a class="citerefentry" href="glBlendFunc.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a> for a complete description of the
16 blending operations.
17 Initially the <code class="constant">GL_BLEND_COLOR</code> is set to (0, 0, 0, 0).
18 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
19 <code class="function">glBlendColor</code> is part of the <code class="code">ARB_imaging</code> subset. <code class="function">glBlendColor</code> is present only
20 if <code class="code">ARB_imaging</code> is returned when <a class="citerefentry" href="glGetString.xml"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a> is called with
21 <code class="constant">GL_EXTENSIONS</code> as its argument.
22 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
23 <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glBlendColor</code> is executed
24 between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding
25 execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
26 </p><p>
27 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
28 <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with an argument of <code class="constant">GL_BLEND_COLOR</code>
29 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
30 <a class="citerefentry" href="glBlendEquation.xml"><span class="citerefentry"><span class="refentrytitle">glBlendEquation</span></span></a>,
31 <a class="citerefentry" href="glBlendFunc.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a>,
32 <a class="citerefentry" href="glGetString.xml"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a>
33 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
34 Copyright <span class="trademark"></span>© 1991-2006
35 Silicon Graphics, Inc. This document is licensed under the SGI
36 Free Software B License. For details, see
37 <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
38 </p></div></div></body></html>