phpDocumentor Painter
[ class tree: Painter ] [ index: Painter ] [ all elements ]

Class: Colour

Source Location: /painter.php

Class Colour

Class Overview

Encapsulates a colour.

Located in /painter.php [line 695]



		
		
		
		

Properties

Methods

[ Top ]
Property Summary
int   $A   Alpha colour value.
int   $B   Blue colour value.
int   $G   Green colour value.
int   $R   Red colour value.

[ Top ]
Method Summary
Colour   Colour()   Creates a new Colour object.
void   Darken()   Darkens the colour by the percent specified by $d.
void   Lighten()   Lightens the colour by the percent specified by $d.

[ Top ]
Properties
int   $A [line 719]

Alpha colour value.


[ Top ]
int   $B [line 713]

Blue colour value.


[ Top ]
int   $G [line 707]

Green colour value.


[ Top ]
int   $R [line 701]

Red colour value.


[ Top ]
Methods
Constructor Colour  [line 728]

  Colour Colour( [int $r = -1], [int $g = -1], [int $b = -1], [int $a = 0]  )

Creates a new Colour object.

Parameters:
int   $r:  Red.
int   $g:  Green.
int   $b:  Blue.
int   $a:  Alpha.


[ Top ]
Darken  [line 764]

  void Darken( [int $d = 10]  )

Darkens the colour by the percent specified by $d.

Parameters:
int   $d:  The percentage to darken the colour by.


[ Top ]
Lighten  [line 749]

  void Lighten( [int $d = 10]  )

Lightens the colour by the percent specified by $d.

Parameters:
int   $d:  The percentage to lighten the colour by.


[ Top ]

Documentation generated on Mon, 31 Mar 2008 18:35:25 +0100 by phpDocumentor 1.4.1