File: class_ImlibPoly.xml

package info (click to toggle)
php-imlib 0.7-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 1,020 kB
  • ctags: 817
  • sloc: php: 2,464; ansic: 1,324; xml: 94; makefile: 67; sh: 12
file content (1 line) | stat: -rw-r--r-- 4,740 bytes parent folder | download | duplicates (4)
1
<?xml version="1.0"?><phpdoc><class name="ImlibPoly" extends="ImlibCliprect" undoc="false" access="public" package="Imlib"><file>/home/matt/src/cvs/imlib/docs/class.ImlibPoly.php</file><doc><author email="cardinal@dodds.net">Matt McClanahan</author><inherited src="Array"/><description>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.</description><shortdescription>Does everything relevant to creating and drawing or filling an n-point polygon</shortdescription><version>0.3</version></doc><function name="ImlibPoly" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>ImlibPoly constructor</shortdescription></doc></function><function name="add_point" undoc="false" access="public"><doc><parameter name="$x" type="int">coordinate</parameter><parameter name="$y" type="int">coordinate</parameter><return name="" type="bool">False if there is no polygon set</return><description/><shortdescription>Add a point to the current polygon</shortdescription></doc></function><function name="contains_point" undoc="false" access="public"><doc><parameter name="$x" type="int">coordinate</parameter><parameter name="$y" type="int">coordinate</parameter><return name="" type="bool">True if it does, false otherwise</return><description/><shortdescription>Checks if the current polygon contains a given point</shortdescription></doc></function><function name="draw" undoc="false" access="public"><doc><parameter name="$closed" default="1" type="integer">true, the polygon will be drawn with the endpoints connected</parameter><return name="" type="bool">False if there is no polygon or image set</return><description/><shortdescription>Draw the current polygon on the current image</shortdescription></doc></function><function name="fill" undoc="false" access="public"><doc><return name="" type="bool">False if there is no polygon or image set</return><description/><shortdescription>Fill the current polygon on the current image</shortdescription></doc></function><function name="free" undoc="false" access="public"><doc><return name="" type="bool">False if there is no polygon or image set</return><description/><shortdescription>Free the current polygon</shortdescription></doc></function><function name="get_bounds" undoc="false" access="public"><doc><parameter name="&amp;$x1" type="int">left X coordinate</parameter><parameter name="&amp;$y1" type="int">left Y coordinate</parameter><parameter name="&amp;$x2" type="int">right X coordinate</parameter><parameter name="&amp;$y2" type="int">right Y coordinate</parameter><return name="" type="bool">False if there is no polygon or image set</return><description/><shortdescription>Get the bounds of the polygon</shortdescription></doc></function><function name="get_image" undoc="false" access="public"><doc><return name="" type="int">Current image resource id#</return><description/><shortdescription>Get the current image resource id#</shortdescription></doc></function><function name="new_poly" undoc="false" access="public"><doc><return name="" type="int">Resource id# of the new polygon</return><description/><shortdescription>Create a new polygon</shortdescription></doc></function><function name="set_image" undoc="false" access="public"><doc><parameter name="$im" type="int">resource id#</parameter><return type="void"/><description/><shortdescription>Set the image resource id# to draw on</shortdescription></doc></function><variable name="$im" access="private" type="unknown"><doc><description/><shortdescription>Resource id# of the image to draw on</shortdescription></doc></variable><variable name="$poly" access="private" type="unknown"><doc><description/><shortdescription>The resource id# of the current polygon</shortdescription></doc></variable><inherited src="ImlibCliprect" type="functions"><element>imlibcliprect</element><element>get_cliprect</element><element>get_cliprect_array</element><element>get_cliprect_inuse</element><element>set_cliprect</element><element>set_cliprect_array</element><element>set_cliprect_inuse</element></inherited><inherited src="ImlibColor" type="functions"><element>imlibcolor</element><element>get_color</element><element>get_color_array</element><element>set_color</element><element>set_color_array</element></inherited><inherited src="ImlibCliprect" type="variables"><element>$cliprect</element><element>$cliprect_inuse</element></inherited><inherited src="ImlibColor" type="variables"><element>$color</element></inherited><path><parent>ImlibCliprect</parent><parent>ImlibColor</parent></path><baseclass>ImlibColor</baseclass></class></phpdoc>