Image_Tools
[ class tree: Image_Tools ] [ index: Image_Tools ] [ all elements ]

Class: Image_Tools_Blend

Source Location: /Image_Tools-1.0.0RC1/Image/Tools/Blend.php

Class Overview

Image_Tools
   |
   --Image_Tools_Blend

Class provide image blending functions.


Author(s):

Version:

  • Release: 1.0.0RC1

Copyright:

  • Copyright (c) 2008 Firman Wandayandi <firman@php.net>

Variables

Methods


Inherited Variables

Inherited Methods

Class: Image_Tools

Image_Tools::Image_Tools()
Constructor
Image_Tools::availableMethods()
Get available methods
Image_Tools::availableOptions()
Get all available options of the subclass
Image_Tools::createImage()
Create a GD image resource from given input.
Image_Tools::createImageFromFile()
Create a GD image resource from file (JPEG, PNG, WBMP and XBM support).
Image_Tools::createImageFromString()
Create a GD image resource from a string data.
Image_Tools::display()
Display rendered image (send it to browser).
Image_Tools::factory()
Create a new instance of an image tool
Image_Tools::get()
Get the value of the option
Image_Tools::getAPIVersion()
Get the API version of the common base
Image_Tools::getResultImage()
Get rendered image.
Image_Tools::getVersion()
Get the subclass version.
Image_Tools::isGDImageResource()
Find the whether a value is the GD image resource or not.
Image_Tools::isValidOption()
Has the option a valid value? Determines, if the value given is valid for the option.
Image_Tools::postRender()
Function which called after render.
Image_Tools::preRender()
Function which called before render.
Image_Tools::render()
Render the result of a tool to the given image
Image_Tools::save()
Save rendered image to a file.
Image_Tools::set()
Set the option(s)
Image_Tools::supportsMethod()
Get the method parameters
Image_Tools::supportsOption()
Find out the whether a subclass supports the option

Class Details

[line 55]
Class provide image blending functions.

Algorithms base on article http://www.pegtop.net/delphi/articles/blendmodes written by Jens Gruschel.

  • Author: Firman Wandayandi <firman@php.net>
  • Version: Release: 1.0.0RC1
  • Copyright: Copyright (c) 2008 Firman Wandayandi <firman@php.net>
  • Since: Class available since Release 1.0.0RC1
  • License: BSD License


[ Top ]


Class Variables

$availableOptions = array(
        'image1'    => 'mixed',
        'image2'    => 'mixed',
        'mode'      => 'string',
        'x'         => 'integer',
        'y'         => 'integer',
        'params'    => 'array'
    )

[line 99]

Available options.
  • See: Image_Tools_Utils::$options
  • Access: protected

Type:   array
Overrides:   Array


[ Top ]

$options = array(
        'image1' => null,
        'image2' => null,
        'mode'   => 'normal',
        'x'      => 0,
        'y'      => 0,
        'params' => array())

[line 83]

Blend options:

 image1   mixed   First image or destination or background
 image2   mixed   Second image or sample or foreground
 mode     string  Blend mode, may one of normal, multiply,
                  screen, darken, lighten, difference, exclusion,
                  negation, interpolation, stamp, softlight, hardlight,
                  overlay, colordodge, colorburn, softdodge, softburn,
                  additive, subtractive, reflect, glow, freeze, heat,
                  logicXOR, logicAND or logicOR
 x        int     X position of the second image on the first image
 y        int     Y position of the second image on the first image

  • Access: protected

Type:   array
Overrides:   Array


[ Top ]

$version =  '0.1'

[line 63]

Image_Tools_Thumbnail API version.
  • Access: protected

Type:   string
Overrides:   Array


[ Top ]



Method Detail

preRender   [line 140]

bool|PEAR_Error preRender( )

Function which called before render.

Overrides Image_Tools::preRender() (Function which called before render.)
[ Top ]

render   [line 170]

true|PEAR_Error render( )

Apply the blend mode.
  • Access: protected

Overrides Image_Tools::render() (Render the result of a tool to the given image)
[ Top ]


Documentation generated on Mon, 26 May 2008 06:30:06 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.