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