Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/matt/src/cvs/imlib/docs/class.ImlibColorRange.php
PHP Imlib2 Classes - Imlib

ImlibColorRange

ImlibColor
   |
  +-- ImlibCliprect
     |
    +-- ImlibColorRange

All functions relevant to creating and displaying color ranges

 

public class ImlibColorRange extends ImlibCliprect

All functions relevant to creating and displaying color ranges

AuthorsMatt McClanahan <cardinal@dodds.net>
Version0.3

 

Methods inherited from ImlibCliprect

imlibcliprect, get_cliprect, get_cliprect_array, get_cliprect_inuse, set_cliprect, set_cliprect_array, set_cliprect_inuse

Methods inherited from ImlibColor

imlibcolor, get_color, get_color_array, set_color, set_color_array

Public Method Summary

void

ImlibColorRange()

ImlibColorRange constructor
void

add_color(int $x, int $r, int $g, int $b, int $a)

Add a color to the color range at distance $x.
void

add_color_array(int $x, array $arr)

Add a color to the color range at distance $x.
int

create()

Create a new color range
void

free()

Free the current color range
void

fill_rectangle(int $x, int $y, int $w, int $h, int $angle)

Fill the current image with a rectangle using the current color range
void

set_image(int $im)

Set the image to draw the color range on

Fields inherited from ImlibCliprect

$cliprect, $cliprect_inuse

Fields inherited from ImlibColor

$color

Private Field Summary

unknown

$cr

Resource id# of the current color range
unknown

$im

Resource id# of the image to draw on

Public Method Details

ImlibColorRange

public void ImlibColorRange( )

  ImlibColorRange constructor

Returns void


add_color

public void add_color( int $x, int $r, int $g, int $b, int $a )

  Add a color to the color range at distance $x.
A distance of 0 will center it between the previous color and the end.$x is ignored for the first color.

Parameter
int $x
from the previous color
int $r
int $g
int $b
int $a
Returns void


add_color_array

public void add_color_array( int $x, array $arr )

  Add a color to the color range at distance $x.
A distance of 0 will center it between the previous color and the end.$x is ignored for the first color.

Parameter
int $x
from the previous color
array $arr
array (r,g,b,a)
Returns void


create

public int create( )

  Create a new color range

Returns int

Resource id# of the new color range


free

public void free( )

  Free the current color range

Returns void


fill_rectangle

public void fill_rectangle( int $x, int $y, int $w, int $h, int $angle )

  Fill the current image with a rectangle using the current color range
The color range will be filled in the specified box at angle $angle

Parameter
int $x
-left X coordinate of the box
int $y
-left Y coordinate of the box
int $w
of the box
int $h
of the box
int $angle
to rotate the color range (degrees)
Returns void


set_image

public void set_image( int $im )

  Set the image to draw the color range on

Parameter
int $im
id# of the image
Returns void


Private Field Details

$cr

private unknown $cr

>><<

Resource id# of the current color range


$im

private unknown $im

>><<

Resource id# of the image to draw on



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta