- initial import
- initial import
git-svn-id: https://siedziba.pl:790/svn/repos/php-imlib/trunk@7 455248ca-bdda-0310-9134-f4ebb693071a
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- Generated with PHPDoc, http://www.phpdoc.de -->
<html>
<head>
<title>PHP Imlib2 Classes - Imlib - Class: ImlibColor</title>
<link href="phpdoc.css" rel="stylesheet" type="text/css">
</head>
<body>
<table width="100%" border="0">
<tr>
<td align="left" valign="top" bgcolor="#B0BAFF">
<table width="100%">
<tr>
<td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
<td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
<td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
<td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
<td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
<td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
</tr>
</table>
</td>
</tr>
<tr>
<td height="20" align="left" valign="top"><hr></td>
</tr>
<tr>
<td align="left" valign="top">
File: <a href="file:///home/matt/src/cvs/imlib/docs/class.ImlibColor.php" target="_new">/home/matt/src/cvs/imlib/docs/class.ImlibColor.php</a>
<h5>PHP Imlib2 Classes - Imlib</h5>
<h1>ImlibColor</h1>
ImlibColor<br>
<p>
Provides variables and methods for handling color
<p>
</td>
</tr>
<tr>
<td align="left" valign="top">
<h4>public class ImlibColor </h4>
Provides variables and methods for handling color
<br>
The variables and methods in this class provide a way to get and set thecolor to be used by any text or drawing functions.
<p>
<table>
<tr><td align="left" valign="top">Authors</td><td align="left" valign="top">Matt McClanahan <<a href="mailto:cardinal@dodds.net">cardinal@dodds.net</a>></td></tr>
<tr><td align="left" valign="top">Version</td><td align="left" valign="top">0.3</td></tr>
</table>
</td>
</tr>
<tr>
<td height="10" align="left" valign="top"> </td>
</tr>
<tr>
<td align="left" valign="top">
<b>Direct known subclasses:</b> <a href="ImlibCliprect.html">ImlibCliprect</a>, <a href="ImlibText.html">ImlibText</a>
</td>
</tr>
<tr>
<td height="20" align="left" valign="top"><hr></td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td colspan="2" align="left" valign="top"><h2>Public Method Summary</h2></td>
</tr>
<tr>
<td align="right" valign="top">void</td>
<td align="left" valign="top" width="100%"><a href="#function_ImlibColor()"><h4>ImlibColor()</h4></a>ImlibColor constructor</td>
</tr>
<tr>
<td align="right" valign="top">mixed</td>
<td align="left" valign="top" width="100%"><a href="#function_get_color()"><h4>get_color(int &$r, int &$g, int &$b, int &$a)</h4></a>Get the four color components as by-reference variables</td>
</tr>
<tr>
<td align="right" valign="top">mixed</td>
<td align="left" valign="top" width="100%"><a href="#function_get_color_array()"><h4>get_color_array()</h4></a>Get the color array currently defined, if it is defined</td>
</tr>
<tr>
<td align="right" valign="top">void</td>
<td align="left" valign="top" width="100%"><a href="#function_set_color()"><h4>set_color(int $r, int $g, int $b, int $a)</h4></a>Set the current color using the four components</td>
</tr>
<tr>
<td align="right" valign="top">void</td>
<td align="left" valign="top" width="100%"><a href="#function_set_color_array()"><h4>set_color_array(array $arr)</h4></a>Set the current color using an array of 4 elements (r,g,b,a)</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td colspan="2" align="left" valign="top"><h2>Private Field Summary</h2></td>
</tr>
<tr>
<td align="right" valign="top">array</td>
<td align="left" valign="top" width="100%"><a href="#variable_$color"><h4>$color</h4></a>The array defining the color (r,g,b,a)</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td colspan="2" align="left" valign="top"><h2>Public Method Details</h2></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_ImlibColor()"><h4>ImlibColor</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public void ImlibColor( )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
ImlibColor constructor
<br>
<p>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>void <p></td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_get_color()"><h4>get_color</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public mixed get_color( int &$r, int &$g, int &$b, int &$a )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Get the four color components as by-reference variables
<br>
<p>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top">Parameter</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">&$r</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">Red</td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">&$g</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">Blue</td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">&$b</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">Green</td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">&$a</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">Alpha</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>mixed <p>False if a color isn't set, the color array otherwise</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_get_color_array()"><h4>get_color_array</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public mixed get_color_array( )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Get the color array currently defined, if it is defined
<br>
<p>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>mixed <p>False if a color isn't set, the color array otherwise</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_set_color()"><h4>set_color</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public void set_color( int $r, int $g, int $b, int $a )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Set the current color using the four components
<br>
<p>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top">Parameter</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">$r</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top"></td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">$g</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top"></td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">$b</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top"></td>
</tr>
</table>
</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">int</td>
<td align="left" valign="top">$a</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top"></td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>void <p></td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="function_set_color_array()"><h4>set_color_array</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>public void set_color_array( array $arr )</b><p>
</td>
</tr>
<tr>
<td width="10" align="left" valign="top"> </td>
<td align="left" valign="top">
Set the current color using an array of 4 elements (r,g,b,a)
<br>
<p>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top">Parameter</td>
</tr>
<tr>
<td></td>
<td align="left" valign="top">
<table>
<tr>
<td align="left" valign="top">array</td>
<td align="left" valign="top">$arr</td>
<td align="left" valign="top"><code></code></td>
</tr>
<tr>
<td></td>
<td colspan="2" align="left" valign="top">array</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Returns</td>
<td>void <p></td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
</table>
</tr>
<tr>
<td align="left" valign="top">
<table width="100%" border="0">
<tr>
<td colspan="2" align="left" valign="top"><h2>Private Field Details</h2></td>
</tr>
<tr><td colspan="2" align="left" valign="top"><a name="variable_$color"><h4>$color</h4></a></td></tr>
<tr>
<td colspan="2" align="left" valign="top">
<b>private array $color</b>
<p>
>><code></code><<
<p>
The array defining the color (r,g,b,a)
<br>
</td>
</tr>
<tr>
<td colspan="2" align="left" valign="top"><hr></td>
</tr>
</table>
</tr>
<tr>
<td height="10" align="left" valign="top"><hr></td>
</tr>
<tr>
<td align="left" valign="top" bgcolor="#C0C0C0">
<table>
<tr>
<td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
<td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
<td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
<td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
<td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
<td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">PHPDoc 1.0beta</td>
</tr>
</table>
</body>
</html>