PHP Imlib2 Classes - Imlib - Class: ImlibColor

Packageindex | Classtrees | Modulegroups | Elementlist | Report | XML Files
File: /home/matt/src/cvs/imlib/docs/class.ImlibColor.php ##### PHP Imlib2 Classes - Imlib # ImlibColor ImlibColor Provides variables and methods for handling color
#### public class ImlibColor Provides variables and methods for handling color The variables and methods in this class provide a way to get and set thecolor to be used by any text or drawing functions.
Authors | Matt McClanahan <cardinal@dodds.net>
Version | 0.3
Direct known subclasses: ImlibCliprect, ImlibText
## Public Method Summary
void | #### ImlibColor() ImlibColor constructor
mixed | #### get_color(int &$r, int &$g, int &$b, int &$a) Get the four color components as by-reference variables
mixed | #### get_color_array() Get the color array currently defined, if it is defined
void | #### set_color(int $r, int $g, int $b, int $a) Set the current color using the four components
void | #### set_color_array(array $arr) Set the current color using an array of 4 elements (r,g,b,a)
## Private Field Summary
array | #### $color The array defining the color (r,g,b,a)
## Public Method Details
#### ImlibColor
public void ImlibColor( )
| ImlibColor constructor
Returns | void
#### get_color
public mixed get_color( int &$r, int &$g, int &$b, int &$a )
| Get the four color components as by-reference variables
Parameter
int | &$r | ``
| Red
int | &$g | ``
| Blue
int | &$b | ``
| Green
int | &$a | ``
| Alpha
Returns | mixed False if a color isn't set, the color array otherwise
#### get_color_array
public mixed get_color_array( )
| Get the color array currently defined, if it is defined
Returns | mixed False if a color isn't set, the color array otherwise
#### set_color
public void set_color( int $r, int $g, int $b, int $a )
| Set the current color using the four components
Parameter
int | $r | ``
int | $g | ``
int | $b | ``
int | $a | ``
Returns | void
#### set_color_array
public void set_color_array( array $arr )
| Set the current color using an array of 4 elements (r,g,b,a)
Parameter
array | $arr | ``
| array
Returns | void
## Private Field Details
#### $color
private array $color >>``<< The array defining the color (r,g,b,a)
Packageindex | Classtrees | Modulegroups | Elementlist | Report | XML Files
PHPDoc 1.0beta