diff options
| author | pp <pp@455248ca-bdda-0310-9134-f4ebb693071a> | 2004-05-19 04:59:31 +0000 |
|---|---|---|
| committer | pp <pp@455248ca-bdda-0310-9134-f4ebb693071a> | 2004-05-19 04:59:31 +0000 |
| commit | d0a9b9a03fc7ae74ef8a64593ac6b592526ec4d5 (patch) | |
| tree | e03d2a7fac8c7619f1286545f717ef7ee3866cd6 /phpdoc/ImlibCliprect.html | |
- initial import
git-svn-id: https://siedziba.pl:790/svn/repos/php-imlib/trunk@7 455248ca-bdda-0310-9134-f4ebb693071a
Diffstat (limited to 'phpdoc/ImlibCliprect.html')
| -rw-r--r-- | phpdoc/ImlibCliprect.html | 756 |
1 files changed, 756 insertions, 0 deletions
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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- Generated with PHPDoc, http://www.phpdoc.de --> +<html> +<head> + <title>PHP Imlib2 Classes - Imlib - Class: ImlibCliprect</title> + <link href="phpdoc.css" rel="stylesheet" type="text/css"> +</head> + +<body> +<table width="100%" border="0"> + <tr> + <td align="left" valign="top" bgcolor="#B0BAFF"> + <table width="100%"> + <tr> + <td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td> + <td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td> + <td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td> + <td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td> + <td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td> + <td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td> + </tr> + </table> + </td> + </tr> + <tr> + <td height="20" align="left" valign="top"><hr></td> + </tr> + <tr> + <td align="left" valign="top"> + File: <a href="file:///home/matt/src/cvs/imlib/docs/class.ImlibCliprect.php" target="_new">/home/matt/src/cvs/imlib/docs/class.ImlibCliprect.php</a> + <h5>PHP Imlib2 Classes - Imlib</h5> + <h1>ImlibCliprect</h1> + <a href="ImlibColor.html">ImlibColor</a><br> |<br> +-- ImlibCliprect<br> + <p> + Provides variables and methods for a clipping rectangle + <p> + + </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>public class ImlibCliprect extends <a href="ImlibColor.html">ImlibColor</a></h4> + Provides variables and methods for a clipping rectangle + <br> + 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. + <p> + <table> + + + <tr><td align="left" valign="top">Authors</td><td align="left" valign="top">Matt McClanahan <<a href="mailto:cardinal@dodds.net">cardinal@dodds.net</a>></td></tr> + + <tr><td align="left" valign="top">Version</td><td align="left" valign="top">0.3</td></tr> + + + + </table> + </td> + </tr> + <tr> + <td height="10" align="left" valign="top"> </td> + </tr> + + <tr> + <td align="left" valign="top"> + <b>Direct known subclasses:</b> <a href="ImlibColorRange.html">ImlibColorRange</a>, <a href="ImlibDraw.html">ImlibDraw</a>, <a href="ImlibPoly.html">ImlibPoly</a> + </td> + </tr> + + <tr> + <td height="20" align="left" valign="top"><hr></td> + </tr> + + <tr> + <td align="left" valign="top"> + <table width="100%" border="0"> + <tr> + <td align="left" valign="top"><h3>Methods inherited from ImlibColor</h3></td> + </tr> + <tr> + <td align="left" valign="top"><a href="ImlibColor.html#function_imlibcolor">imlibcolor</a>, <a href="ImlibColor.html#function_get_color">get_color</a>, <a href="ImlibColor.html#function_get_color_array">get_color_array</a>, <a href="ImlibColor.html#function_set_color">set_color</a>, <a href="ImlibColor.html#function_set_color_array">set_color_array</a></td> + </tr> + </table> + </td> + </tr> + + + <tr> + <td align="left" valign="top"> + <table width="100%" border="0"> + <tr> + <td colspan="2" align="left" valign="top"><h2>Public Method Summary</h2></td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_ImlibCliprect()"><h4>ImlibCliprect()</h4></a>ImlibCliprect constructor</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_get_cliprect()"><h4>get_cliprect(int &$x, int &$y, int &$w, int &$h)</h4></a>Get the four values of the cliprect</td> + </tr> + + <tr> + <td align="right" valign="top">array</td> + <td align="left" valign="top" width="100%"><a href="#function_get_cliprect_array()"><h4>get_cliprect_array()</h4></a>Get the array that defines the cliprect (x,y,w,h)</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_get_cliprect_inuse()"><h4>get_cliprect_inuse()</h4></a>Get the boolean that determines if a cliprect is in use or not</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_cliprect()"><h4>set_cliprect(int $x, int $y, int $w, int $h)</h4></a>Set the four values of the cliprect. 0 for X disables the cliprect.</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_cliprect_array()"><h4>set_cliprect_array(array $arr)</h4></a>Set the array that defines the cliprect (x,y,w,h)</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_cliprect_inuse()"><h4>set_cliprect_inuse(bool $set)</h4></a>Set the boolean that determines if the cliprect is in use</td> + </tr> + + </table> + </td> + </tr> + + + <tr> + <td align="left" valign="top"> + <table width="100%" border="0"> + <tr> + <td align="left" valign="top"><h3>Fields inherited from ImlibColor</h3></td> + </tr> + <tr> + <td align="left" valign="top"><a href="ImlibColor.html#variable_$color">$color</a></td> + </tr> + </table> + </td> + </tr> + + + <tr> + <td align="left" valign="top"> + <table width="100%" border="0"> + <tr> + <td colspan="2" align="left" valign="top"><h2>Private Field Summary</h2></td> + </tr> + + <tr> + <td align="right" valign="top">array</td> + <td align="left" valign="top" width="100%"><a href="#variable_$cliprect"><h4>$cliprect</h4></a>The array defining the cliprect (x,y,w,h)</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#variable_$cliprect_inuse"><h4>$cliprect_inuse</h4></a>A boolean that determines if a cliprect is in use or not</td> + </tr> + + </table> + </td> + </tr> + + + + + + + <tr> + <td align="left" valign="top"> + <table width="100%" border="0"> + <tr> + <td colspan="2" align="left" valign="top"><h2>Public Method Details</h2></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_ImlibCliprect()"><h4>ImlibCliprect</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void ImlibCliprect( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + ImlibCliprect constructor + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>void <p></td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_get_cliprect()"><h4>get_cliprect</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void get_cliprect( int &$x, int &$y, int &$w, int &$h )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the four values of the cliprect + <br> + + <p> + + </td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top">Parameter</td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">int</td> + <td align="left" valign="top">&$x</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left X coordinate to clip from</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">int</td> + <td align="left" valign="top">&$y</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left Y coordinate to clip from</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">int</td> + <td align="left" valign="top">&$w</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">of the cliprect</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">int</td> + <td align="left" valign="top">&$h</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">of the cliprect</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>void <p></td> + </tr> + + + + + + + + + + + <tr> + <td align="left" valign="top">See Also</td> + <td align="left" valign="top"><a href="#function_set_cliprect()">set_cliprect()</a></td> + </tr> + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_get_cliprect_array()"><h4>get_cliprect_array</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public array get_cliprect_array( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the array that defines the cliprect (x,y,w,h) + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>array <p>Array defining the clipping rectangle</td> + </tr> + + + + + + + + + + + <tr> + <td align="left" valign="top">See Also</td> + <td align="left" valign="top"><a href="#function_set_cliprect_array()">set_cliprect_array()</a></td> + </tr> + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_get_cliprect_inuse()"><h4>get_cliprect_inuse</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool get_cliprect_inuse( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the boolean that determines if a cliprect is in use or not + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>True if the cliprect is in use</td> + </tr> + + + + + + + + + + + <tr> + <td align="left" valign="top">See Also</td> + <td align="left" valign="top"><a href="#function_set_cliprect_inuse()">set_cliprect_inuse()</a></td> + </tr> + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_set_cliprect()"><h4>set_cliprect</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_cliprect( int $x, int $y, int $w, int $h )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the four values of the cliprect. 0 for X disables the cliprect. + <br> + + <p> + + </td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top">Parameter</td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">int</td> + <td align="left" valign="top">$x</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left X coordinate to clip from</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">int</td> + <td align="left" valign="top">$y</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left Y coordinate to clip from</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">int</td> + <td align="left" valign="top">$w</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">of the cliprect</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">int</td> + <td align="left" valign="top">$h</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">of the cliprect</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>void <p></td> + </tr> + + + + + + + + + + + <tr> + <td align="left" valign="top">See Also</td> + <td align="left" valign="top"><a href="#function_get_cliprect()">get_cliprect()</a></td> + </tr> + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_set_cliprect_array()"><h4>set_cliprect_array</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_cliprect_array( array $arr )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the array that defines the cliprect (x,y,w,h) + <br> + + <p> + + </td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top">Parameter</td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">array</td> + <td align="left" valign="top">$arr</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">that defines the cliprect</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>void <p></td> + </tr> + + + + + + + + + + + <tr> + <td align="left" valign="top">See Also</td> + <td align="left" valign="top"><a href="#function_get_cliprect_array()">get_cliprect_array()</a></td> + </tr> + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_set_cliprect_inuse()"><h4>set_cliprect_inuse</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_cliprect_inuse( bool $set )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the boolean that determines if the cliprect is in use + <br> + + <p> + + </td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top">Parameter</td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">bool</td> + <td align="left" valign="top">$set</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to enable, false to disable</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>void <p></td> + </tr> + + + + + + + + + + + <tr> + <td align="left" valign="top">See Also</td> + <td align="left" valign="top"><a href="#function_get_cliprect_inuse()">get_cliprect_inuse()</a></td> + </tr> + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + </table> + </tr> + + + <tr> + <td align="left" valign="top"> + <table width="100%" border="0"> + <tr> + <td colspan="2" align="left" valign="top"><h2>Private Field Details</h2></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="variable_$cliprect"><h4>$cliprect</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private array $cliprect</b> + <p> + >><code></code><< + <p> + The array defining the cliprect (x,y,w,h) + <br> + + </td> + </tr> + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="variable_$cliprect_inuse"><h4>$cliprect_inuse</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private bool $cliprect_inuse</b> + <p> + >><code></code><< + <p> + A boolean that determines if a cliprect is in use or not + <br> + + </td> + </tr> + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + </table> + </tr> + + + + <tr> + <td height="10" align="left" valign="top"><hr></td> + </tr> + <tr> + <td align="left" valign="top" bgcolor="#C0C0C0"> + <table> + <tr> + <td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td> + <td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td> + <td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td> + <td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td> + <td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td> + <td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td> + </tr> + </table> + </td> + </tr> + <tr> + <td align="left" valign="top">PHPDoc 1.0beta</td> + </tr> +</table> + +</body> +</html> |