Path

ez components / documentation / api reference / latest / imageconversion


eZ Components latest

ImageConversion: ezcImageEffectFilters

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Interface: ezcImageEffectFilters

This interface has to be implemented by ezcImageFilters classes to support effect filters. [source]

Method Summary

public void border( $width, $color )
Border filter.
public void noise( $value )
Noise filter.
public void swirl( $value )
Swirl filter.

Methods

border

void border( int $width, $color )
Border filter.
Adds a border to the image. The width is measured in pixel. The color is defined in an array of hex values:
 1.  array(
 2.       => <red value>,
 3.       => <green value>,
 4.       => <blue value>,
 5.  );

Parameters

Name Type Description
$width int Width of the border.
$color array(int) Color.

Throws

ClassDescription
ezcImageInvalidReferenceException No loaded file could be found or an error destroyed a loaded reference.
ezcImageFilterFailedException If the operation performed by the the filter failed.
ezcBaseValueException If a submitted parameter was out of range or type.

noise

void noise( strings $value )
Noise filter.
Apply a noise transformation to the image. Valid values are the following strings:
  • 'Uniform'
  • 'Gaussian'
  • 'Multiplicative'
  • 'Impulse'
  • 'Laplacian'
  • 'Poisson'

Parameters

Name Type Description
$value strings Noise value as described above.

Throws

ClassDescription
ezcImageFilterFailedException If the operation performed by the the filter failed.
ezcBaseValueException If a submitted parameter was out of range or type.
ezcImageInvalidReferenceException No loaded file could be found or an error destroyed a loaded reference.

swirl

void swirl( int $value )
Swirl filter.
Applies a swirl with the given intense to the image.

Parameters

Name Type Description
$value int Intense of swirl.

Throws

ClassDescription
ezcImageInvalidReferenceException No loaded file could be found or an error destroyed a loaded reference.
ezcImageFilterFailedException If the operation performed by the the filter failed.
ezcBaseValueException If a submitted parameter was out of range or type.

Last updated: Mon, 21 Dec 2009