[Summary view] [Print] [Text view]

   1  ImageAPI 
   2  
   3  A non writing image manipulation API for Drupal. This API is meant to be used in place of the API provided 
   4  by image.inc. You probably do not need to install this module unless another module are you using requires
   5  it. It provides no new features to your drupal site. It only provides an API other modules can leverage.
   6  
   7  Changes From image.inc API:
   8    - Images are objects.
   9    - Images are not written on each image operation and must be explicitly 
  10      closed when processing is complete. 
  11    - Multiple Image ToolKits can be used simultaneously. However, only the image
  12      toolkit and image was opened with can be used to process it. This is hidden 
  13      in the imageapi layer.
  14  
  15  API Quick Reference:
  16    imageapi_image_scale_and_crop($image, $width, $height) 
  17    imageapi_image_scale($image, $width, $height, $upscale = FALSE) 
  18    imageapi_image_resize($image, $width, $height) 
  19    imageapi_image_rotate($image, $degrees, $bgcolor = 0x000000) 
  20    imageapi_image_crop($image, $x, $y, $width, $height) 
  21    imageapi_image_desaturate($image) 
  22    imageapi_image_open($file, $toolkit = FALSE) 
  23    imageapi_image_close($image, $destination) 
  24  
  25    $image is an image object returned from imageapi_image_open();
  26  
  27  Expanding ImageAPI:
  28  
  29    If you wish to expand on ImageAPI add a new wrapper function to 
  30    imageapi.module. Do any common preprocessing for all underlying layers in the 
  31    wrapper function, then invoke the driver. Pay heed to the function naming in
  32    ImageAPI and ImageAPI GD. If the toolkit changes the size of an image it must
  33    update the $image->info['width'] and $image->info['height'] variables. All 
  34    ToolKit functions should return TRUE on success and FALSE on failure.
  35  
  36  For more detailed documentation read imageapi.module.
  37  
  38  -dopry