|
|
|
File: /home/matt/src/cvs/imlib/docs/class.ImlibCliprect.php
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.
|
| |
|
Direct known subclasses: ImlibColorRange, ImlibDraw, ImlibPoly
|
|
|
|
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 |
$cliprectThe array defining the cliprect (x,y,w,h) |
| bool |
$cliprect_inuseA 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 |
|
|
|
|
|
| Returns |
void |
| See Also |
set_cliprect() |
|
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 |
| See Also |
set_cliprect_array() |
|
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 |
| See Also |
set_cliprect_inuse() |
|
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 |
|
|
|
|
|
| Returns |
void |
| See Also |
get_cliprect() |
|
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 |
| See Also |
get_cliprect_array() |
|
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 |
| See Also |
get_cliprect_inuse() |
|
|
Private Field Details |
$cliprect |
|
private array $cliprect
>>
The array defining the cliprect (x,y,w,h)
|
|
$cliprect_inuse |
|
private bool $cliprect_inuse
>>
A boolean that determines if a cliprect is in use or not
|
|
|
|
|
|
| PHPDoc 1.0beta |