This method adjusts the brightness of a raster image.

[Visual Basic] Public Function SetBrightness(level As Integer) As Boolean
[C#] public bool SetBrightness(int level);

Parameters

level
   Brightness Level (-255 to 255)

Return Value

Returns True if successful. Returns False if unsuccessful.

Explanation

The SetBrightness method adjusts the brightness of a raster image. Setting the Level parameter to negative values will result in a darker image. Setting the Level parameter to positive values will result in a brighter image. The Level parameter can have a value ranging from -255 to 255. When the Level parameter is 0, there is no change in the image brightness.

To execute the SetBrightness method, set the image handle of the image in the Image property or the Layer(LayerNumber).Image property. The value of the LayerNumber property will determine which image is processed. The SetBrightness method supports 4, 8, 16, 24, and 32 bit images.

If the SetBrightness method is successful and the DestinationAsImageKitImage property is True, the resulting image will be set in the Image property or in the Layer(LayerNumber).Image property, according to the value set in the LayerNumber property.

If the SetBrightness method is successful and the DestinationAsImageKitImage property is False, the resulting image will be set in the DestinationImage property.

Before executing the SetBrightness 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.

See Also

ImageKit.Effect Members | Newtone.ImageKit.Wpf.ImageKit

 

The ImageKit WPF is created by Newtone Corporation