diff options
Diffstat (limited to 'phpdoc')
| -rw-r--r-- | phpdoc/ImlibCliprect.html | 756 | ||||
| -rw-r--r-- | phpdoc/ImlibColor.html | 562 | ||||
| -rw-r--r-- | phpdoc/ImlibColorRange.html | 797 | ||||
| -rw-r--r-- | phpdoc/ImlibDraw.html | 1110 | ||||
| -rw-r--r-- | phpdoc/ImlibImage.html | 2254 | ||||
| -rw-r--r-- | phpdoc/ImlibPoly.html | 880 | ||||
| -rw-r--r-- | phpdoc/ImlibText.html | 754 | ||||
| -rw-r--r-- | phpdoc/frame_packagelist.html | 23 | ||||
| -rw-r--r-- | phpdoc/packageelementlist_Imlib.html | 66 | ||||
| -rw-r--r-- | phpdoc/phpdoc.css | 92 | ||||
| -rw-r--r-- | phpdoc/phpdoc_classtree.html | 74 | ||||
| -rw-r--r-- | phpdoc/phpdoc_elementlist.html | 884 | ||||
| -rw-r--r-- | phpdoc/phpdoc_packagelist.html | 125 | ||||
| -rw-r--r-- | phpdoc/phpdoc_warnings.html | 96 | ||||
| -rw-r--r-- | phpdoc/phpdoc_xmlfiles.html | 63 |
15 files changed, 8536 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> diff --git a/phpdoc/ImlibColor.html b/phpdoc/ImlibColor.html new file mode 100644 index 0000000..cc152ce --- /dev/null +++ b/phpdoc/ImlibColor.html @@ -0,0 +1,562 @@ +<!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: ImlibColor</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.ImlibColor.php" target="_new">/home/matt/src/cvs/imlib/docs/class.ImlibColor.php</a> + <h5>PHP Imlib2 Classes - Imlib</h5> + <h1>ImlibColor</h1> + ImlibColor<br> + <p> + Provides variables and methods for handling color + <p> + + </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>public class ImlibColor </h4> + Provides variables and methods for handling color + <br> + The variables and methods in this class provide a way to get and set thecolor to be used by any text or drawing functions. + <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="ImlibCliprect.html">ImlibCliprect</a>, <a href="ImlibText.html">ImlibText</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 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_ImlibColor()"><h4>ImlibColor()</h4></a>ImlibColor constructor</td> + </tr> + + <tr> + <td align="right" valign="top">mixed</td> + <td align="left" valign="top" width="100%"><a href="#function_get_color()"><h4>get_color(int &$r, int &$g, int &$b, int &$a)</h4></a>Get the four color components as by-reference variables</td> + </tr> + + <tr> + <td align="right" valign="top">mixed</td> + <td align="left" valign="top" width="100%"><a href="#function_get_color_array()"><h4>get_color_array()</h4></a>Get the color array currently defined, if it is defined</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_color()"><h4>set_color(int $r, int $g, int $b, int $a)</h4></a>Set the current color using the four components</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_color_array()"><h4>set_color_array(array $arr)</h4></a>Set the current color using an array of 4 elements (r,g,b,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_$color"><h4>$color</h4></a>The array defining the color (r,g,b,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 Details</h2></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_ImlibColor()"><h4>ImlibColor</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void ImlibColor( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + ImlibColor 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_color()"><h4>get_color</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public mixed get_color( int &$r, int &$g, int &$b, int &$a )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the four color components as by-reference variables + <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">&$r</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">Red</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">&$g</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">Blue</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">&$b</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">Green</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">&$a</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">Alpha</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>mixed <p>False if a color isn't set, the color array otherwise</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_color_array()"><h4>get_color_array</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public mixed get_color_array( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the color array currently defined, if it is defined + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>mixed <p>False if a color isn't set, the color array otherwise</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_color()"><h4>set_color</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_color( int $r, int $g, int $b, int $a )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the current color using the four components + <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">$r</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></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">$g</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></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">$b</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></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">$a</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></td> + </tr> + </table> + </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_set_color_array()"><h4>set_color_array</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_color_array( array $arr )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the current color using an array of 4 elements (r,g,b,a) + <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">array</td> + </tr> + </table> + </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> + + </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_$color"><h4>$color</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private array $color</b> + <p> + >><code></code><< + <p> + The array defining the color (r,g,b,a) + <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> 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 @@ +<!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: ImlibColorRange</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.ImlibColorRange.php" target="_new">/home/matt/src/cvs/imlib/docs/class.ImlibColorRange.php</a> + <h5>PHP Imlib2 Classes - Imlib</h5> + <h1>ImlibColorRange</h1> + <a href="ImlibColor.html">ImlibColor</a><br> |<br> +-- <a href="ImlibCliprect.html">ImlibCliprect</a><br> |<br> +-- ImlibColorRange<br> + <p> + All functions relevant to creating and displaying color ranges + <p> + + </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>public class ImlibColorRange extends <a href="ImlibCliprect.html">ImlibCliprect</a></h4> + All functions relevant to creating and displaying color ranges + <br> + + <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 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 ImlibCliprect</h3></td> + </tr> + <tr> + <td align="left" valign="top"><a href="ImlibCliprect.html#function_imlibcliprect">imlibcliprect</a>, <a href="ImlibCliprect.html#function_get_cliprect">get_cliprect</a>, <a href="ImlibCliprect.html#function_get_cliprect_array">get_cliprect_array</a>, <a href="ImlibCliprect.html#function_get_cliprect_inuse">get_cliprect_inuse</a>, <a href="ImlibCliprect.html#function_set_cliprect">set_cliprect</a>, <a href="ImlibCliprect.html#function_set_cliprect_array">set_cliprect_array</a>, <a href="ImlibCliprect.html#function_set_cliprect_inuse">set_cliprect_inuse</a></td> + </tr> + </table> + </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_ImlibColorRange()"><h4>ImlibColorRange()</h4></a>ImlibColorRange constructor</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_add_color()"><h4>add_color(int $x, int $r, int $g, int $b, int $a)</h4></a>Add a color to the color range at distance $x.</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_add_color_array()"><h4>add_color_array(int $x, array $arr)</h4></a>Add a color to the color range at distance $x.</td> + </tr> + + <tr> + <td align="right" valign="top">int</td> + <td align="left" valign="top" width="100%"><a href="#function_create()"><h4>create()</h4></a>Create a new color range</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_free()"><h4>free()</h4></a>Free the current color range</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_fill_rectangle()"><h4>fill_rectangle(int $x, int $y, int $w, int $h, int $angle)</h4></a>Fill the current image with a rectangle using the current color range</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_image()"><h4>set_image(int $im)</h4></a>Set the image to draw the color range on</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 ImlibCliprect</h3></td> + </tr> + <tr> + <td align="left" valign="top"><a href="ImlibCliprect.html#variable_$cliprect">$cliprect</a>, <a href="ImlibCliprect.html#variable_$cliprect_inuse">$cliprect_inuse</a></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">unknown</td> + <td align="left" valign="top" width="100%"><a href="#variable_$cr"><h4>$cr</h4></a>Resource id# of the current color range</td> + </tr> + + <tr> + <td align="right" valign="top">unknown</td> + <td align="left" valign="top" width="100%"><a href="#variable_$im"><h4>$im</h4></a>Resource id# of the image to draw on</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_ImlibColorRange()"><h4>ImlibColorRange</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void ImlibColorRange( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + ImlibColorRange 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_add_color()"><h4>add_color</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void add_color( int $x, int $r, int $g, int $b, int $a )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Add a color to the color range at distance $x. + <br> + A distance of 0 will center it between the previous color and the end.$x is ignored for the first color. + <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">from the previous color</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">$r</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></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">$g</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></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">$b</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></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">$a</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></td> + </tr> + </table> + </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_add_color_array()"><h4>add_color_array</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void add_color_array( int $x, array $arr )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Add a color to the color range at distance $x. + <br> + A distance of 0 will center it between the previous color and the end.$x is ignored for the first color. + <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">from the previous color</td> + </tr> + </table> + </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">array (r,g,b,a)</td> + </tr> + </table> + </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_create()"><h4>create</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public int create( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Create a new color range + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>int <p>Resource id# of the new color range</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_free()"><h4>free</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void free( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Free the current color range + <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_fill_rectangle()"><h4>fill_rectangle</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void fill_rectangle( int $x, int $y, int $w, int $h, int $angle )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Fill the current image with a rectangle using the current color range + <br> + The color range will be filled in the specified box at angle $angle + <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 of the box</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 of the box</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 box</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 box</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">$angle</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to rotate the color range (degrees)</td> + </tr> + </table> + </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_set_image()"><h4>set_image</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_image( int $im )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the image to draw the color range on + <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">$im</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">id# of the image</td> + </tr> + </table> + </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> + + </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_$cr"><h4>$cr</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private unknown $cr</b> + <p> + >><code></code><< + <p> + Resource id# of the current color range + <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_$im"><h4>$im</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private unknown $im</b> + <p> + >><code></code><< + <p> + Resource id# of the image to draw on + <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> 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 @@ +<!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: ImlibDraw</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.ImlibDraw.php" target="_new">/home/matt/src/cvs/imlib/docs/class.ImlibDraw.php</a> + <h5>PHP Imlib2 Classes - Imlib</h5> + <h1>ImlibDraw</h1> + <a href="ImlibColor.html">ImlibColor</a><br> |<br> +-- <a href="ImlibCliprect.html">ImlibCliprect</a><br> |<br> +-- ImlibDraw<br> + <p> + Does everything relevant to drawing or filling ellipses, lines, or rectangles + <p> + + </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>public class ImlibDraw extends <a href="ImlibCliprect.html">ImlibCliprect</a></h4> + Does everything relevant to drawing or filling ellipses, lines, or rectangles + <br> + + <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 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 ImlibCliprect</h3></td> + </tr> + <tr> + <td align="left" valign="top"><a href="ImlibCliprect.html#function_imlibcliprect">imlibcliprect</a>, <a href="ImlibCliprect.html#function_get_cliprect">get_cliprect</a>, <a href="ImlibCliprect.html#function_get_cliprect_array">get_cliprect_array</a>, <a href="ImlibCliprect.html#function_get_cliprect_inuse">get_cliprect_inuse</a>, <a href="ImlibCliprect.html#function_set_cliprect">set_cliprect</a>, <a href="ImlibCliprect.html#function_set_cliprect_array">set_cliprect_array</a>, <a href="ImlibCliprect.html#function_set_cliprect_inuse">set_cliprect_inuse</a></td> + </tr> + </table> + </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_ImlibDraw()"><h4>ImlibDraw()</h4></a>ImlibDraw constructor</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_draw_ellipse()"><h4>draw_ellipse(int $x, int $y, int $w, int $h)</h4></a>Draw an ellipse</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_draw_line()"><h4>draw_line(int $x1, int $y1, int $x2, int $y2)</h4></a>Draw a line</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_draw_rectangle()"><h4>draw_rectangle(int $x, int $y, int $w, int $h)</h4></a>Draw a rectangle</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_fill_ellipse()"><h4>fill_ellipse(int $x, int $y, int $w, int $h)</h4></a>Fill an ellipse</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_fill_rectangle()"><h4>fill_rectangle(int $x, int $y, int $w, int $h)</h4></a>Fill a rectangle</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_get_image()"><h4>get_image()</h4></a>Get the current image resource id#</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_image()"><h4>set_image(int $im)</h4></a>Set the image resource id# to draw on</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 Method Summary</h2></td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function__draw_something()"><h4>_draw_something(int $x, int $y, int $w, int $h, string $cb)</h4></a>Callback for drawing everything</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 ImlibCliprect</h3></td> + </tr> + <tr> + <td align="left" valign="top"><a href="ImlibCliprect.html#variable_$cliprect">$cliprect</a>, <a href="ImlibCliprect.html#variable_$cliprect_inuse">$cliprect_inuse</a></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">unknown</td> + <td align="left" valign="top" width="100%"><a href="#variable_$im"><h4>$im</h4></a>Resource id# of the image to draw on</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_ImlibDraw()"><h4>ImlibDraw</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void ImlibDraw( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + ImlibDraw 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_draw_ellipse()"><h4>draw_ellipse</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool draw_ellipse( 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"> + Draw an ellipse + <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">X coordinate</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">Y coordinate</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">horizontal amplitude</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">vertical amplitude</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no image is set yet</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_draw_line()"><h4>draw_line</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool draw_line( int $x1, int $y1, int $x2, int $y2 )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Draw a line + <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">$x1</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">X coordinate</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">$y1</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">Y coordinate</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">$x2</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">X coordinate</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">$y2</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">Y coordinate</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no image is set yet</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_draw_rectangle()"><h4>draw_rectangle</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool draw_rectangle( 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"> + Draw a rectangle + <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</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</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"></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"></td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no image is set yet</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_fill_ellipse()"><h4>fill_ellipse</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool fill_ellipse( 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"> + Fill an ellipse + <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">X coordinate</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">Y coordinate</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">horizontal amplitude</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">vertical amplitude</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no image is set yet</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_fill_rectangle()"><h4>fill_rectangle</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool fill_rectangle( 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"> + Fill a rectangle + <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</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</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"></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"></td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no image is set yet</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_image()"><h4>get_image</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void get_image( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the current image resource id# + <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_set_image()"><h4>set_image</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_image( int $im )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the image resource id# to draw on + <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">$im</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">resource id#</td> + </tr> + </table> + </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> + + </table> + </tr> + + <tr> + <td align="left" valign="top"> + <table width="100%" border="0"> + <tr> + <td colspan="2" align="left" valign="top"><h2>Private Method Details</h2></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function__draw_something()"><h4>_draw_something</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private bool _draw_something( int $x, int $y, int $w, int $h, string $cb )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Callback for drawing everything + <br> + 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. + <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">param</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">param</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">param</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">param</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">string</td> + <td align="left" valign="top">$cb</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">name of the function to call</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no image is set yet</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_$im"><h4>$im</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private unknown $im</b> + <p> + >><code></code><< + <p> + Resource id# of the image to draw on + <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> 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 @@ +<!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: ImlibImage</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.ImlibImage.php" target="_new">/home/matt/src/cvs/imlib/docs/class.ImlibImage.php</a> + <h5>PHP Imlib2 Classes - Imlib</h5> + <h1>ImlibImage</h1> + ImlibImage<br> + <p> + Handles image loading and saving, parameters, manipulation, and rendering. + <p> + + </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>public class ImlibImage </h4> + Handles image loading and saving, parameters, manipulation, and rendering. + <br> + 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. + <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 height="20" align="left" valign="top"><hr></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_ImlibImage()"><h4>ImlibImage()</h4></a>ImlibImage constructor</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_blend_onto_image()"><h4>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)</h4></a>Blend a region of the current image onto the region of another ImlibImage</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_blur()"><h4>blur(int $r)</h4></a>Blur an image with a given blur radius</td> + </tr> + + <tr> + <td align="right" valign="top">object ImlibImage</td> + <td align="left" valign="top" width="100%"><a href="#function_create_clone()"><h4>create_clone()</h4></a>Create a clone of the current instance, return a new ImlibImage</td> + </tr> + + <tr> + <td align="right" valign="top">object ImlibImage</td> + <td align="left" valign="top" width="100%"><a href="#function_create_cropped()"><h4>create_cropped(int $sx, int $sy, int $sw, int $sh)</h4></a>Create a cropped ImlibImage from a region of the current instance, return a new ImlibImage</td> + </tr> + + <tr> + <td align="right" valign="top">object ImlibImage</td> + <td align="left" valign="top" width="100%"><a href="#function_create_cropped_scaled()"><h4>create_cropped_scaled(int $sx, int $sy, int $sw, int $sh, int $dw, int $dh)</h4></a>Create a cropped, scaled ImlibImage from a region of the current instance, return a new ImlibImage</td> + </tr> + + <tr> + <td align="right" valign="top">int</td> + <td align="left" valign="top" width="100%"><a href="#function_create()"><h4>create(int $width, int $height)</h4></a>Create an image resource to use with this instance</td> + </tr> + + <tr> + <td align="right" valign="top">object ImlibImage</td> + <td align="left" valign="top" width="100%"><a href="#function_create_rotated()"><h4>create_rotated(float $degrees, [ float $radians ])</h4></a>Create a rotated ImlibImage, return a new ImlibImage</td> + </tr> + + <tr> + <td align="right" valign="top">object ImlibImage</td> + <td align="left" valign="top" width="100%"><a href="#function_create_scaled()"><h4>create_scaled(integer $width, [ integer $height ])</h4></a>Create a scaled ImlibImage, return a new ImlibImage</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_dump()"><h4>dump([ integer $quality ])</h4></a>Output the raw image data of the current instance to stdout</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_flip_diagonal()"><h4>flip_diagonal()</h4></a>Flip the current image diagonally</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_flip_horizontal()"><h4>flip_horizontal()</h4></a>Flip the current image horizontally</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_flip_vertical()"><h4>flip_vertical()</h4></a>Flip the current image vertically</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_free()"><h4>free()</h4></a>Free the current instance and image resource</td> + </tr> + + <tr> + <td align="right" valign="top">mixed</td> + <td align="left" valign="top" width="100%"><a href="#function_get_filename()"><h4>get_filename()</h4></a>Get the current filename, if it's set</td> + </tr> + + <tr> + <td align="right" valign="top">string</td> + <td align="left" valign="top" width="100%"><a href="#function_get_format()"><h4>get_format()</h4></a>Get the current image format. The default is png.</td> + </tr> + + <tr> + <td align="right" valign="top">integer</td> + <td align="left" valign="top" width="100%"><a href="#function_get_height()"><h4>get_height()</h4></a>Get the current image's height</td> + </tr> + + <tr> + <td align="right" valign="top">integer</td> + <td align="left" valign="top" width="100%"><a href="#function_get_id()"><h4>get_id()</h4></a>Get the current image's resource id#</td> + </tr> + + <tr> + <td align="right" valign="top">integer</td> + <td align="left" valign="top" width="100%"><a href="#function_get_width()"><h4>get_width()</h4></a>Get the current image's width</td> + </tr> + + <tr> + <td align="right" valign="top">boolean</td> + <td align="left" valign="top" width="100%"><a href="#function_has_alpha()"><h4>has_alpha()</h4></a>Check if the image has an alpha channel</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_modify_alpha()"><h4>modify_alpha(int $alpha)</h4></a>Set the alpha channel of an image</td> + </tr> + + <tr> + <td align="right" valign="top">integer</td> + <td align="left" valign="top" width="100%"><a href="#function_load()"><h4>load(string $infile, [ integer $err ])</h4></a>Load an image file into the current instance</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_save()"><h4>save(string $outfile, [ integer $quality ])</h4></a>Save the current instance to a file</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_format()"><h4>set_format(string $format)</h4></a>Set the image format for the current instance</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_sharpen()"><h4>sharpen(int $r)</h4></a>Sharpen an image with a given sharpen radius</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_tile()"><h4>tile()</h4></a>Seamlessly tile the current image both horizontally and vertically</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_tile_horizontal()"><h4>tile_horizontal()</h4></a>Seamlessly tile the current image horizontally</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_tile_vertical()"><h4>tile_vertical()</h4></a>Seamlessly tile the current image vertically</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 Method Summary</h2></td> + </tr> + + <tr> + <td align="right" valign="top">mixed</td> + <td align="left" valign="top" width="100%"><a href="#function__get_cb()"><h4>_get_cb(string $cb)</h4></a>Callback for functions which query the current instance's attributes</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function__no_param_cb()"><h4>_no_param_cb(string $cb)</h4></a>Callback for functions which flip or tile the current instance</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">integer</td> + <td align="left" valign="top" width="100%"><a href="#variable_$id"><h4>$id</h4></a>The image resource id#</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_ImlibImage()"><h4>ImlibImage</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void ImlibImage( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + ImlibImage 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_blend_onto_image()"><h4>blend_onto_image</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>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 )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Blend a region of the current image onto the region of another ImlibImage + <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">$dst</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">id# of the destination image</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">bool</td> + <td align="left" valign="top">$alpha</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">alpha</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">$sx</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left source X coordinate</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">$sy</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left source Y coordinate</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">$sw</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">width</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">$sh</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">height</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">$dx</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left destination X coordinate</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">$dy</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left destination Y coordinate</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">$dw</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">width</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">$dh</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">height</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">bool</td> + <td align="left" valign="top">$dither</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">bool</td> + <td align="left" valign="top">$blend</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">bool</td> + <td align="left" valign="top">$alias</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></td> + </tr> + </table> + </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_blur()"><h4>blur</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void blur( int $r )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Blur an image with a given blur radius + <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">$r</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">radius</td> + </tr> + </table> + </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_create_clone()"><h4>create_clone</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public object ImlibImage create_clone( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Create a clone of the current instance, return a new ImlibImage + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>object ImlibImage <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_create_cropped()"><h4>create_cropped</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public object ImlibImage create_cropped( int $sx, int $sy, int $sw, int $sh )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Create a cropped ImlibImage from a region of the current instance, return a new ImlibImage + <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">$sx</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left X coordinate to crop 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">$sy</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left Y coordinate to crop 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">$sw</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to crop</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">$sh</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to crop</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>object ImlibImage <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_create_cropped_scaled()"><h4>create_cropped_scaled</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public object ImlibImage create_cropped_scaled( int $sx, int $sy, int $sw, int $sh, int $dw, int $dh )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Create a cropped, scaled ImlibImage from a region of the current instance, return a new ImlibImage + <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">$sx</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left X coordinate to crop 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">$sy</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left Y coordinate to crop 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">$sw</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to crop</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">$sh</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to crop</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">$dw</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to scale the cropped region to</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">$dh</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to scale the cropped region to</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>object ImlibImage <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_create()"><h4>create</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public int create( int $width, int $height )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Create an image resource to use with this instance + <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">$width</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">of the image</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">$height</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">of the image</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>int <p>Resource id# that was created</td> + </tr> + + + + + + + + + + + <tr> + <td align="left" valign="top">See Also</td> + <td align="left" valign="top"><a href="#function_get_id()">get_id()</a>, <a href="#var_$id">$id</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_create_rotated()"><h4>create_rotated</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public object ImlibImage create_rotated( float $degrees, [ float $radians ] )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Create a rotated ImlibImage, return a new ImlibImage + <br> + If radians is specified, degrees will be ignored. + <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">float</td> + <td align="left" valign="top">$degrees</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to rotate the image</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">float</td> + <td align="left" valign="top">$radians</td> + <td align="left" valign="top"><code>= >>0<<</code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to rotate the image</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>object ImlibImage <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_create_scaled()"><h4>create_scaled</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public object ImlibImage create_scaled( integer $width, [ integer $height ] )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Create a scaled ImlibImage, return a new ImlibImage + <br> + If $height is not specified, it will be calculated from the dimensionsof the current image, so that the aspect ratio is preserved. + <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">integer</td> + <td align="left" valign="top">$width</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to scale the new image to</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">integer</td> + <td align="left" valign="top">$height</td> + <td align="left" valign="top"><code>= >>0<<</code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to scale the new image to (Optional)</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>object ImlibImage <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_dump()"><h4>dump</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void dump( [ integer $quality ] )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Output the raw image data of the current instance to stdout + <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">integer</td> + <td align="left" valign="top">$quality</td> + <td align="left" valign="top"><code>= >>75<<</code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">or compression level to use</td> + </tr> + </table> + </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_flip_diagonal()"><h4>flip_diagonal</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void flip_diagonal( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Flip the current image diagonally + <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_flip_horizontal()"><h4>flip_horizontal</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void flip_horizontal( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Flip the current image horizontally + <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_flip_vertical()"><h4>flip_vertical</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void flip_vertical( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Flip the current image vertically + <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_free()"><h4>free</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void free( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Free the current instance and image resource + <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_filename()"><h4>get_filename</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public mixed get_filename( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the current filename, if it's set + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>mixed <p>Filename string or false.</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_format()"><h4>get_format</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public string get_format( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the current image format. The default is png. + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>string <p>Image format</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_height()"><h4>get_height</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public integer get_height( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the current image's height + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>integer <p>Image height</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_id()"><h4>get_id</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public integer get_id( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the current image's resource id# + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>integer <p>Current resource id#</td> + </tr> + + + + + + + + + + + <tr> + <td align="left" valign="top">See Also</td> + <td align="left" valign="top"><a href="#var_$id">$id</a>, <a href="#function_create()">create()</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_width()"><h4>get_width</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public integer get_width( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the current image's width + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>integer <p>Image width</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_has_alpha()"><h4>has_alpha</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public boolean has_alpha( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Check if the image has an alpha channel + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>boolean <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_modify_alpha()"><h4>modify_alpha</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void modify_alpha( int $alpha )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the alpha channel of an image + <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">$alpha</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">alpha level to set for the image</td> + </tr> + </table> + </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_load()"><h4>load</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public integer load( string $infile, [ integer $err ] )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Load an image file into the current instance + <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">string</td> + <td align="left" valign="top">$infile</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">integer</td> + <td align="left" valign="top">$err</td> + <td align="left" valign="top"><code>= >>0<<</code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">error number. 0 for no error.</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>integer <p>Resource id# or false if load failed</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_save()"><h4>save</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool save( string $outfile, [ integer $quality ] )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Save the current instance to a file + <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">string</td> + <td align="left" valign="top">$outfile</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top"></td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">integer</td> + <td align="left" valign="top">$quality</td> + <td align="left" valign="top"><code>= >>75<<</code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">or compression level to use</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if the save failed</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_format()"><h4>set_format</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_format( string $format )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the image format for the current instance + <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">string</td> + <td align="left" valign="top">$format</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">format</td> + </tr> + </table> + </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_sharpen()"><h4>sharpen</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void sharpen( int $r )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Sharpen an image with a given sharpen radius + <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">$r</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">radius</td> + </tr> + </table> + </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_tile()"><h4>tile</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void tile( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Seamlessly tile the current image both horizontally and vertically + <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_tile_horizontal()"><h4>tile_horizontal</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void tile_horizontal( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Seamlessly tile the current image horizontally + <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_tile_vertical()"><h4>tile_vertical</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void tile_vertical( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Seamlessly tile the current image vertically + <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> + + </table> + </tr> + + <tr> + <td align="left" valign="top"> + <table width="100%" border="0"> + <tr> + <td colspan="2" align="left" valign="top"><h2>Private Method Details</h2></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function__get_cb()"><h4>_get_cb</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private mixed _get_cb( string $cb )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Callback for functions which query the current instance's attributes + <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">string</td> + <td align="left" valign="top">$cb</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">name of the function to call</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>mixed <p>String or int</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function__no_param_cb()"><h4>_no_param_cb</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private void _no_param_cb( string $cb )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Callback for functions which flip or tile the current instance + <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">string</td> + <td align="left" valign="top">$cb</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">name of the function to call</td> + </tr> + </table> + </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> + + </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_$id"><h4>$id</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private integer $id</b> + <p> + >><code></code><< + <p> + The image resource id# + <br> + + </td> + </tr> + + + + + + + + <tr> + <td align="left" valign="top">See Also</td> + <td align="left" valign="top"><a href="#function_create()">create()</a>, <a href="#function_get_id()">get_id()</a></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> 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 @@ +<!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: ImlibPoly</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.ImlibPoly.php" target="_new">/home/matt/src/cvs/imlib/docs/class.ImlibPoly.php</a> + <h5>PHP Imlib2 Classes - Imlib</h5> + <h1>ImlibPoly</h1> + <a href="ImlibColor.html">ImlibColor</a><br> |<br> +-- <a href="ImlibCliprect.html">ImlibCliprect</a><br> |<br> +-- ImlibPoly<br> + <p> + Does everything relevant to creating and drawing or filling an n-point polygon + <p> + + </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>public class ImlibPoly extends <a href="ImlibCliprect.html">ImlibCliprect</a></h4> + Does everything relevant to creating and drawing or filling an n-point polygon + <br> + 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. + <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 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 ImlibCliprect</h3></td> + </tr> + <tr> + <td align="left" valign="top"><a href="ImlibCliprect.html#function_imlibcliprect">imlibcliprect</a>, <a href="ImlibCliprect.html#function_get_cliprect">get_cliprect</a>, <a href="ImlibCliprect.html#function_get_cliprect_array">get_cliprect_array</a>, <a href="ImlibCliprect.html#function_get_cliprect_inuse">get_cliprect_inuse</a>, <a href="ImlibCliprect.html#function_set_cliprect">set_cliprect</a>, <a href="ImlibCliprect.html#function_set_cliprect_array">set_cliprect_array</a>, <a href="ImlibCliprect.html#function_set_cliprect_inuse">set_cliprect_inuse</a></td> + </tr> + </table> + </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_ImlibPoly()"><h4>ImlibPoly()</h4></a>ImlibPoly constructor</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_add_point()"><h4>add_point(int $x, int $y)</h4></a>Add a point to the current polygon</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_contains_point()"><h4>contains_point(int $x, int $y)</h4></a>Checks if the current polygon contains a given point</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_draw()"><h4>draw([ integer $closed ])</h4></a>Draw the current polygon on the current image</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_fill()"><h4>fill()</h4></a>Fill the current polygon on the current image</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_free()"><h4>free()</h4></a>Free the current polygon</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_get_bounds()"><h4>get_bounds(int &$x1, int &$y1, int &$x2, int &$y2)</h4></a>Get the bounds of the polygon</td> + </tr> + + <tr> + <td align="right" valign="top">int</td> + <td align="left" valign="top" width="100%"><a href="#function_get_image()"><h4>get_image()</h4></a>Get the current image resource id#</td> + </tr> + + <tr> + <td align="right" valign="top">int</td> + <td align="left" valign="top" width="100%"><a href="#function_new_poly()"><h4>new_poly()</h4></a>Create a new polygon</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_image()"><h4>set_image(int $im)</h4></a>Set the image resource id# to draw on</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 ImlibCliprect</h3></td> + </tr> + <tr> + <td align="left" valign="top"><a href="ImlibCliprect.html#variable_$cliprect">$cliprect</a>, <a href="ImlibCliprect.html#variable_$cliprect_inuse">$cliprect_inuse</a></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">unknown</td> + <td align="left" valign="top" width="100%"><a href="#variable_$im"><h4>$im</h4></a>Resource id# of the image to draw on</td> + </tr> + + <tr> + <td align="right" valign="top">unknown</td> + <td align="left" valign="top" width="100%"><a href="#variable_$poly"><h4>$poly</h4></a>The resource id# of the current polygon</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_ImlibPoly()"><h4>ImlibPoly</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void ImlibPoly( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + ImlibPoly 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_add_point()"><h4>add_point</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool add_point( int $x, int $y )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Add a point to the current polygon + <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">coordinate</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">coordinate</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if there is no polygon set</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_contains_point()"><h4>contains_point</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool contains_point( int $x, int $y )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Checks if the current polygon contains a given point + <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">coordinate</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">coordinate</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>True if it does, false otherwise</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_draw()"><h4>draw</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool draw( [ integer $closed ] )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Draw the current polygon on the current image + <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">integer</td> + <td align="left" valign="top">$closed</td> + <td align="left" valign="top"><code>= >>1<<</code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">true, the polygon will be drawn with the endpoints connected</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if there is no polygon or image set</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_fill()"><h4>fill</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool fill( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Fill the current polygon on the current image + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if there is no polygon or image set</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_free()"><h4>free</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool free( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Free the current polygon + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if there is no polygon or image set</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_bounds()"><h4>get_bounds</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool get_bounds( int &$x1, int &$y1, int &$x2, int &$y2 )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the bounds of the polygon + <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">&$x1</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left X coordinate</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">&$y1</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">left Y coordinate</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">&$x2</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">right X coordinate</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">&$y2</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">right Y coordinate</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if there is no polygon or image set</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_image()"><h4>get_image</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public int get_image( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the current image resource id# + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>int <p>Current image resource id#</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_new_poly()"><h4>new_poly</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public int new_poly( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Create a new polygon + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>int <p>Resource id# of the new polygon</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_image()"><h4>set_image</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_image( int $im )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the image resource id# to draw on + <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">$im</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">resource id#</td> + </tr> + </table> + </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> + + </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_$im"><h4>$im</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private unknown $im</b> + <p> + >><code></code><< + <p> + Resource id# of the image to draw on + <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_$poly"><h4>$poly</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private unknown $poly</b> + <p> + >><code></code><< + <p> + The resource id# of the current polygon + <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> 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 @@ +<!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: ImlibText</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.ImlibText.php" target="_new">/home/matt/src/cvs/imlib/docs/class.ImlibText.php</a> + <h5>PHP Imlib2 Classes - Imlib</h5> + <h1>ImlibText</h1> + <a href="ImlibColor.html">ImlibColor</a><br> |<br> +-- ImlibText<br> + <p> + Does everything relevant to text drawing + <p> + + </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>public class ImlibText extends <a href="ImlibColor.html">ImlibColor</a></h4> + Does everything relevant to text drawing + <br> + The routine for dealing text is to load a font, set an image to draw on,and draw a string. + <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 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_ImlibText()"><h4>ImlibText()</h4></a>ImlibText constructor</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_draw()"><h4>draw(int $x, int $y, string $str, [ string $dir ])</h4></a>Draw a text string onto the current image</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_free()"><h4>free()</h4></a>Free the currently loaded font</td> + </tr> + + <tr> + <td align="right" valign="top">integer</td> + <td align="left" valign="top" width="100%"><a href="#function_get_image()"><h4>get_image()</h4></a>Get the current image resource id#</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_get_size()"><h4>get_size(string $str, int &$w, int &$h, [ string $dir ])</h4></a>Get the width and height of a given string if it were drawn</td> + </tr> + + <tr> + <td align="right" valign="top">bool</td> + <td align="left" valign="top" width="100%"><a href="#function_load()"><h4>load(string $path, string $font, int $size)</h4></a>Load a font</td> + </tr> + + <tr> + <td align="right" valign="top">void</td> + <td align="left" valign="top" width="100%"><a href="#function_set_image()"><h4>set_image(int $im)</h4></a>Set the image resource id# to draw on</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">unknown</td> + <td align="left" valign="top" width="100%"><a href="#variable_$fnt"><h4>$fnt</h4></a>Resource id# of the currently loaded font</td> + </tr> + + <tr> + <td align="right" valign="top">unknown</td> + <td align="left" valign="top" width="100%"><a href="#variable_$im"><h4>$im</h4></a>Resource id# of the image to draw on</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_ImlibText()"><h4>ImlibText</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void ImlibText( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + ImlibText 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_draw()"><h4>draw</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool draw( int $x, int $y, string $str, [ string $dir ] )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Draw a text string onto the current image + <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">coordinate of the upper left corner of the string</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">coordinate of the upper left corner of the string</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">string</td> + <td align="left" valign="top">$str</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">string to draw</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">string</td> + <td align="left" valign="top">$dir</td> + <td align="left" valign="top"><code>= >>IMLIB_TEXT_TO_RIGHT<<</code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">of the text</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no font is loaded</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_free()"><h4>free</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool free( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Free the currently loaded font + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no font is loaded</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_image()"><h4>get_image</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public integer get_image( )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the current image resource id# + <br> + + <p> + + </td> + </tr> + + + <tr> + <td align="left" valign="top">Returns</td> + <td>integer <p>Image resource id#</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_size()"><h4>get_size</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool get_size( string $str, int &$w, int &$h, [ string $dir ] )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Get the width and height of a given string if it were drawn + <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">string</td> + <td align="left" valign="top">$str</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to measure</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">Width the string would be</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">Height the string would be</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">string</td> + <td align="left" valign="top">$dir</td> + <td align="left" valign="top"><code>= >>IMLIB_TEXT_TO_RIGHT<<</code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">to measure the string</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no font is loaded</td> + </tr> + + + + + + + + + + + + + <tr> + <td colspan="2" align="left" valign="top"><hr></td> + </tr> + + <tr><td colspan="2" align="left" valign="top"><a name="function_load()"><h4>load</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public bool load( string $path, string $font, int $size )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Load a font + <br> + 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. + <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">string</td> + <td align="left" valign="top">$path</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">, or current directory if passed blank</td> + </tr> + </table> + </td> + </tr> + + <tr> + <td></td> + <td align="left" valign="top"> + <table> + <tr> + <td align="left" valign="top">string</td> + <td align="left" valign="top">$font</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">name</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">$size</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">size</td> + </tr> + </table> + </td> + </tr> + + + + <tr> + <td align="left" valign="top">Returns</td> + <td>bool <p>False if no font is loaded</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_image()"><h4>set_image</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>public void set_image( int $im )</b><p> + </td> + </tr> + <tr> + <td width="10" align="left" valign="top"> </td> + <td align="left" valign="top"> + Set the image resource id# to draw on + <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">$im</td> + <td align="left" valign="top"><code></code></td> + </tr> + <tr> + <td></td> + <td colspan="2" align="left" valign="top">resource id#</td> + </tr> + </table> + </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> + + </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_$fnt"><h4>$fnt</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private unknown $fnt</b> + <p> + >><code></code><< + <p> + Resource id# of the currently loaded font + <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_$im"><h4>$im</h4></a></td></tr> + <tr> + <td colspan="2" align="left" valign="top"> + <b>private unknown $im</b> + <p> + >><code></code><< + <p> + Resource id# of the image to draw on + <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> 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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- Generated with PHPDoc, http://www.phpdoc.de --> +<html> +<head> + <title>PHP Imlib2 Classes - Frameset Packagelist</title> + <link href="phpdoc.css" rel="stylesheet" type="text/css"> +</head> + +<body> + +<table width="100%"> + <tr> + <td align="left" valign="top"><h4>Packagelist</h4></td> + </tr> + + <tr> + <td align="left" valign="top"><a href="packageelementlist_Imlib.html" target="packageelements">Imlib</a></td> + </tr> + +</table> + +</body> +</html> 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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- Generated with PHPDoc, http://www.phpdoc.de --> +<html> +<head> + <link href="phpdoc.css" rel="stylesheet" type="text/css"> + <title>PHP Imlib2 Classes - Frameset Packageelements</title> +</head> + +<body> + <table width="100%"> + <tr> + <td colspan=3 align="left" valign="top"> + <h3>Packagelist</h3> + </td> + </tr> + + <tr> + <td colspan="3" align="left" valign="top"><h4>Imlib</h4></td> + </tr> + + <tr> + <td align="left" valign="top"> </td> + <td colspan="2" align="left" valign="top"><h5>Classes</h5></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibColorRange.html" target="main">ImlibColorRange</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibDraw.html" target="main">ImlibDraw</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibPoly.html" target="main">ImlibPoly</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibCliprect.html" target="main">ImlibCliprect</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibText.html" target="main">ImlibText</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibColor.html" target="main">ImlibColor</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibImage.html" target="main">ImlibImage</a></td> + </tr> + + + + + </table> +</body> +</html> 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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- Generated with PHPDoc, http://www.phpdoc.de --> +<html> +<head> + <title>PHP Imlib2 Classes - Classtrees</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"><h1>Classtrees</h1></td> + </tr> + + <tr> + <td height="10" align="left" valign="top"> </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>ImlibColor</h4> + <ul><li><a href="ImlibColor.html">ImlibColor</a><ul><li><a href="ImlibCliprect.html">ImlibCliprect</a><ul><li><a href="ImlibColorRange.html">ImlibColorRange</a><li><a href="ImlibDraw.html">ImlibDraw</a><li><a href="ImlibPoly.html">ImlibPoly</a></ul><li><a href="ImlibText.html">ImlibText</a></ul></ul> + </td> + </tr> + + <tr> + <td height="10" align="left" valign="top"> </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>ImlibImage</h4> + <ul><li><a href="ImlibImage.html">ImlibImage</a></ul> + </td> + </tr> + + <tr> + <td height="10" align="left" valign="top"><hr></td> + </tr> + <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 align="left" valign="top">PHPDoc 1.0beta</td> + </tr> +</table> +</body> +</html> 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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- Generated with PHPDoc, http://www.phpdoc.de --> +<html> +<head> + <title>PHP Imlib2 Classes - Elementlist</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" colspan="2"> + <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 colspan="2" align="left" valign="top"> + <a href="#a">a</a> <a href="#b">b</a> <a href="#c">c</a> <a href="#d">d</a> <a href="#f">f</a> <a href="#g">g</a> <a href="#h">h</a> <a href="#I">I</a> <a href="#i">i</a> <a href="#l">l</a> <a href="#m">m</a> <a href="#n">n</a> <a href="#p">p</a> <a href="#s">s</a> <a href="#t">t</a> <a href="#_">_</a> + </td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="a">a</a></h4></td> + </tr> + + <tr> + <td>add_color</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColorRange.html">ImlibColorRange</a><br> + Add a color to the color range at distance $x. + </td> + </tr> + + <tr> + <td>add_color_array</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColorRange.html">ImlibColorRange</a><br> + Add a color to the color range at distance $x. + </td> + </tr> + + <tr> + <td>add_point</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + Add a point to the current polygon + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="b">b</a></h4></td> + </tr> + + <tr> + <td>blend_onto_image</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Blend a region of the current image onto the region of another ImlibImage + </td> + </tr> + + <tr> + <td>blur</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Blur an image with a given blur radius + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="c">c</a></h4></td> + </tr> + + <tr> + <td>create</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColorRange.html">ImlibColorRange</a><br> + Create a new color range + </td> + </tr> + + <tr> + <td>create</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Create an image resource to use with this instance + </td> + </tr> + + <tr> + <td>$cr</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibColorRange.html">ImlibColorRange</a><br> + Resource id# of the current color range + </td> + </tr> + + <tr> + <td>contains_point</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + Checks if the current polygon contains a given point + </td> + </tr> + + <tr> + <td>$cliprect</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibCliprect.html">ImlibCliprect</a><br> + The array defining the cliprect (x,y,w,h) + </td> + </tr> + + <tr> + <td>$cliprect_inuse</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibCliprect.html">ImlibCliprect</a><br> + A boolean that determines if a cliprect is in use or not + </td> + </tr> + + <tr> + <td>$color</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibColor.html">ImlibColor</a><br> + The array defining the color (r,g,b,a) + </td> + </tr> + + <tr> + <td>create_clone</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Create a clone of the current instance, return a new ImlibImage + </td> + </tr> + + <tr> + <td>create_cropped</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Create a cropped ImlibImage from a region of the current instance, return a new ImlibImage + </td> + </tr> + + <tr> + <td>create_cropped_scaled</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Create a cropped, scaled ImlibImage from a region of the current instance, return a new ImlibImage + </td> + </tr> + + <tr> + <td>create_rotated</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Create a rotated ImlibImage, return a new ImlibImage + </td> + </tr> + + <tr> + <td>create_scaled</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Create a scaled ImlibImage, return a new ImlibImage + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="d">d</a></h4></td> + </tr> + + <tr> + <td>draw_ellipse</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibDraw.html">ImlibDraw</a><br> + Draw an ellipse + </td> + </tr> + + <tr> + <td>draw_line</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibDraw.html">ImlibDraw</a><br> + Draw a line + </td> + </tr> + + <tr> + <td>draw_rectangle</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibDraw.html">ImlibDraw</a><br> + Draw a rectangle + </td> + </tr> + + <tr> + <td>draw</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + Draw the current polygon on the current image + </td> + </tr> + + <tr> + <td>draw</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibText.html">ImlibText</a><br> + Draw a text string onto the current image + </td> + </tr> + + <tr> + <td>dump</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Output the raw image data of the current instance to stdout + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="f">f</a></h4></td> + </tr> + + <tr> + <td>free</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColorRange.html">ImlibColorRange</a><br> + Free the current color range + </td> + </tr> + + <tr> + <td>free</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + Free the current polygon + </td> + </tr> + + <tr> + <td>free</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibText.html">ImlibText</a><br> + Free the currently loaded font + </td> + </tr> + + <tr> + <td>free</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Free the current instance and image resource + </td> + </tr> + + <tr> + <td>fill_rectangle</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColorRange.html">ImlibColorRange</a><br> + Fill the current image with a rectangle using the current color range + </td> + </tr> + + <tr> + <td>fill_rectangle</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibDraw.html">ImlibDraw</a><br> + Fill a rectangle + </td> + </tr> + + <tr> + <td>fill_ellipse</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibDraw.html">ImlibDraw</a><br> + Fill an ellipse + </td> + </tr> + + <tr> + <td>fill</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + Fill the current polygon on the current image + </td> + </tr> + + <tr> + <td>$fnt</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibText.html">ImlibText</a><br> + Resource id# of the currently loaded font + </td> + </tr> + + <tr> + <td>flip_diagonal</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Flip the current image diagonally + </td> + </tr> + + <tr> + <td>flip_horizontal</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Flip the current image horizontally + </td> + </tr> + + <tr> + <td>flip_vertical</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Flip the current image vertically + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="g">g</a></h4></td> + </tr> + + <tr> + <td>get_image</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibDraw.html">ImlibDraw</a><br> + Get the current image resource id# + </td> + </tr> + + <tr> + <td>get_image</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + Get the current image resource id# + </td> + </tr> + + <tr> + <td>get_image</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibText.html">ImlibText</a><br> + Get the current image resource id# + </td> + </tr> + + <tr> + <td>get_bounds</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + Get the bounds of the polygon + </td> + </tr> + + <tr> + <td>get_cliprect</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibCliprect.html">ImlibCliprect</a><br> + Get the four values of the cliprect + </td> + </tr> + + <tr> + <td>get_cliprect_array</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibCliprect.html">ImlibCliprect</a><br> + Get the array that defines the cliprect (x,y,w,h) + </td> + </tr> + + <tr> + <td>get_cliprect_inuse</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibCliprect.html">ImlibCliprect</a><br> + Get the boolean that determines if a cliprect is in use or not + </td> + </tr> + + <tr> + <td>get_size</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibText.html">ImlibText</a><br> + Get the width and height of a given string if it were drawn + </td> + </tr> + + <tr> + <td>get_color</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColor.html">ImlibColor</a><br> + Get the four color components as by-reference variables + </td> + </tr> + + <tr> + <td>get_color_array</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColor.html">ImlibColor</a><br> + Get the color array currently defined, if it is defined + </td> + </tr> + + <tr> + <td>get_filename</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Get the current filename, if it's set + </td> + </tr> + + <tr> + <td>get_format</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Get the current image format. The default is png. + </td> + </tr> + + <tr> + <td>get_height</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Get the current image's height + </td> + </tr> + + <tr> + <td>get_id</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Get the current image's resource id# + </td> + </tr> + + <tr> + <td>get_width</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Get the current image's width + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="h">h</a></h4></td> + </tr> + + <tr> + <td>has_alpha</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Check if the image has an alpha channel + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="I">I</a></h4></td> + </tr> + + <tr> + <td>ImlibColorRange</td> + <td width="100%" align="left" valign="top"> + Class <a href="ImlibColorRange.html">ImlibColorRange</a>.<br> + All functions relevant to creating and displaying color ranges + </td> + </tr> + + <tr> + <td>ImlibColorRange</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColorRange.html">ImlibColorRange</a><br> + ImlibColorRange constructor + </td> + </tr> + + <tr> + <td>ImlibDraw</td> + <td width="100%" align="left" valign="top"> + Class <a href="ImlibDraw.html">ImlibDraw</a>.<br> + Does everything relevant to drawing or filling ellipses, lines, or rectangles + </td> + </tr> + + <tr> + <td>ImlibDraw</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibDraw.html">ImlibDraw</a><br> + ImlibDraw constructor + </td> + </tr> + + <tr> + <td>ImlibPoly</td> + <td width="100%" align="left" valign="top"> + Class <a href="ImlibPoly.html">ImlibPoly</a>.<br> + Does everything relevant to creating and drawing or filling an n-point polygon + </td> + </tr> + + <tr> + <td>ImlibPoly</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + ImlibPoly constructor + </td> + </tr> + + <tr> + <td>ImlibCliprect</td> + <td width="100%" align="left" valign="top"> + Class <a href="ImlibCliprect.html">ImlibCliprect</a>.<br> + Provides variables and methods for a clipping rectangle + </td> + </tr> + + <tr> + <td>ImlibCliprect</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibCliprect.html">ImlibCliprect</a><br> + ImlibCliprect constructor + </td> + </tr> + + <tr> + <td>ImlibText</td> + <td width="100%" align="left" valign="top"> + Class <a href="ImlibText.html">ImlibText</a>.<br> + Does everything relevant to text drawing + </td> + </tr> + + <tr> + <td>ImlibText</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibText.html">ImlibText</a><br> + ImlibText constructor + </td> + </tr> + + <tr> + <td>ImlibColor</td> + <td width="100%" align="left" valign="top"> + Class <a href="ImlibColor.html">ImlibColor</a>.<br> + Provides variables and methods for handling color + </td> + </tr> + + <tr> + <td>ImlibColor</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColor.html">ImlibColor</a><br> + ImlibColor constructor + </td> + </tr> + + <tr> + <td>ImlibImage</td> + <td width="100%" align="left" valign="top"> + Class <a href="ImlibImage.html">ImlibImage</a>.<br> + Handles image loading and saving, parameters, manipulation, and rendering. + </td> + </tr> + + <tr> + <td>ImlibImage</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + ImlibImage constructor + </td> + </tr> + + <tr> + <td>Imlib</td> + <td width="100%" align="left" valign="top"> + Package<br> + + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="i">i</a></h4></td> + </tr> + + <tr> + <td>$im</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibColorRange.html">ImlibColorRange</a><br> + Resource id# of the image to draw on + </td> + </tr> + + <tr> + <td>$im</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibDraw.html">ImlibDraw</a><br> + Resource id# of the image to draw on + </td> + </tr> + + <tr> + <td>$im</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibPoly.html">ImlibPoly</a><br> + Resource id# of the image to draw on + </td> + </tr> + + <tr> + <td>$im</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibText.html">ImlibText</a><br> + Resource id# of the image to draw on + </td> + </tr> + + <tr> + <td>$id</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibImage.html">ImlibImage</a><br> + The image resource id# + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="l">l</a></h4></td> + </tr> + + <tr> + <td>load</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibText.html">ImlibText</a><br> + Load a font + </td> + </tr> + + <tr> + <td>load</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Load an image file into the current instance + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="m">m</a></h4></td> + </tr> + + <tr> + <td>modify_alpha</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Set the alpha channel of an image + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="n">n</a></h4></td> + </tr> + + <tr> + <td>new_poly</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + Create a new polygon + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="p">p</a></h4></td> + </tr> + + <tr> + <td>$poly</td> + <td width="100%" align="left" valign="top"> + Variable in Class <a href="ImlibPoly.html">ImlibPoly</a><br> + The resource id# of the current polygon + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="s">s</a></h4></td> + </tr> + + <tr> + <td>set_image</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColorRange.html">ImlibColorRange</a><br> + Set the image to draw the color range on + </td> + </tr> + + <tr> + <td>set_image</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibDraw.html">ImlibDraw</a><br> + Set the image resource id# to draw on + </td> + </tr> + + <tr> + <td>set_image</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibPoly.html">ImlibPoly</a><br> + Set the image resource id# to draw on + </td> + </tr> + + <tr> + <td>set_image</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibText.html">ImlibText</a><br> + Set the image resource id# to draw on + </td> + </tr> + + <tr> + <td>set_cliprect</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibCliprect.html">ImlibCliprect</a><br> + Set the four values of the cliprect. 0 for X disables the cliprect. + </td> + </tr> + + <tr> + <td>set_cliprect_array</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibCliprect.html">ImlibCliprect</a><br> + Set the array that defines the cliprect (x,y,w,h) + </td> + </tr> + + <tr> + <td>set_cliprect_inuse</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibCliprect.html">ImlibCliprect</a><br> + Set the boolean that determines if the cliprect is in use + </td> + </tr> + + <tr> + <td>set_color</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColor.html">ImlibColor</a><br> + Set the current color using the four components + </td> + </tr> + + <tr> + <td>set_color_array</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibColor.html">ImlibColor</a><br> + Set the current color using an array of 4 elements (r,g,b,a) + </td> + </tr> + + <tr> + <td>save</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Save the current instance to a file + </td> + </tr> + + <tr> + <td>set_format</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Set the image format for the current instance + </td> + </tr> + + <tr> + <td>sharpen</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Sharpen an image with a given sharpen radius + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="t">t</a></h4></td> + </tr> + + <tr> + <td>tile</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Seamlessly tile the current image both horizontally and vertically + </td> + </tr> + + <tr> + <td>tile_horizontal</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Seamlessly tile the current image horizontally + </td> + </tr> + + <tr> + <td>tile_vertical</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Seamlessly tile the current image vertically + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top"><h4><a name="_">_</a></h4></td> + </tr> + + <tr> + <td>_draw_something</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibDraw.html">ImlibDraw</a><br> + Callback for drawing everything + </td> + </tr> + + <tr> + <td>_get_cb</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Callback for functions which query the current instance's attributes + </td> + </tr> + + <tr> + <td>_no_param_cb</td> + <td width="100%" align="left" valign="top"> + Function in class <a href="ImlibImage.html">ImlibImage</a><br> + Callback for functions which flip or tile the current instance + </td> + </tr> + + + <tr> + <td colspan="2" align="left" valign="top" bgcolor="Silver"> + <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 colspan="2" align="left" valign="top">PHPDoc 1.0beta</td> + </tr> +</table> + + +</body> +</html> 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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- Generated with PHPDoc, http://www.phpdoc.de --> +<html> +<head> + <title>PHP Imlib2 Classes - Packagelist</title> + <link href="phpdoc.css" rel="stylesheet" type="text/css"> +</head> + +<body> + +<table width="100%"> + <tr> + <td align="left" valign="top" bgcolor="#C0C0C0"> + <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 align="center" valign="top"> + <h1>PHP Imlib2 Classes</h1> + </td> + </tr> + <tr> + <td align="left" valign="top"> + <table> + <tr> + <td colspan=3 align="left" valign="top"> + <h3>Packagelist</h3> + </td> + </tr> + + <tr> + <td colspan="3" align="left" valign="top"><h4>Imlib</h4></td> + </tr> + + <tr> + <td align="left" valign="top"> </td> + <td colspan="2" align="left" valign="top"><h5>Classes</h5></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibColorRange.html">ImlibColorRange</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibDraw.html">ImlibDraw</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibPoly.html">ImlibPoly</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibCliprect.html">ImlibCliprect</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibText.html">ImlibText</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibColor.html">ImlibColor</a></td> + </tr> + + <tr> + <td colspan="2" align="left" valign="top"> </td> + <td align="left" valign="top"><a href="ImlibImage.html">ImlibImage</a></td> + </tr> + + + + + </table> + </td> + </tr> + <tr> + <td align="left" valign="top" bgcolor="#C0C0C0"> + <table> + <tr> + <td align="left" valign="top"><a href="overview.html">Overview</a></td> + <td align="left" valign="top"><a href="packageindex.html">Packageindex</a></td> + <td align="left" valign="top"><a href="classtree.html">Classtree</a></td> + <td align="left" valign="top"><a href="help.html">Help</a></td> + </tr> + </table> + </td> + </tr> + <tr> + <td height="10" align="left" valign="top"><hr></td> + </tr> + <tr> + <td align="left" valign="top" bgcolor="#C0C0C0"> + <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 align="left" valign="top">PHPDoc 1.0beta</td> + </tr> +</table> + +</body> +</html> 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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- Generated with PHPDoc, http://www.phpdoc.de --> +<html> +<head> + <title>PHP Imlib2 Classes - Report</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"><h1>Warnings</h1></td> + </tr + + <tr> + <td height="10" align="left" valign="top"> </td> + </tr> + <tr> + <td align="left" valign="top"> + <h4>/home/matt/src/cvs/imlib/docs/class.ImlibText.php</h4> + 2 Warning(s). + </td> + </tr> + <tr> + <td height="10" align="left" valign="top"> </td> + </tr> + <tr> + <td align="left" valign="top"> + <table border="0" cellspacing="4" cellpadding="4" bordercolor="Silver"> + + <tr> + <td align="left" valign="top"><b>[function] draw</b></td> + <td align="left" valign="top">mismatch</td> + </tr> + <tr> + <td colspan="2" align="left" valign="top">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.</td> + </tr> + <tr> + <td height="5" colspan="2" align="left" valign="top"> </td> + </tr> + + <tr> + <td align="left" valign="top"><b>[function] get_size</b></td> + <td align="left" valign="top">mismatch</td> + </tr> + <tr> + <td colspan="2" align="left" valign="top">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.</td> + </tr> + <tr> + <td height="5" colspan="2" align="left" valign="top"> </td> + </tr> + + </table> + </td> + </tr> + + <tr> + <td height="10" align="left" valign="top"><hr></td> + </tr> + <tr> + <td align="left" valign="top" bgcolor="#C0C0C0"> + <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 align="left" valign="top">PHPDoc 1.0beta</td> + </tr> +</table> +</body> +</html> 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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- Generated with PHPDoc, http://www.phpdoc.de --> +<html> +<head> + <title> - Modulegroups</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"><h1>XML Files</h1></td> + </tr + <tr> + <td height="10" align="left" valign="top"> </td> + </tr> + <tr> + <td align="left" valign="top"> + <ul> + <li><a href="class_ImlibColorRange.xml">class_ImlibColorRange.xml</a><li><a href="class_ImlibDraw.xml">class_ImlibDraw.xml</a><li><a href="class_ImlibPoly.xml">class_ImlibPoly.xml</a><li><a href="class_ImlibCliprect.xml">class_ImlibCliprect.xml</a><li><a href="class_ImlibText.xml">class_ImlibText.xml</a><li><a href="class_ImlibColor.xml">class_ImlibColor.xml</a><li><a href="classtree_ImlibColor.xml">classtree_ImlibColor.xml</a><li><a href="class_ImlibImage.xml">class_ImlibImage.xml</a><li><a href="classtree_ImlibImage.xml">classtree_ImlibImage.xml</a><li><a href="packagelist.xml">packagelist.xml</a><li><a href="elementlist.xml">elementlist.xml</a><li><a href="warnings_classanalyser.xml">warnings_classanalyser.xml</a> + </ul> + </td> + </tr> + <tr> + <td height="10" align="left" valign="top"><hr></td> + </tr> + <tr> + <td align="left" valign="top" bgcolor="#C0C0C0"> + <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 align="left" valign="top">PHPDoc 1.0beta</td> + </tr> +</table> +</body> +</html> |