RedEyeRemoval (ImageKit Control/ Effect Method)

This method removes "red eye" from images by converting reddish colors within the selected area to another specified color.

[C++Builder] [ bool = ]imagekitcontrolname->Effect->RedEyeRemoval(const TPoint * Points, const int Points_Size, short Red, short Green, short Blue, short Error)

[C++Builder] [ bool = ]imagekitcontrolname->Effect->RedEyeRemoval(short Red, short Green, short Blue, short Error)

[Delphi] [ Boolean = ]imagekitcontrolname.Effect.RedEyeRemoval(const Points: array of TPoint; Red, Green, Blue, Error: Smallint)

[Delphi] [ Boolean = ]imagekitcontrolname.Effect.RedEyeRemoval(Red, Green, Blue, Error: Smallint)

Parameters

Name	Explanation
Points	An array of x and y coordinate values defining points of a polygonal area on the image. (in pixels) In C++Builder, the size of the Points array is given by Points_Size - 1
Red	Sets the red component for the specified color after the red eye removal (from 0 to 255)
Green	Sets the green component for the specified color after the red eye removal (from 0 to 255)
Blue	Sets the blue component for the specified color after the red eye removal (from 0 to 255)
Error	Sets a margin of error for converting colors within the selected area. Any colors falling outside this margin of error will be converted to the color specifed by the Red, Green, and Blue parameters. (from 0 to 255)

Return Value

Returns True if successful, otherwise returns False.

Explanation

The RedEyeRemoval method removes "red eye" from images by converting colors within the selected area to another specified color. The Error parameter sets a margin of error for colors within the selected area. Any color whose red value falls outside this margin of error will be converted to the color specifed by the Red, Green and Blue parameters. As the Error parameter value increases only colors closer to pure red will be converted. As the Error parameter decreases, a wider and wider range of "reddish" colors will be converted.

To execute the RedEyeRemoval method, set the image handle of the image in the ImageHandle property or the Layer(LayerNo).ImageHandle property. The RedEyeRemoval method supports 16, 24, and 32 bit images.

Before executing the RedEyeRemoval method, you must set the area on the image that will be affected. There are 4 ways to do this.

To use a mask image, set the SelectMode property to vikEffectMask. Set the mask image handle in the MaskImageHandle property
To process the total image, set the SelectMode property to vikEffectAll.
To process the polygonal area on the image, set the SelectMode property to vikEffectPolygon. Select the polygon by setting the appropriate coordinate values for the points of the polygon in the Points array. The number of points defining the polygon must be 3 or more.
To process an elliptical area on the image, set the SelectMode property to vikEffectEllipse. Select the ellipse by setting the appropriate values for the bounding rectangle in the RectLeft, RectTop, RectRight, and RectBottom properties

When the SelectMode property is set to vikEffectPolygon or vikEffectEllipse, the InOut property should be set. When the SelectMode property is set to values other than vikEffectPolygon, please set the Points parameter to a dummy array or to NULL.

If successful the resulting raster image data is set in the LayerNo property (the ImageHandle property or the Layer(LayerNo).ImageHandle property. If unsuccessful, 0 is returned.

When the Caption, Message, and ButtonName properties are blank, the progress dialog box will not be displayed. When the progress dialog box is displayed, the percentage that the processing has completed will be shown in the dialog box.

Differences from the ImageKit 7/8/9/10 ActiveX

The parameters x, y have been changed to type TPoint
In Delphi, it is not necessary to pass the size of the array of x, y points.