<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csutil/cscolor.h File Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>csutil/cscolor.h File Reference</h1>Floating-point color. <a href="#_details">More...</a> <p> <code>#include "csextern.h"</code><br> <p> <a href="cscolor_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Classes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsColor.html">csColor</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A class used to represent a color in RGB space. <a href="classcsColor.html#_details">More...</a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsColor4.html">csColor4</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A class used to represent a color in RGBA space. <a href="classcsColor4.html#_details">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor4.html">csColor4</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#3c40aa3d0784f8bf39a80b2b89d4a339">operator *</a> (float f, const <a class="el" href="classcsColor4.html">csColor4</a> &s)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Multiply a scalar value by a color. <a href="#3c40aa3d0784f8bf39a80b2b89d4a339"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor4.html">csColor4</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#888e62de0c007ced8e7be19b25971043">operator *</a> (const <a class="el" href="classcsColor4.html">csColor4</a> &s, float f)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Multiply a color by a scalar value. <a href="#888e62de0c007ced8e7be19b25971043"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor4.html">csColor4</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#e11a8dd2047b41a3f192821162e44c7c">operator *</a> (const <a class="el" href="classcsColor4.html">csColor4</a> &v1, const <a class="el" href="classcsColor4.html">csColor4</a> &v2)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Multiply two colors. <a href="#e11a8dd2047b41a3f192821162e44c7c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor.html">csColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#82caddc4371c98306c07f0be90317a1d">operator *</a> (float f, const <a class="el" href="classcsColor.html">csColor</a> &s)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Multiply a scalar value by a color. <a href="#82caddc4371c98306c07f0be90317a1d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor.html">csColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#0ea2521eed4493c04620d2b4873f9a07">operator *</a> (const <a class="el" href="classcsColor.html">csColor</a> &s, float f)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Multiply a color by a scalar value. <a href="#0ea2521eed4493c04620d2b4873f9a07"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor.html">csColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#c99c344a2408f1e1928b247db5d64365">operator *</a> (const <a class="el" href="classcsColor.html">csColor</a> &v1, const <a class="el" href="classcsColor.html">csColor</a> &v2)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Multiply two colors. <a href="#c99c344a2408f1e1928b247db5d64365"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor4.html">csColor4</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#d68d66f341f4072ac5ec609287514c48">operator+</a> (const <a class="el" href="classcsColor4.html">csColor4</a> &s1, const <a class="el" href="classcsColor4.html">csColor4</a> &s2)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add two colors. <a href="#d68d66f341f4072ac5ec609287514c48"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor.html">csColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#4152cd06665dffa1b7bded50af1bbe34">operator+</a> (const <a class="el" href="classcsColor.html">csColor</a> &s1, const <a class="el" href="classcsColor.html">csColor</a> &s2)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add two colors. <a href="#4152cd06665dffa1b7bded50af1bbe34"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor4.html">csColor4</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#d095999a9f16e965e1e0f5dcc5dc6f05">operator-</a> (const <a class="el" href="classcsColor4.html">csColor4</a> &s1, const <a class="el" href="classcsColor4.html">csColor4</a> &s2)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Subtract two colors. <a href="#d095999a9f16e965e1e0f5dcc5dc6f05"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor.html">csColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#55e738db674cbea902cb06597df8dacf">operator-</a> (const <a class="el" href="classcsColor.html">csColor</a> &s1, const <a class="el" href="classcsColor.html">csColor</a> &s2)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Subtract two colors. <a href="#55e738db674cbea902cb06597df8dacf"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor4.html">csColor4</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#272b0e32b5c29c0489ab7eaad9fde14e">operator/</a> (const <a class="el" href="classcsColor4.html">csColor4</a> &v, float f)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Divide a color by a scalar. <a href="#272b0e32b5c29c0489ab7eaad9fde14e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor.html">csColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cscolor_8h.html#a9b4d9b2f7603a763b65c580bf00eaad">operator/</a> (const <a class="el" href="classcsColor.html">csColor</a> &v, float f)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Divide a color by a scalar. <a href="#a9b4d9b2f7603a763b65c580bf00eaad"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Floating-point color. <p> <p>Definition in file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> <hr><h2>Function Documentation</h2> <a class="anchor" name="3c40aa3d0784f8bf39a80b2b89d4a339"></a><!-- doxytag: member="cscolor.h::operator *" ref="3c40aa3d0784f8bf39a80b2b89d4a339" args="(float f, const csColor4 &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor4.html">csColor4</a> operator * </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>f</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> & </td> <td class="paramname"> <em>s</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Multiply a scalar value by a color. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00270">270</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> </div> </div><p> <a class="anchor" name="888e62de0c007ced8e7be19b25971043"></a><!-- doxytag: member="cscolor.h::operator *" ref="888e62de0c007ced8e7be19b25971043" args="(const csColor4 &s, float f)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor4.html">csColor4</a> operator * </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> & </td> <td class="paramname"> <em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>f</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Multiply a color by a scalar value. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00266">266</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> </div> </div><p> <a class="anchor" name="e11a8dd2047b41a3f192821162e44c7c"></a><!-- doxytag: member="cscolor.h::operator *" ref="e11a8dd2047b41a3f192821162e44c7c" args="(const csColor4 &v1, const csColor4 &v2)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor4.html">csColor4</a> operator * </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> & </td> <td class="paramname"> <em>v1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> & </td> <td class="paramname"> <em>v2</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Multiply two colors. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00257">257</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> <p>References <a class="el" href="cscolor_8h-source.html#l00041">csColor::blue</a>, <a class="el" href="cscolor_8h-source.html#l00039">csColor::green</a>, and <a class="el" href="cscolor_8h-source.html#l00037">csColor::red</a>.</p> </div> </div><p> <a class="anchor" name="82caddc4371c98306c07f0be90317a1d"></a><!-- doxytag: member="cscolor.h::operator *" ref="82caddc4371c98306c07f0be90317a1d" args="(float f, const csColor &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor.html">csColor</a> operator * </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>f</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td> <td class="paramname"> <em>s</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Multiply a scalar value by a color. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00142">142</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> </div> </div><p> <a class="anchor" name="0ea2521eed4493c04620d2b4873f9a07"></a><!-- doxytag: member="cscolor.h::operator *" ref="0ea2521eed4493c04620d2b4873f9a07" args="(const csColor &s, float f)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor.html">csColor</a> operator * </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td> <td class="paramname"> <em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>f</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Multiply a color by a scalar value. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00138">138</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> </div> </div><p> <a class="anchor" name="c99c344a2408f1e1928b247db5d64365"></a><!-- doxytag: member="cscolor.h::operator *" ref="c99c344a2408f1e1928b247db5d64365" args="(const csColor &v1, const csColor &v2)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor.html">csColor</a> operator * </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td> <td class="paramname"> <em>v1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td> <td class="paramname"> <em>v2</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Multiply two colors. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00129">129</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> <p>References <a class="el" href="cscolor_8h-source.html#l00041">csColor::blue</a>, <a class="el" href="cscolor_8h-source.html#l00039">csColor::green</a>, and <a class="el" href="cscolor_8h-source.html#l00037">csColor::red</a>.</p> </div> </div><p> <a class="anchor" name="d68d66f341f4072ac5ec609287514c48"></a><!-- doxytag: member="cscolor.h::operator+" ref="d68d66f341f4072ac5ec609287514c48" args="(const csColor4 &s1, const csColor4 &s2)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor4.html">csColor4</a> operator+ </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> & </td> <td class="paramname"> <em>s1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> & </td> <td class="paramname"> <em>s2</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Add two colors. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00274">274</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> </div> </div><p> <a class="anchor" name="4152cd06665dffa1b7bded50af1bbe34"></a><!-- doxytag: member="cscolor.h::operator+" ref="4152cd06665dffa1b7bded50af1bbe34" args="(const csColor &s1, const csColor &s2)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor.html">csColor</a> operator+ </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td> <td class="paramname"> <em>s1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td> <td class="paramname"> <em>s2</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Add two colors. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00146">146</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> </div> </div><p> <a class="anchor" name="d095999a9f16e965e1e0f5dcc5dc6f05"></a><!-- doxytag: member="cscolor.h::operator-" ref="d095999a9f16e965e1e0f5dcc5dc6f05" args="(const csColor4 &s1, const csColor4 &s2)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor4.html">csColor4</a> operator- </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> & </td> <td class="paramname"> <em>s1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> & </td> <td class="paramname"> <em>s2</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Subtract two colors. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00277">277</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> </div> </div><p> <a class="anchor" name="55e738db674cbea902cb06597df8dacf"></a><!-- doxytag: member="cscolor.h::operator-" ref="55e738db674cbea902cb06597df8dacf" args="(const csColor &s1, const csColor &s2)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor.html">csColor</a> operator- </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td> <td class="paramname"> <em>s1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td> <td class="paramname"> <em>s2</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Subtract two colors. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00149">149</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> </div> </div><p> <a class="anchor" name="272b0e32b5c29c0489ab7eaad9fde14e"></a><!-- doxytag: member="cscolor.h::operator/" ref="272b0e32b5c29c0489ab7eaad9fde14e" args="(const csColor4 &v, float f)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor4.html">csColor4</a> operator/ </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> & </td> <td class="paramname"> <em>v</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>f</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Divide a color by a scalar. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00254">254</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> <p>References <a class="el" href="cscolor_8h-source.html#l00041">csColor::blue</a>, <a class="el" href="cscolor_8h-source.html#l00039">csColor::green</a>, and <a class="el" href="cscolor_8h-source.html#l00037">csColor::red</a>.</p> </div> </div><p> <a class="anchor" name="a9b4d9b2f7603a763b65c580bf00eaad"></a><!-- doxytag: member="cscolor.h::operator/" ref="a9b4d9b2f7603a763b65c580bf00eaad" args="(const csColor &v, float f)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsColor.html">csColor</a> operator/ </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> & </td> <td class="paramname"> <em>v</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>f</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Divide a color by a scalar. <p> <p>Definition at line <a class="el" href="cscolor_8h-source.html#l00126">126</a> of file <a class="el" href="cscolor_8h-source.html">cscolor.h</a>.</p> <p>References <a class="el" href="cscolor_8h-source.html#l00041">csColor::blue</a>, <a class="el" href="cscolor_8h-source.html#l00039">csColor::green</a>, and <a class="el" href="cscolor_8h-source.html#l00037">csColor::red</a>.</p> </div> </div><p> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>