File: class_ImlibImage.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-- 10,264 bytes parent folder | download | duplicates (4)
1
<?xml version="1.0"?><phpdoc><class name="ImlibImage" extends="" undoc="false" access="public" package="Imlib"><file>/home/matt/src/cvs/imlib/docs/class.ImlibImage.php</file><doc><author email="cardinal@dodds.net">Matt McClanahan</author><description>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.</description><shortdescription>Handles image loading and saving, parameters, manipulation, and rendering.</shortdescription><version>0.3</version></doc><function name="ImlibImage" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>ImlibImage constructor</shortdescription></doc></function><function name="_get_cb" undoc="false" access="private"><doc><parameter name="$cb" type="string">name of the function to call</parameter><return name="" type="mixed">String or int</return><description/><shortdescription>Callback for functions which query the current instance&amp;apos;s attributes</shortdescription></doc></function><function name="_no_param_cb" undoc="false" access="private"><doc><parameter name="$cb" type="string">name of the function to call</parameter><return type="void"/><description/><shortdescription>Callback for functions which flip or tile the current instance</shortdescription></doc></function><function name="blend_onto_image" undoc="false" access="public"><doc><parameter name="$dst" type="int">id# of the destination image</parameter><parameter name="$alpha" type="bool">alpha</parameter><parameter name="$sx" type="int">left source X coordinate</parameter><parameter name="$sy" type="int">left source Y coordinate</parameter><parameter name="$sw" type="int">width</parameter><parameter name="$sh" type="int">height</parameter><parameter name="$dx" type="int">left destination X coordinate</parameter><parameter name="$dy" type="int">left destination Y coordinate</parameter><parameter name="$dw" type="int">width</parameter><parameter name="$dh" type="int">height</parameter><parameter name="$dither" type="bool"/><parameter name="$blend" type="bool"/><parameter name="$alias" type="bool"/><return type="void"/><description/><shortdescription>Blend a region of the current image onto the region of another ImlibImage</shortdescription></doc></function><function name="blur" undoc="false" access="public"><doc><parameter name="$r" type="int">radius</parameter><return type="void"/><description/><shortdescription>Blur an image with a given blur radius</shortdescription></doc></function><function name="create_clone" undoc="false" access="public"><doc><return name="" type="object ImlibImage"/><description/><shortdescription>Create a clone of the current instance, return a new ImlibImage</shortdescription></doc></function><function name="create_cropped" undoc="false" access="public"><doc><parameter name="$sx" type="int">left X coordinate to crop from</parameter><parameter name="$sy" type="int">left Y coordinate to crop from</parameter><parameter name="$sw" type="int">to crop</parameter><parameter name="$sh" type="int">to crop</parameter><return name="" type="object ImlibImage"/><description/><shortdescription>Create a cropped ImlibImage from a region of the current instance, return a new ImlibImage</shortdescription></doc></function><function name="create_cropped_scaled" undoc="false" access="public"><doc><parameter name="$sx" type="int">left X coordinate to crop from</parameter><parameter name="$sy" type="int">left Y coordinate to crop from</parameter><parameter name="$sw" type="int">to crop</parameter><parameter name="$sh" type="int">to crop</parameter><parameter name="$dw" type="int">to scale the cropped region to</parameter><parameter name="$dh" type="int">to scale the cropped region to</parameter><return name="" type="object ImlibImage"/><description/><shortdescription>Create a cropped, scaled ImlibImage from a region of the current instance, return a new ImlibImage</shortdescription></doc></function><function name="create" undoc="false" access="public"><doc><see type="function">get_id()</see><see type="var">$id</see><parameter name="$width" type="int">of the image</parameter><parameter name="$height" type="int">of the image</parameter><return name="" type="int">Resource id# that was created</return><description/><shortdescription>Create an image resource to use with this instance</shortdescription></doc></function><function name="create_rotated" undoc="false" access="public"><doc><parameter name="$degrees" type="float">to rotate the image</parameter><parameter name="$radians" default="0" type="float">to rotate the image</parameter><return name="" type="object ImlibImage"/><description>If radians is specified, degrees will be ignored.</description><shortdescription>Create a rotated ImlibImage, return a new ImlibImage</shortdescription></doc></function><function name="create_scaled" undoc="false" access="public"><doc><parameter name="$width" type="integer">to scale the new image to</parameter><parameter name="$height" default="0" type="integer">to scale the new image to (Optional)</parameter><return name="" type="object ImlibImage"/><description>If $height is not specified, it will be calculated from the dimensionsof the current image, so that the aspect ratio is preserved.</description><shortdescription>Create a scaled ImlibImage, return a new ImlibImage</shortdescription></doc></function><function name="dump" undoc="false" access="public"><doc><parameter name="$quality" default="75" type="integer">or compression level to use</parameter><return type="void"/><description/><shortdescription>Output the raw image data of the current instance to stdout</shortdescription></doc></function><function name="flip_diagonal" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>Flip the current image diagonally</shortdescription></doc></function><function name="flip_horizontal" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>Flip the current image horizontally</shortdescription></doc></function><function name="flip_vertical" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>Flip the current image vertically</shortdescription></doc></function><function name="free" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>Free the current instance and image resource</shortdescription></doc></function><function name="get_filename" undoc="false" access="public"><doc><return name="" type="mixed">Filename string or false.</return><description/><shortdescription>Get the current filename, if it&amp;apos;s set</shortdescription></doc></function><function name="get_format" undoc="false" access="public"><doc><return name="" type="string">Image format</return><description/><shortdescription>Get the current image format.  The default is png.</shortdescription></doc></function><function name="get_height" undoc="false" access="public"><doc><return name="" type="integer">Image height</return><description/><shortdescription>Get the current image&amp;apos;s height</shortdescription></doc></function><function name="get_id" undoc="false" access="public"><doc><see type="var">$id</see><see type="function">create()</see><return name="" type="integer">Current resource id#</return><description/><shortdescription>Get the current image&amp;apos;s resource id#</shortdescription></doc></function><function name="get_width" undoc="false" access="public"><doc><return name="" type="integer">Image width</return><description/><shortdescription>Get the current image&amp;apos;s width</shortdescription></doc></function><function name="has_alpha" undoc="false" access="public"><doc><return name="" type="boolean"/><description/><shortdescription>Check if the image has an alpha channel</shortdescription></doc></function><function name="modify_alpha" undoc="false" access="public"><doc><parameter name="$alpha" type="int">alpha level to set for the image</parameter><return type="void"/><description/><shortdescription>Set the alpha channel of an image</shortdescription></doc></function><function name="load" undoc="false" access="public"><doc><parameter name="$infile" type="string"/><parameter name="$err" default="0" type="integer">error number.  0 for no error.</parameter><return name="" type="integer">Resource id# or false if load failed</return><description/><shortdescription>Load an image file into the current instance</shortdescription></doc></function><function name="save" undoc="false" access="public"><doc><parameter name="$outfile" type="string"/><parameter name="$quality" default="75" type="integer">or compression level to use</parameter><return name="" type="bool">False if the save failed</return><description/><shortdescription>Save the current instance to a file</shortdescription></doc></function><function name="set_format" undoc="false" access="public"><doc><parameter name="$format" type="string">format</parameter><return type="void"/><description/><shortdescription>Set the image format for the current instance</shortdescription></doc></function><function name="sharpen" undoc="false" access="public"><doc><parameter name="$r" type="int">radius</parameter><return type="void"/><description/><shortdescription>Sharpen an image with a given sharpen radius</shortdescription></doc></function><function name="tile" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>Seamlessly tile the current image both horizontally and vertically</shortdescription></doc></function><function name="tile_horizontal" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>Seamlessly tile the current image horizontally</shortdescription></doc></function><function name="tile_vertical" undoc="false" access="public"><doc><return type="void"/><description/><shortdescription>Seamlessly tile the current image vertically</shortdescription></doc></function><variable name="$id" access="private" type="integer"><doc><see type="function">create()</see><see type="function">get_id()</see><description/><shortdescription>The image resource id#</shortdescription></doc></variable></class></phpdoc>