BitmapDataExtensionsAdjustBrightness Method
Adjusts the brightness of the specified bitmapData.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 7.0.0
public static void AdjustBrightness(
this IReadWriteBitmapData bitmapData,
float brightness,
IDitherer? ditherer = null,
ColorChannels channels = ColorChannels.Rgb
)
<ExtensionAttribute>
Public Shared Sub AdjustBrightness (
bitmapData As IReadWriteBitmapData,
brightness As Single,
Optional ditherer As IDitherer = Nothing,
Optional channels As ColorChannels = ColorChannels.Rgb
)
public:
[ExtensionAttribute]
static void AdjustBrightness(
IReadWriteBitmapData^ bitmapData,
float brightness,
IDitherer^ ditherer = nullptr,
ColorChannels channels = ColorChannels::Rgb
)
[<ExtensionAttribute>]
static member AdjustBrightness :
bitmapData : IReadWriteBitmapData *
brightness : float32 *
?ditherer : IDitherer *
?channels : ColorChannels
(* Defaults:
let _ditherer = defaultArg ditherer null
let _channels = defaultArg channels ColorChannels.Rgb
*)
-> unit
- 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.
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).
This method adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. 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.
This method calls the TransformColors method internally. See
the Remarks section of the TransformColors method for more details.
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.
The ditherer is ignored for KnownPixelFormats with more than 16 bits-per-pixel and for the Format16bppGrayScale format.
See the
Examples section of the
BitmapExtensions.AdjustBrightness method for an example.