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

Class: Gradient

Source Location: /painter.php

Class Gradient

Class Overview

Encapsulates a gradient.

Located in /painter.php [line 854]



		
		
		
		

Methods

[ Top ]
Method Summary
Gradient   Gradient()   Creates a new Gradient object.
void   Add()   Inserts a colour to be used at $percent percent of the way through the gradient.
Colour   GetColour()   Returns the colour to use at a point in a gradient.

[ Top ]
Methods
Constructor Gradient  [line 866]

  Gradient Gradient( Colour $start, Colour $end  )

Creates a new Gradient object.

Parameters:
Colour   $start:  The start colour.
Colour   $end:  The end colour.


[ Top ]
Add  [line 882]

  void Add( Colour $clr, int $percent  )

Inserts a colour to be used at $percent percent of the way through the gradient.

Parameters:
Colour   $clr:  The colour to add.
int   $percent:  The percent of the way through.


[ Top ]
GetColour  [line 898]

  Colour GetColour( int $pos, int $w  )

Returns the colour to use at a point in a gradient.

Parameters:
int   $pos:  The position in the rendering.
int   $w:  The width of the gradient area.


[ Top ]

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