Newtone.ImageKit.Effect.SetContrast Method

This method adjusts the contrast of a raster image.

Parameters

level
     Contrast Level (-100 to 100)

Return Value

Returns True if successful. Returns False if unsuccessful.

Explanation

The SetContrast method adjusts the contrast of the image. You can adjust the contrast by using the Level parameter which can have a value ranging from -100 to 100. When the Level parameter is 0, there is no change in the image contrast. When the Level parameter values are negative, contrast decreases. When the Level parameter values are positive, the contrast increases.

To execute the SetContrast method, set the image handle of the image in the SourceImage property. The SetContrast method supports 4, 8, 16, 24, and 32 bit images.

Before executing the SetContrast 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. Set the appropriate values 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

Note: When the SelectMode property is set to EffectPolygon or EffectEllipse, the 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