[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/sites/all/modules/imageapi/ -> imageapi.module (summary)

(no description)

File Size: 463 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 16 functions

  imageapi_perm()
  imageapi_menu()
  imageapi_settings()
  imageapi_get_available_toolkits()
  imageapi_default_toolkit()
  imageapi_toolkit_invoke()
  imageapi_image_scale_and_crop()
  imageapi_image_scale()
  imageapi_image_resize()
  imageapi_image_rotate()
  imageapi_image_sharpen()
  imageapi_image_crop()
  imageapi_image_desaturate()
  imageapi_image_open()
  imageapi_image_close()
  imageapi_hex2rgba()

Functions
Functions that are not part of a class:

imageapi_perm()   X-Ref
Implementation of hook_perm().


imageapi_menu()   X-Ref
Implementation of hook_menu().


imageapi_settings()   X-Ref
No description

imageapi_get_available_toolkits()   X-Ref
Return a list of available toolkits.

return:

imageapi_default_toolkit()   X-Ref
Retrieve the name of the currently used toolkit.

return:

imageapi_toolkit_invoke($method, &$image, array $params = array()   X-Ref
Invokes the given method using the currently selected toolkit.

param: $method
param: $image
param: $params
return:

imageapi_image_scale_and_crop(&$image, $width, $height)   X-Ref
Scales an image to the exact width and height given.

This function achieves the target aspect ratio by cropping the original image
equally on both sides, or equally on the top and bottom. This function is
useful to create uniform sized avatars from larger images.

The resulting image always has the exact target dimensions.

param: $image
param: $width
param: $height
return:

imageapi_image_scale(&$image, $width = NULL, $height = NULL, $upscale = FALSE)   X-Ref
Scales an image to the given width and height while maintaining aspect
ratio.

The resulting image can be smaller for one or both target dimensions.

param: $image
param: $width
param: $height
param: $upscale
return:

imageapi_image_resize(&$image, $width, $height)   X-Ref
Resize an image to the given dimensions (ignoring aspect ratio).

param: $image
param: $width
param: $height
return:

imageapi_image_rotate(&$image, $degrees, $background = NULL)   X-Ref
Rotate an image by the given number of degrees.

param: $image
param: $degrees
param: $background
return:

imageapi_image_sharpen(&$image, $radius, $sigma, $amount, $threshold)   X-Ref
Sharpen an image given some sharpening parameters.

NOTE: These parameters only have an effect when Imagemagick is used.
GD will used a fixed convolution matrix as described in imageapi_gd.module

param: $image
param: $radius
param: $sigma
param: $amount
param: $threshold
return:

imageapi_image_crop(&$image, $x, $y, $width, $height)   X-Ref
Crop an image to the rectangle specified by the given rectangle.

param: $image
param: $x
param: $y
param: $width
param: $height
return:

imageapi_image_desaturate(&$image)   X-Ref
Convert an image to grayscale.

param: $image
return:

imageapi_image_open($file, $toolkit = FALSE)   X-Ref
Open an image file and return an image object.

Any changes to the file are not saved until imageapi_image_close() is called.

param: $file
param: $toolkit
return:

imageapi_image_close($image, $destination = NULL)   X-Ref
Close the image and save the changes to a file.

param: $image
param: $destination
return:

imageapi_hex2rgba($hex)   X-Ref
Convert a hex string to its RGBA (Red, Green, Blue, Alpha) integer
components.

param: $hex
return:



Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7