This method creates a lens like effect on a raster image.

[Visual Basic]
Public Function Lens(refract As Double, backColor As Boolean, red As Byte, green As Byte, blue As Byte) As Boolean
[C#]
public bool Lens(double refract, bool backColor, byte red, byte green, byte blue);

Parameters

refract
     Sets the lens magnification (Greater than 1)

backColor
     Sets whether or not the area outside of the lens effect is painted a particular color [True: the area is painted, False: the area is not painted]

red
     Sets the red component of the color painted in the area outside the lens (from 0 to 255)

green
     Sets the green component of the color painted in the area outside the lens (from 0 to 255)

blue
     Sets the Blue component of the color painted in the area outside the lens (from 0 to 255)

Return Value

Returns True if successful. Returns False if unsuccessful.

Explanation

The Lens method produces a lens like effect on a raster image. To execute the Lens method, set the image handle of the image in the SourceImage property. The Lens method supports 8-bit grayscale, 16, 24, and 32 bit images.

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

  1. To use a mask image, set the SelectMode property to EffectMask. Set the mask image handle in the SourceMask property
  2. To process the total image, set the SelectMode property to EffectAll
  3. To process the polygonal area on the image, set the SelectMode property to EffectPolygon. Select the polygon by setting the appropriate coordinate values for the points of the polygon in the Point property
  4. To process an elliptical area on the image, set the SelectMode property to EffectEllipse. Select the ellipse by setting the appropriate values for the bounding rectangle in the Rect property

When the SelectMode property is set to EffectPolygon or EffectEllipse, the appropriate values must be set in the Inside property.

If successful the resulting raster image data is set in the DestinationImage property.

See Also

Effect Class | Effect Members

The ImageKit.NET3 is created by Newtone Corporation