From d0a9b9a03fc7ae74ef8a64593ac6b592526ec4d5 Mon Sep 17 00:00:00 2001 From: pp Date: Wed, 19 May 2004 04:59:31 +0000 Subject: - initial import git-svn-id: https://siedziba.pl:790/svn/repos/php-imlib/trunk@7 455248ca-bdda-0310-9134-f4ebb693071a --- phpdoc/ImlibCliprect.html | 756 ++++++++++++ phpdoc/ImlibColor.html | 562 +++++++++ phpdoc/ImlibColorRange.html | 797 ++++++++++++ phpdoc/ImlibDraw.html | 1110 +++++++++++++++++ phpdoc/ImlibImage.html | 2254 ++++++++++++++++++++++++++++++++++ phpdoc/ImlibPoly.html | 880 +++++++++++++ phpdoc/ImlibText.html | 754 ++++++++++++ phpdoc/frame_packagelist.html | 23 + phpdoc/packageelementlist_Imlib.html | 66 + phpdoc/phpdoc.css | 92 ++ phpdoc/phpdoc_classtree.html | 74 ++ phpdoc/phpdoc_elementlist.html | 884 +++++++++++++ phpdoc/phpdoc_packagelist.html | 125 ++ phpdoc/phpdoc_warnings.html | 96 ++ phpdoc/phpdoc_xmlfiles.html | 63 + 15 files changed, 8536 insertions(+) create mode 100644 phpdoc/ImlibCliprect.html create mode 100644 phpdoc/ImlibColor.html create mode 100644 phpdoc/ImlibColorRange.html create mode 100644 phpdoc/ImlibDraw.html create mode 100644 phpdoc/ImlibImage.html create mode 100644 phpdoc/ImlibPoly.html create mode 100644 phpdoc/ImlibText.html create mode 100644 phpdoc/frame_packagelist.html create mode 100644 phpdoc/packageelementlist_Imlib.html create mode 100644 phpdoc/phpdoc.css create mode 100644 phpdoc/phpdoc_classtree.html create mode 100644 phpdoc/phpdoc_elementlist.html create mode 100644 phpdoc/phpdoc_packagelist.html create mode 100644 phpdoc/phpdoc_warnings.html create mode 100644 phpdoc/phpdoc_xmlfiles.html (limited to 'phpdoc') diff --git a/phpdoc/ImlibCliprect.html b/phpdoc/ImlibCliprect.html new file mode 100644 index 0000000..b5c129b --- /dev/null +++ b/phpdoc/ImlibCliprect.html @@ -0,0 +1,756 @@ + + + + + PHP Imlib2 Classes - Imlib - Class: ImlibCliprect + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

PHP Imlib2 Classes - Imlib

ImlibCliprect

+ ImlibColor
|
+-- ImlibCliprect
+

+ Provides variables and methods for a clipping rectangle +

+ +

public class ImlibCliprect extends ImlibColor

+ Provides variables and methods for a clipping rectangle +
+ The variables and methods in this class provide a clipping rectangle thatcan be used by any drawing function to restrict drawing/filling to arectangular region. +

+ + + + + + + + + +
Authors Matt McClanahan <cardinal@dodds.net>
Version 0.3
+

+ Direct known subclasses: ImlibColorRange, ImlibDraw, ImlibPoly +

+ + + + + + + +

Methods inherited from ImlibColor

imlibcolor, get_color, get_color_array, set_color, set_color_array

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Method Summary
void	ImlibCliprect() ImlibCliprect constructor
void	get_cliprect(int &$x, int &$y, int &$w, int &$h) Get the four values of the cliprect
array	get_cliprect_array() Get the array that defines the cliprect (x,y,w,h)
bool	get_cliprect_inuse() Get the boolean that determines if a cliprect is in use or not
void	set_cliprect(int $x, int $y, int $w, int $h) Set the four values of the cliprect. 0 for X disables the cliprect.
void	set_cliprect_array(array $arr) Set the array that defines the cliprect (x,y,w,h)
void	set_cliprect_inuse(bool $set) Set the boolean that determines if the cliprect is in use

+ + + + + + + +

Fields inherited from ImlibColor

$color

+ + + + + + + + + + + + + + + +

Private Field Summary
array	$cliprect The array defining the cliprect (x,y,w,h)
bool	$cliprect_inuse A boolean that determines if a cliprect is in use or not

Public Method Details

ImlibCliprect

+ public void ImlibCliprect( )

+ ImlibCliprect constructor +
+ +

+ +

Returns

void

get_cliprect

+ public void get_cliprect( int &$x, int &$y, int &$w, int &$h )

+ Get the four values of the cliprect +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	&$x
	left X coordinate to clip from

+ + + + + + + + + + +

int	&$y
	left Y coordinate to clip from

+ + + + + + + + + + +

int	&$w
	of the cliprect

+ + + + + + + + + + +

int	&$h
	of the cliprect

Returns

void

get_cliprect_array

+ public array get_cliprect_array( )

+ Get the array that defines the cliprect (x,y,w,h) +
+ +

+ +

Returns

array

Array defining the clipping rectangle

get_cliprect_inuse

+ public bool get_cliprect_inuse( )

+ Get the boolean that determines if a cliprect is in use or not +
+ +

+ +

Returns

bool

True if the cliprect is in use

set_cliprect

+ public void set_cliprect( int $x, int $y, int $w, int $h )

+ Set the four values of the cliprect. 0 for X disables the cliprect. +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$x
	left X coordinate to clip from

+ + + + + + + + + + +

int	$y
	left Y coordinate to clip from

+ + + + + + + + + + +

int	$w
	of the cliprect

+ + + + + + + + + + +

int	$h
	of the cliprect

Returns

void

set_cliprect_array

+ public void set_cliprect_array( array $arr )

+ Set the array that defines the cliprect (x,y,w,h) +
+ +

+ +

Parameter

+ + + + + + + + + + +

array	$arr
	that defines the cliprect

Returns

void

set_cliprect_inuse

+ public void set_cliprect_inuse( bool $set )

+ Set the boolean that determines if the cliprect is in use +
+ +

+ +

Parameter

+ + + + + + + + + + +

bool	$set
	to enable, false to disable

Returns

void

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) + + +

+ + + + + + + + + +

PHPDoc 1.0beta

+ + + diff --git a/phpdoc/ImlibColorRange.html b/phpdoc/ImlibColorRange.html new file mode 100644 index 0000000..163c937 --- /dev/null +++ b/phpdoc/ImlibColorRange.html @@ -0,0 +1,797 @@ + + + + + PHP Imlib2 Classes - Imlib - Class: ImlibColorRange + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

+ 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 +
+ +

+ + + + + + + + + +
Authors Matt McClanahan <cardinal@dodds.net>
Version 0.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 + + +

+ + + + + + + + + +

PHPDoc 1.0beta

+ + + diff --git a/phpdoc/ImlibDraw.html b/phpdoc/ImlibDraw.html new file mode 100644 index 0000000..d5c08a3 --- /dev/null +++ b/phpdoc/ImlibDraw.html @@ -0,0 +1,1110 @@ + + + + + PHP Imlib2 Classes - Imlib - Class: ImlibDraw + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

+ File: /home/matt/src/cvs/imlib/docs/class.ImlibDraw.php +

PHP Imlib2 Classes - Imlib

ImlibDraw

+ ImlibColor
   |
  +-- ImlibCliprect
     |
    +-- ImlibDraw
+

+ Does everything relevant to drawing or filling ellipses, lines, or rectangles +

+ +

public class ImlibDraw extends ImlibCliprect

+ Does everything relevant to drawing or filling ellipses, lines, or rectangles +
+ +

+ + + + + + + + + +
Authors Matt McClanahan <cardinal@dodds.net>
Version 0.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	ImlibDraw() ImlibDraw constructor
bool	draw_ellipse(int $x, int $y, int $w, int $h) Draw an ellipse
bool	draw_line(int $x1, int $y1, int $x2, int $y2) Draw a line
bool	draw_rectangle(int $x, int $y, int $w, int $h) Draw a rectangle
bool	fill_ellipse(int $x, int $y, int $w, int $h) Fill an ellipse
bool	fill_rectangle(int $x, int $y, int $w, int $h) Fill a rectangle
void	get_image() Get the current image resource id#
void	set_image(int $im) Set the image resource id# to draw on

+ + + + + + + + + + +

Private Method Summary
bool	_draw_something(int $x, int $y, int $w, int $h, string $cb) Callback for drawing everything

+ + + + + + + +

Fields inherited from ImlibCliprect

$cliprect, $cliprect_inuse

+ + + + + + + +

Fields inherited from ImlibColor

$color

+ + + + + + + + + + +

Private Field Summary
unknown	$im Resource id# of the image to draw on

Public Method Details

ImlibDraw

+ public void ImlibDraw( )

+ ImlibDraw constructor +
+ +

+ +

Returns

void

draw_ellipse

+ public bool draw_ellipse( int $x, int $y, int $w, int $h )

+ Draw an ellipse +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$x
	X coordinate

+ + + + + + + + + + +

int	$y
	Y coordinate

+ + + + + + + + + + +

int	$w
	horizontal amplitude

+ + + + + + + + + + +

int	$h
	vertical amplitude

Returns

bool

False if no image is set yet

draw_line

+ public bool draw_line( int $x1, int $y1, int $x2, int $y2 )

+ Draw a line +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$x1
	X coordinate

+ + + + + + + + + + +

int	$y1
	Y coordinate

+ + + + + + + + + + +

int	$x2
	X coordinate

+ + + + + + + + + + +

int	$y2
	Y coordinate

Returns

bool

False if no image is set yet

draw_rectangle

+ public bool draw_rectangle( int $x, int $y, int $w, int $h )

+ Draw a rectangle +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$x
	left X coordinate

+ + + + + + + + + + +

int	$y
	left Y coordinate

+ + + + + + + + + + +

int	$w

+ + + + + + + + + + +

int	$h

Returns

bool

False if no image is set yet

fill_ellipse

+ public bool fill_ellipse( int $x, int $y, int $w, int $h )

+ Fill an ellipse +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$x
	X coordinate

+ + + + + + + + + + +

int	$y
	Y coordinate

+ + + + + + + + + + +

int	$w
	horizontal amplitude

+ + + + + + + + + + +

int	$h
	vertical amplitude

Returns

bool

False if no image is set yet

fill_rectangle

+ public bool fill_rectangle( int $x, int $y, int $w, int $h )

+ Fill a rectangle +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$x
	left X coordinate

+ + + + + + + + + + +

int	$y
	left Y coordinate

+ + + + + + + + + + +

int	$w

+ + + + + + + + + + +

int	$h

Returns

bool

False if no image is set yet

get_image

+ public void get_image( )

+ Get the current image resource id# +
+ +

+ +

Returns

void

set_image

+ public void set_image( int $im )

+ Set the image resource id# to draw on +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$im
	resource id#

Returns

void

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Private Method Details

_draw_something

+ private bool _draw_something( int $x, int $y, int $w, int $h, string $cb )

+ Callback for drawing everything +
+ Since all the drawing functions work the same way, this functiondoes all the work. It takes four ints, often x,y,w,h, and passesthem to the specified function. +

+ +

Parameter

+ + + + + + + + + + +

int	$x
	param

+ + + + + + + + + + +

int	$y
	param

+ + + + + + + + + + +

int	$w
	param

+ + + + + + + + + + +

int	$h
	param

+ + + + + + + + + + +

string	$cb
	name of the function to call

Returns

bool

False if no image is set yet

+ + + + + + + + + + + + + + + + + + + + + + +

Private Field Details
$im
+ private unknown $im + + >><< + + Resource id# of the image to draw on + + +

+ + + + + + + + + +

PHPDoc 1.0beta

+ + + diff --git a/phpdoc/ImlibImage.html b/phpdoc/ImlibImage.html new file mode 100644 index 0000000..061e701 --- /dev/null +++ b/phpdoc/ImlibImage.html @@ -0,0 +1,2254 @@ + + + + + PHP Imlib2 Classes - Imlib - Class: ImlibImage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

+ File: /home/matt/src/cvs/imlib/docs/class.ImlibImage.php +

PHP Imlib2 Classes - Imlib

ImlibImage

+ ImlibImage
+

+ Handles image loading and saving, parameters, manipulation, and rendering. +

+ +

public class ImlibImage

+ Handles image loading and saving, parameters, manipulation, and rendering. +
+ This class contains methods for the loading and saving of image files. Alsocontained in this class are functions for getting and setting image parameters,image modification, and rendering. +

+ + + + + + + + + +
Authors Matt McClanahan <cardinal@dodds.net>
Version 0.3
+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Method Summary
void	ImlibImage() ImlibImage constructor
void	blend_onto_image(int $dst, bool $alpha, int $sx, int $sy, int $sw, int $sh, int $dx, int $dy, int $dw, int $dh, bool $dither, bool $blend, bool $alias) Blend a region of the current image onto the region of another ImlibImage
void	blur(int $r) Blur an image with a given blur radius
object ImlibImage	create_clone() Create a clone of the current instance, return a new ImlibImage
object ImlibImage	create_cropped(int $sx, int $sy, int $sw, int $sh) Create a cropped ImlibImage from a region of the current instance, return a new ImlibImage
object ImlibImage	create_cropped_scaled(int $sx, int $sy, int $sw, int $sh, int $dw, int $dh) Create a cropped, scaled ImlibImage from a region of the current instance, return a new ImlibImage
int	create(int $width, int $height) Create an image resource to use with this instance
object ImlibImage	create_rotated(float $degrees, [ float $radians ]) Create a rotated ImlibImage, return a new ImlibImage
object ImlibImage	create_scaled(integer $width, [ integer $height ]) Create a scaled ImlibImage, return a new ImlibImage
void	dump([ integer $quality ]) Output the raw image data of the current instance to stdout
void	flip_diagonal() Flip the current image diagonally
void	flip_horizontal() Flip the current image horizontally
void	flip_vertical() Flip the current image vertically
void	free() Free the current instance and image resource
mixed	get_filename() Get the current filename, if it's set
string	get_format() Get the current image format. The default is png.
integer	get_height() Get the current image's height
integer	get_id() Get the current image's resource id#
integer	get_width() Get the current image's width
boolean	has_alpha() Check if the image has an alpha channel
void	modify_alpha(int $alpha) Set the alpha channel of an image
integer	load(string $infile, [ integer $err ]) Load an image file into the current instance
bool	save(string $outfile, [ integer $quality ]) Save the current instance to a file
void	set_format(string $format) Set the image format for the current instance
void	sharpen(int $r) Sharpen an image with a given sharpen radius
void	tile() Seamlessly tile the current image both horizontally and vertically
void	tile_horizontal() Seamlessly tile the current image horizontally
void	tile_vertical() Seamlessly tile the current image vertically

+ + + + + + + + + + + + + + + +

Private Method Summary
mixed	_get_cb(string $cb) Callback for functions which query the current instance's attributes
void	_no_param_cb(string $cb) Callback for functions which flip or tile the current instance

+ + + + + + + + + + +

Private Field Summary
integer	$id The image resource id#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Method Details

ImlibImage

+ public void ImlibImage( )

+ ImlibImage constructor +
+ +

+ +

Returns

void

blend_onto_image

+ public void blend_onto_image( int $dst, bool $alpha, int $sx, int $sy, int $sw, int $sh, int $dx, int $dy, int $dw, int $dh, bool $dither, bool $blend, bool $alias )

+ Blend a region of the current image onto the region of another ImlibImage +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$dst
	id# of the destination image

+ + + + + + + + + + +

bool	$alpha
	alpha

+ + + + + + + + + + +

int	$sx
	left source X coordinate

+ + + + + + + + + + +

int	$sy
	left source Y coordinate

+ + + + + + + + + + +

int	$sw
	width

+ + + + + + + + + + +

int	$sh
	height

+ + + + + + + + + + +

int	$dx
	left destination X coordinate

+ + + + + + + + + + +

int	$dy
	left destination Y coordinate

+ + + + + + + + + + +

int	$dw
	width

+ + + + + + + + + + +

int	$dh
	height

+ + + + + + + + + + +

bool	$dither

+ + + + + + + + + + +

bool	$blend

+ + + + + + + + + + +

bool	$alias

Returns

void

blur

+ public void blur( int $r )

+ Blur an image with a given blur radius +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$r
	radius

Returns

void

create_clone

+ public object ImlibImage create_clone( )

+ Create a clone of the current instance, return a new ImlibImage +
+ +

+ +

Returns

object ImlibImage

create_cropped

+ public object ImlibImage create_cropped( int $sx, int $sy, int $sw, int $sh )

+ Create a cropped ImlibImage from a region of the current instance, return a new ImlibImage +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$sx
	left X coordinate to crop from

+ + + + + + + + + + +

int	$sy
	left Y coordinate to crop from

+ + + + + + + + + + +

int	$sw
	to crop

+ + + + + + + + + + +

int	$sh
	to crop

Returns

object ImlibImage

create_cropped_scaled

+ public object ImlibImage create_cropped_scaled( int $sx, int $sy, int $sw, int $sh, int $dw, int $dh )

+ Create a cropped, scaled ImlibImage from a region of the current instance, return a new ImlibImage +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$sx
	left X coordinate to crop from

+ + + + + + + + + + +

int	$sy
	left Y coordinate to crop from

+ + + + + + + + + + +

int	$sw
	to crop

+ + + + + + + + + + +

int	$sh
	to crop

+ + + + + + + + + + +

int	$dw
	to scale the cropped region to

+ + + + + + + + + + +

int	$dh
	to scale the cropped region to

Returns

object ImlibImage

create

+ public int create( int $width, int $height )

+ Create an image resource to use with this instance +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$width
	of the image

+ + + + + + + + + + +

int	$height
	of the image

Returns

int

Resource id# that was created

create_rotated

+ public object ImlibImage create_rotated( float $degrees, [ float $radians ] )

+ Create a rotated ImlibImage, return a new ImlibImage +
+ If radians is specified, degrees will be ignored. +

+ +

Parameter

+ + + + + + + + + + +

float	$degrees
	to rotate the image

+ + + + + + + + + + +

float	$radians	`= >>0<<`
	to rotate the image

Returns

object ImlibImage

create_scaled

+ public object ImlibImage create_scaled( integer $width, [ integer $height ] )

+ Create a scaled ImlibImage, return a new ImlibImage +
+ If $height is not specified, it will be calculated from the dimensionsof the current image, so that the aspect ratio is preserved. +

+ +

Parameter

+ + + + + + + + + + +

integer	$width
	to scale the new image to

+ + + + + + + + + + +

integer	$height	`= >>0<<`
	to scale the new image to (Optional)

Returns

object ImlibImage

dump

+ public void dump( [ integer $quality ] )

+ Output the raw image data of the current instance to stdout +
+ +

+ +

Parameter

+ + + + + + + + + + +

integer	$quality	`= >>75<<`
	or compression level to use

Returns

void

flip_diagonal

+ public void flip_diagonal( )

+ Flip the current image diagonally +
+ +

+ +

Returns

void

flip_horizontal

+ public void flip_horizontal( )

+ Flip the current image horizontally +
+ +

+ +

Returns

void

flip_vertical

+ public void flip_vertical( )

+ Flip the current image vertically +
+ +

+ +

Returns

void

+ public boolean has_alpha( )

+ Check if the image has an alpha channel +
+ +

+ +

Returns

boolean

modify_alpha

+ public void modify_alpha( int $alpha )

+ Set the alpha channel of an image +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$alpha
	alpha level to set for the image

Returns

void

load

+ public integer load( string $infile, [ integer $err ] )

+ Load an image file into the current instance +
+ +

+ +

Parameter

+ + + + + + + + + + +

string	$infile

+ + + + + + + + + + +

integer	$err	`= >>0<<`
	error number. 0 for no error.

Returns

integer

Resource id# or false if load failed

save

+ public bool save( string $outfile, [ integer $quality ] )

+ Save the current instance to a file +
+ +

+ +

Parameter

+ + + + + + + + + + +

string	$outfile

+ + + + + + + + + + +

integer	$quality	`= >>75<<`
	or compression level to use

Returns

bool

False if the save failed

set_format

+ public void set_format( string $format )

+ Set the image format for the current instance +
+ +

+ +

Parameter

+ + + + + + + + + + +

string	$format
	format

Returns

void

sharpen

+ public void sharpen( int $r )

+ Sharpen an image with a given sharpen radius +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$r
	radius

Returns

void

tile

+ public void tile( )

+ Seamlessly tile the current image both horizontally and vertically +
+ +

+ +

Returns

void

Returns

mixed

String or int

_no_param_cb

+ private void _no_param_cb( string $cb )

+ Callback for functions which flip or tile the current instance +
+ +

+ +

Parameter

+ + + + + + + + + + +

string	$cb
	name of the function to call

Returns

void

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

Private Field Details
$id
+ private integer $id + + >><< + + The image resource id# + + +
See Also	create(), get_id()

+ + + + + + + + + +

PHPDoc 1.0beta

+ + + diff --git a/phpdoc/ImlibPoly.html b/phpdoc/ImlibPoly.html new file mode 100644 index 0000000..469f3fd --- /dev/null +++ b/phpdoc/ImlibPoly.html @@ -0,0 +1,880 @@ + + + + + PHP Imlib2 Classes - Imlib - Class: ImlibPoly + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

+ File: /home/matt/src/cvs/imlib/docs/class.ImlibPoly.php +

PHP Imlib2 Classes - Imlib

ImlibPoly

+ ImlibColor
   |
  +-- ImlibCliprect
     |
    +-- ImlibPoly
+

+ Does everything relevant to creating and drawing or filling an n-point polygon +

+ +

public class ImlibPoly extends ImlibCliprect

+ Does everything relevant to creating and drawing or filling an n-point polygon +
+ The routine for getting a polygon onto an image is generally to create one,add all its points (The order in which the points are added determines howthe polygon will be drawn), set the image to draw on, and draw. +

+ + + + + + + + + +
Authors Matt McClanahan <cardinal@dodds.net>
Version 0.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	ImlibPoly() ImlibPoly constructor
bool	add_point(int $x, int $y) Add a point to the current polygon
bool	contains_point(int $x, int $y) Checks if the current polygon contains a given point
bool	draw([ integer $closed ]) Draw the current polygon on the current image
bool	fill() Fill the current polygon on the current image
bool	free() Free the current polygon
bool	get_bounds(int &$x1, int &$y1, int &$x2, int &$y2) Get the bounds of the polygon
int	get_image() Get the current image resource id#
int	new_poly() Create a new polygon
void	set_image(int $im) Set the image resource id# to draw on

+ + + + + + + +

Fields inherited from ImlibCliprect

$cliprect, $cliprect_inuse

+ + + + + + + +

Fields inherited from ImlibColor

$color

+ + + + + + + + + + + + + + + +

Private Field Summary
unknown	$im Resource id# of the image to draw on
unknown	$poly The resource id# of the current polygon

Public Method Details

ImlibPoly

+ public void ImlibPoly( )

+ ImlibPoly constructor +
+ +

+ +

Returns

void

add_point

+ public bool add_point( int $x, int $y )

+ Add a point to the current polygon +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$x
	coordinate

+ + + + + + + + + + +

int	$y
	coordinate

Returns

bool

False if there is no polygon set

contains_point

+ public bool contains_point( int $x, int $y )

+ Checks if the current polygon contains a given point +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$x
	coordinate

+ + + + + + + + + + +

int	$y
	coordinate

Returns

bool

True if it does, false otherwise

draw

+ public bool draw( [ integer $closed ] )

+ Draw the current polygon on the current image +
+ +

+ +

Parameter

+ + + + + + + + + + +

integer	$closed	`= >>1<<`
	true, the polygon will be drawn with the endpoints connected

Returns

bool

False if there is no polygon or image set

fill

+ public bool fill( )

+ Fill the current polygon on the current image +
+ +

+ +

Returns

bool

False if there is no polygon or image set

free

+ public bool free( )

+ Free the current polygon +
+ +

+ +

Returns

bool

False if there is no polygon or image set

get_bounds

+ public bool get_bounds( int &$x1, int &$y1, int &$x2, int &$y2 )

+ Get the bounds of the polygon +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	&$x1
	left X coordinate

+ + + + + + + + + + +

int	&$y1
	left Y coordinate

+ + + + + + + + + + +

int	&$x2
	right X coordinate

+ + + + + + + + + + +

int	&$y2
	right Y coordinate

Returns

bool

False if there is no polygon or image set

get_image

+ public int get_image( )

+ Get the current image resource id# +
+ +

+ +

Returns

int

Current image resource id#

new_poly

+ public int new_poly( )

+ Create a new polygon +
+ +

+ +

Returns

int

Resource id# of the new polygon

set_image

+ public void set_image( int $im )

+ Set the image resource id# to draw on +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$im
	resource id#

Returns

void

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Private Field Details
$im
+ private unknown $im + + >><< + + Resource id# of the image to draw on + + +

$poly
+ private unknown $poly + + >><< + + The resource id# of the current polygon + + +

+ + + + + + + + + +

PHPDoc 1.0beta

+ + + diff --git a/phpdoc/ImlibText.html b/phpdoc/ImlibText.html new file mode 100644 index 0000000..f979a90 --- /dev/null +++ b/phpdoc/ImlibText.html @@ -0,0 +1,754 @@ + + + + + PHP Imlib2 Classes - Imlib - Class: ImlibText + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

+ File: /home/matt/src/cvs/imlib/docs/class.ImlibText.php +

PHP Imlib2 Classes - Imlib

ImlibText

+ ImlibColor
|
+-- ImlibText
+

+ Does everything relevant to text drawing +

+ +

public class ImlibText extends ImlibColor

+ Does everything relevant to text drawing +
+ The routine for dealing text is to load a font, set an image to draw on,and draw a string. +

+ + + + + + + + + +
Authors Matt McClanahan <cardinal@dodds.net>
Version 0.3
+

+ + + + + + + +

Methods inherited from ImlibColor

imlibcolor, get_color, get_color_array, set_color, set_color_array

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Method Summary
void	ImlibText() ImlibText constructor
bool	draw(int $x, int $y, string $str, [ string $dir ]) Draw a text string onto the current image
bool	free() Free the currently loaded font
integer	get_image() Get the current image resource id#
bool	get_size(string $str, int &$w, int &$h, [ string $dir ]) Get the width and height of a given string if it were drawn
bool	load(string $path, string $font, int $size) Load a font
void	set_image(int $im) Set the image resource id# to draw on

+ + + + + + + +

Fields inherited from ImlibColor

$color

+ + + + + + + + + + + + + + + +

Private Field Summary
unknown	$fnt Resource id# of the currently loaded font
unknown	$im Resource id# of the image to draw on

Public Method Details

ImlibText

+ public void ImlibText( )

+ ImlibText constructor +
+ +

+ +

Returns

void

draw

+ public bool draw( int $x, int $y, string $str, [ string $dir ] )

+ Draw a text string onto the current image +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$x
	coordinate of the upper left corner of the string

+ + + + + + + + + + +

int	$y
	coordinate of the upper left corner of the string

+ + + + + + + + + + +

string	$str
	string to draw

+ + + + + + + + + + +

string	$dir	`= >>IMLIB_TEXT_TO_RIGHT<<`
	of the text

Returns

bool

False if no font is loaded

free

+ public bool free( )

+ Free the currently loaded font +
+ +

+ +

Returns

bool

False if no font is loaded

get_image

+ public integer get_image( )

+ Get the current image resource id# +
+ +

+ +

Returns

integer

Image resource id#

get_size

+ public bool get_size( string $str, int &$w, int &$h, [ string $dir ] )

+ Get the width and height of a given string if it were drawn +
+ +

+ +

Parameter

+ + + + + + + + + + +

string	$str
	to measure

+ + + + + + + + + + +

int	&$w
	Width the string would be

+ + + + + + + + + + +

int	&$h
	Height the string would be

+ + + + + + + + + + +

string	$dir	`= >>IMLIB_TEXT_TO_RIGHT<<`
	to measure the string

Returns

bool

False if no font is loaded

load

+ public bool load( string $path, string $font, int $size )

+ Load a font +
+ If the font is in the font path, it can be referred to by font name,and the path does not need to be specified. Otherwise, it must bereferred to by filename. +

+ +

Parameter

+ + + + + + + + + + +

string	$path
	, or current directory if passed blank

+ + + + + + + + + + +

string	$font
	name

+ + + + + + + + + + +

int	$size
	size

Returns

bool

False if no font is loaded

set_image

+ public void set_image( int $im )

+ Set the image resource id# to draw on +
+ +

+ +

Parameter

+ + + + + + + + + + +

int	$im
	resource id#

Returns

void

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Private Field Details
$fnt
+ private unknown $fnt + + >><< + + Resource id# of the currently loaded font + + +

$im
+ private unknown $im + + >><< + + Resource id# of the image to draw on + + +

+ + + + + + + + + +

PHPDoc 1.0beta

+ + + diff --git a/phpdoc/frame_packagelist.html b/phpdoc/frame_packagelist.html new file mode 100644 index 0000000..656aca8 --- /dev/null +++ b/phpdoc/frame_packagelist.html @@ -0,0 +1,23 @@ + + + + + PHP Imlib2 Classes - Frameset Packagelist + + + + + + + + + + + + + + +

Packagelist

Imlib

+ + + diff --git a/phpdoc/packageelementlist_Imlib.html b/phpdoc/packageelementlist_Imlib.html new file mode 100644 index 0000000..d63dbce --- /dev/null +++ b/phpdoc/packageelementlist_Imlib.html @@ -0,0 +1,66 @@ + + + + + + PHP Imlib2 Classes - Frameset Packageelements + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ Packagelist +
Imlib
	Classes
		ImlibColorRange
		ImlibDraw
		ImlibPoly
		ImlibCliprect
		ImlibText
		ImlibColor
		ImlibImage

+ + diff --git a/phpdoc/phpdoc.css b/phpdoc/phpdoc.css new file mode 100644 index 0000000..6460f73 --- /dev/null +++ b/phpdoc/phpdoc.css @@ -0,0 +1,92 @@ +BODY { + background-color : #EEEEEE; + color : #000000; + font-family : Arial, Tahoma, Helvetica, sans-serif; + font-size : 10pt; + margin-left : 1em; + margin-right : 0; + +} + +A:LINK, A:VISITED { + color : #000099; + text-decoration : none; +} + +A:HOVER { + background-color : #FFFFFF; + color : #00009F; + text-decoration : none; +} + +H1 { + color : Black; + font-family : Veranda, Tahoma, Arial, Helvetica; + font-size : 16pt; + padding-bottom : 5px; + padding-top : 5px; + padding-left : 5px; +} + +H2 { + color : Black; + font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif; + font-size : 14pt; + margin-top : 2em; +} + +H3 { + color : Navy; + font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif; + font-size : 12pt; + margin-top :1em; +} + +H4 { + color : Navy; + font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif; + font-size : 11pt; + background-color : #E6E6FA; + padding-bottom : 2px; + padding-top : 2px; + padding-left : 2px; + margin-top : 1em; +} + +H5 { + color : Navy; + font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif; + font-size : 10pt; + font-weight : 900; + margin-bottom : -1em; +} + +H6 { + color : #000000; + font-family : Arial, Helvetica, sans-serif; + font-size : 10pt; + font-weight : 800; + margin-bottom : -1em; +} + +BLOCKQUOTE { + margin-left : 0; +} + +CAPTION { + font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif; + font-weight : 800; +} + +TH { + background-color : #FFFFFF; +} + +TD { + background-color : #F0F0F0; + font-size : 10pt; +} + +CODE { + font-size: 8pt; +} diff --git a/phpdoc/phpdoc_classtree.html b/phpdoc/phpdoc_classtree.html new file mode 100644 index 0000000..69e81e3 --- /dev/null +++ b/phpdoc/phpdoc_classtree.html @@ -0,0 +1,74 @@ + + + + + PHP Imlib2 Classes - Classtrees + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

Classtrees

ImlibColor

ImlibColor
- ImlibCliprect
- ImlibText

ImlibImage

ImlibImage

+ + + + + + + + + +

PHPDoc 1.0beta

+ + diff --git a/phpdoc/phpdoc_elementlist.html b/phpdoc/phpdoc_elementlist.html new file mode 100644 index 0000000..a44a76d --- /dev/null +++ b/phpdoc/phpdoc_elementlist.html @@ -0,0 +1,884 @@ + + + + + PHP Imlib2 Classes - Elementlist + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

+ a b c d f g h I i l m n p s t _ +

a

add_color

+ Function in class ImlibColorRange
+ Add a color to the color range at distance $x. +

add_color_array

+ Function in class ImlibColorRange
+ Add a color to the color range at distance $x. +

add_point

+ Function in class ImlibPoly
+ Add a point to the current polygon +

b

blend_onto_image

+ Function in class ImlibImage
+ Blend a region of the current image onto the region of another ImlibImage +

blur

+ Function in class ImlibImage
+ Blur an image with a given blur radius +

c

create

+ Function in class ImlibColorRange
+ Create a new color range +

create

+ Function in class ImlibImage
+ Create an image resource to use with this instance +

$cr

+ Variable in Class ImlibColorRange
+ Resource id# of the current color range +

contains_point

+ Function in class ImlibPoly
+ Checks if the current polygon contains a given point +

$cliprect

+ Variable in Class ImlibCliprect
+ The array defining the cliprect (x,y,w,h) +

$cliprect_inuse

+ Variable in Class ImlibCliprect
+ A boolean that determines if a cliprect is in use or not +

$color

+ Variable in Class ImlibColor
+ The array defining the color (r,g,b,a) +

create_clone

+ Function in class ImlibImage
+ Create a clone of the current instance, return a new ImlibImage +

create_cropped

+ Function in class ImlibImage
+ Create a cropped ImlibImage from a region of the current instance, return a new ImlibImage +

create_cropped_scaled

+ Function in class ImlibImage
+ Create a cropped, scaled ImlibImage from a region of the current instance, return a new ImlibImage +

create_rotated

+ Function in class ImlibImage
+ Create a rotated ImlibImage, return a new ImlibImage +

create_scaled

+ Function in class ImlibImage
+ Create a scaled ImlibImage, return a new ImlibImage +

d

draw_ellipse

+ Function in class ImlibDraw
+ Draw an ellipse +

draw_line

+ Function in class ImlibDraw
+ Draw a line +

draw_rectangle

+ Function in class ImlibDraw
+ Draw a rectangle +

draw

+ Function in class ImlibPoly
+ Draw the current polygon on the current image +

draw

+ Function in class ImlibText
+ Draw a text string onto the current image +

dump

+ Function in class ImlibImage
+ Output the raw image data of the current instance to stdout +

f

free

+ Function in class ImlibColorRange
+ Free the current color range +

free

+ Function in class ImlibPoly
+ Free the current polygon +

free

+ Function in class ImlibText
+ Free the currently loaded font +

free

+ Function in class ImlibImage
+ Free the current instance and image resource +

fill_rectangle

+ Function in class ImlibColorRange
+ Fill the current image with a rectangle using the current color range +

fill_rectangle

+ Function in class ImlibDraw
+ Fill a rectangle +

fill_ellipse

+ Function in class ImlibDraw
+ Fill an ellipse +

fill

+ Function in class ImlibPoly
+ Fill the current polygon on the current image +

$fnt

+ Variable in Class ImlibText
+ Resource id# of the currently loaded font +

flip_diagonal

+ Function in class ImlibImage
+ Flip the current image diagonally +

flip_horizontal

+ Function in class ImlibImage
+ Flip the current image horizontally +

flip_vertical

+ Function in class ImlibImage
+ Flip the current image vertically +

g

get_image

+ Function in class ImlibDraw
+ Get the current image resource id# +

get_image

+ Function in class ImlibPoly
+ Get the current image resource id# +

get_image

+ Function in class ImlibText
+ Get the current image resource id# +

get_bounds

+ Function in class ImlibPoly
+ Get the bounds of the polygon +

get_cliprect

+ Function in class ImlibCliprect
+ Get the four values of the cliprect +

get_cliprect_array

+ Function in class ImlibCliprect
+ Get the array that defines the cliprect (x,y,w,h) +

get_cliprect_inuse

+ Function in class ImlibCliprect
+ Get the boolean that determines if a cliprect is in use or not +

get_size

+ Function in class ImlibText
+ Get the width and height of a given string if it were drawn +

get_color

+ Function in class ImlibColor
+ Get the four color components as by-reference variables +

get_color_array

+ Function in class ImlibColor
+ Get the color array currently defined, if it is defined +

get_filename

+ Function in class ImlibImage
+ Get the current filename, if it's set +

get_format

+ Function in class ImlibImage
+ Get the current image format. The default is png. +

get_height

+ Function in class ImlibImage
+ Get the current image's height +

get_id

+ Function in class ImlibImage
+ Get the current image's resource id# +

get_width

+ Function in class ImlibImage
+ Get the current image's width +

h

has_alpha

+ Function in class ImlibImage
+ Check if the image has an alpha channel +

I

ImlibColorRange

+ Class ImlibColorRange.
+ All functions relevant to creating and displaying color ranges +

ImlibColorRange

+ Function in class ImlibColorRange
+ ImlibColorRange constructor +

ImlibDraw

+ Class ImlibDraw.
+ Does everything relevant to drawing or filling ellipses, lines, or rectangles +

ImlibDraw

+ Function in class ImlibDraw
+ ImlibDraw constructor +

ImlibPoly

+ Class ImlibPoly.
+ Does everything relevant to creating and drawing or filling an n-point polygon +

ImlibPoly

+ Function in class ImlibPoly
+ ImlibPoly constructor +

ImlibCliprect

+ Class ImlibCliprect.
+ Provides variables and methods for a clipping rectangle +

ImlibCliprect

+ Function in class ImlibCliprect
+ ImlibCliprect constructor +

ImlibText

+ Class ImlibText.
+ Does everything relevant to text drawing +

ImlibText

+ Function in class ImlibText
+ ImlibText constructor +

ImlibColor

+ Class ImlibColor.
+ Provides variables and methods for handling color +

ImlibColor

+ Function in class ImlibColor
+ ImlibColor constructor +

ImlibImage

+ Class ImlibImage.
+ Handles image loading and saving, parameters, manipulation, and rendering. +

ImlibImage

+ Function in class ImlibImage
+ ImlibImage constructor +

Imlib

+ Package
+ +

i

$im

+ Variable in Class ImlibColorRange
+ Resource id# of the image to draw on +

$im

+ Variable in Class ImlibDraw
+ Resource id# of the image to draw on +

$im

+ Variable in Class ImlibPoly
+ Resource id# of the image to draw on +

$im

+ Variable in Class ImlibText
+ Resource id# of the image to draw on +

$id

+ Variable in Class ImlibImage
+ The image resource id# +

l

load

+ Function in class ImlibText
+ Load a font +

load

+ Function in class ImlibImage
+ Load an image file into the current instance +

m

modify_alpha

+ Function in class ImlibImage
+ Set the alpha channel of an image +

n

new_poly

+ Function in class ImlibPoly
+ Create a new polygon +

p

$poly

+ Variable in Class ImlibPoly
+ The resource id# of the current polygon +

s

set_image

+ Function in class ImlibColorRange
+ Set the image to draw the color range on +

set_image

+ Function in class ImlibDraw
+ Set the image resource id# to draw on +

set_image

+ Function in class ImlibPoly
+ Set the image resource id# to draw on +

set_image

+ Function in class ImlibText
+ Set the image resource id# to draw on +

set_cliprect

+ Function in class ImlibCliprect
+ Set the four values of the cliprect. 0 for X disables the cliprect. +

set_cliprect_array

+ Function in class ImlibCliprect
+ Set the array that defines the cliprect (x,y,w,h) +

set_cliprect_inuse

+ Function in class ImlibCliprect
+ Set the boolean that determines if the cliprect is in use +

set_color

+ Function in class ImlibColor
+ Set the current color using the four components +

set_color_array

+ Function in class ImlibColor
+ Set the current color using an array of 4 elements (r,g,b,a) +

save

+ Function in class ImlibImage
+ Save the current instance to a file +

set_format

+ Function in class ImlibImage
+ Set the image format for the current instance +

sharpen

+ Function in class ImlibImage
+ Sharpen an image with a given sharpen radius +

t

tile

+ Function in class ImlibImage
+ Seamlessly tile the current image both horizontally and vertically +

tile_horizontal

+ Function in class ImlibImage
+ Seamlessly tile the current image horizontally +

tile_vertical

+ Function in class ImlibImage
+ Seamlessly tile the current image vertically +

_

_draw_something

+ Function in class ImlibDraw
+ Callback for drawing everything +

_get_cb

+ Function in class ImlibImage
+ Callback for functions which query the current instance's attributes +

_no_param_cb

+ Function in class ImlibImage
+ Callback for functions which flip or tile the current instance +

+ + + + + + + + + +

PHPDoc 1.0beta

+ + + + diff --git a/phpdoc/phpdoc_packagelist.html b/phpdoc/phpdoc_packagelist.html new file mode 100644 index 0000000..513cfe0 --- /dev/null +++ b/phpdoc/phpdoc_packagelist.html @@ -0,0 +1,125 @@ + + + + + PHP Imlib2 Classes - Packagelist + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

PHP Imlib2 Classes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ Packagelist +
Imlib
	Classes
		ImlibColorRange
		ImlibDraw
		ImlibPoly
		ImlibCliprect
		ImlibText
		ImlibColor
		ImlibImage

+ + + + + + + +

+ + + + + + + + + +

PHPDoc 1.0beta

+ + + diff --git a/phpdoc/phpdoc_warnings.html b/phpdoc/phpdoc_warnings.html new file mode 100644 index 0000000..270d0d2 --- /dev/null +++ b/phpdoc/phpdoc_warnings.html @@ -0,0 +1,96 @@ + + + + + PHP Imlib2 Classes - Report + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

Warnings

/home/matt/src/cvs/imlib/docs/class.ImlibText.php

+ 2 Warning(s). +

+ + + + + + + + + + + + + + + + + + + + + + + + +

[function] draw	mismatch
4th parameter type '$dir' does match the the documented type 'int', possible error consider an update to '@param string $dir of the text' or '@param string of the text', the variable name is optional.

[function] get_size	mismatch
4th parameter type '$dir' does match the the documented type 'int', possible error consider an update to '@param string $dir to measure the string' or '@param string to measure the string', the variable name is optional.

+ + + + + + + + + +

PHPDoc 1.0beta

+ + diff --git a/phpdoc/phpdoc_xmlfiles.html b/phpdoc/phpdoc_xmlfiles.html new file mode 100644 index 0000000..b346f30 --- /dev/null +++ b/phpdoc/phpdoc_xmlfiles.html @@ -0,0 +1,63 @@ + + + + + - Modulegroups + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + +

+ + + + + + + + + +

PHPDoc 1.0beta

+ + -- cgit v1.2.3

PHP Imlib2 Classes - Imlib

ImlibCliprect

public class ImlibCliprect extends ImlibColor

Methods inherited from ImlibColor

Public Method Summary

ImlibCliprect()

get_cliprect(int &$x, int &$y, int &$w, int &$h)

get_cliprect_array()

get_cliprect_inuse()

set_cliprect(int $x, int $y, int $w, int $h)

set_cliprect_array(array $arr)

set_cliprect_inuse(bool $set)

Fields inherited from ImlibColor

Private Field Summary

$cliprect

$cliprect_inuse

Public Method Details

ImlibCliprect

get_cliprect

get_cliprect_array

get_cliprect_inuse

set_cliprect

set_cliprect_array

set_cliprect_inuse

Private Field Details

$cliprect

$cliprect_inuse

PHP Imlib2 Classes - Imlib

ImlibColor

public class ImlibColor

Public Method Summary

ImlibColor()

get_color(int &$r, int &$g, int &$b, int &$a)

get_color_array()

set_color(int $r, int $g, int $b, int $a)

set_color_array(array $arr)

Private Field Summary

$color

Public Method Details

ImlibColor

get_color

get_color_array

set_color

set_color_array

Private Field Details

$color

PHP Imlib2 Classes - Imlib

ImlibColorRange

public class ImlibColorRange extends ImlibCliprect

Methods inherited from ImlibCliprect

Methods inherited from ImlibColor

Public Method Summary

ImlibColorRange()

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

add_color_array(int $x, array $arr)

create()

free()

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

set_image(int $im)

Fields inherited from ImlibCliprect

Fields inherited from ImlibColor

Private Field Summary

$cr

$im

Public Method Details

ImlibColorRange

add_color

add_color_array

create

free

fill_rectangle

set_image

Private Field Details

$cr

$im

PHP Imlib2 Classes - Imlib

ImlibDraw

public class ImlibDraw extends ImlibCliprect

Methods inherited from ImlibCliprect

Methods inherited from ImlibColor