diff options
Diffstat (limited to 'phpdoc/ImlibColorRange.html')
| -rw-r--r-- | phpdoc/ImlibColorRange.html | 797 |
1 files changed, 797 insertions, 0 deletions
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> |