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 627]



		
		
		
		

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 651]

Alpha colour value.


[ Top ]
int   $B [line 645]

Blue colour value.


[ Top ]
int   $G [line 639]

Green colour value.


[ Top ]
int   $R [line 633]

Red colour value.


[ Top ]
Methods
Constructor Colour  [line 660]

  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 696]

  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 681]

  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 Thu, 27 Mar 2008 22:29:48 +0000 by phpDocumentor 1.4.1