BitmapDataExtensionsAdjustBrightness(IReadWriteBitmapData, Single, IDitherer, ColorChannels) Method

Adjusts the brightness of the specified bitmapData.

See the online help of the BitmapExtensions.AdjustBrightness method for some examples with images.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
C#
public static void AdjustBrightness(
	this IReadWriteBitmapData bitmapData,
	float brightness,
	IDitherer? ditherer = null,
	ColorChannels channels = ColorChannels.Rgb
)

Parameters

bitmapData  IReadWriteBitmapData
The IReadWriteBitmapData to be transformed.
brightness  Single
A float value between -1 and 1, inclusive bounds. Positive values make the bitmapData brighter, while negative values make it darker.
ditherer  IDitherer  (Optional)
An optional IDitherer instance to dither the result of the transformation if the transformed colors are not compatible with the PixelFormat of the specified bitmapData. This parameter is optional.
Default value: .
channels  ColorChannels  (Optional)
The ColorChannels, on which the adjustment has to be performed. This parameter is optional.
Default value: Rgb.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadWriteBitmapData. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

  Note

This method adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. You can use the AdjustBrightness(IReadWriteBitmapData, Single, IDitherer, ColorChannels, ParallelConfig) overload to configure these, while still executing the method synchronously. Alternatively, use the BeginAdjustBrightness or AdjustBrightnessAsync (in .NET Framework 4.0 and above) methods for asynchronous call and to adjust parallelization, set up cancellation and for reporting progress.

If bitmapData has an indexed PixelFormat and ditherer is , then its palette entries are tried to be transformed instead of the actual pixels in the first place (if it is supported by bitmapData). To transform the colors of an indexed IBitmapData without changing the palette specify a non- ditherer. Transforming the palette is both faster and provides a better result.

If ditherer is , this method attempts to preserve the original color depth, including wide pixel formats.

The ditherer may have no effect for KnownPixelFormats with more than 16 bits-per-pixel and for grayscale formats.

Exceptions

ArgumentNullExceptionbitmapData is .
ArgumentOutOfRangeExceptionbrightness is not between -1 and 1
-or-
channels is out of the defined flags.

See Also