BitmapDataExtensionsAdjustBrightness(IReadWriteBitmapData, Single, IDitherer, ColorChannels, ParallelConfig) Method
Adjusts the brightness of the specified
bitmapData.
See the
online help of the
BitmapExtensions.AdjustBrightness method for some examples with images.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
public static bool AdjustBrightness(
this IReadWriteBitmapData bitmapData,
float brightness,
IDitherer? ditherer,
ColorChannels channels,
ParallelConfig? parallelConfig
)
<ExtensionAttribute>
Public Shared Function AdjustBrightness (
bitmapData As IReadWriteBitmapData,
brightness As Single,
ditherer As IDitherer,
channels As ColorChannels,
parallelConfig As ParallelConfig
) As Boolean
public:
[ExtensionAttribute]
static bool AdjustBrightness(
IReadWriteBitmapData^ bitmapData,
float brightness,
IDitherer^ ditherer,
ColorChannels channels,
ParallelConfig^ parallelConfig
)
[<ExtensionAttribute>]
static member AdjustBrightness :
bitmapData : IReadWriteBitmapData *
brightness : float32 *
ditherer : IDitherer *
channels : ColorChannels *
parallelConfig : ParallelConfig -> bool
- 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
- 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.
- channels ColorChannels
- The ColorChannels, on which the adjustment has to be performed.
- parallelConfig ParallelConfig
- The configuration of the operation such as parallelization, cancellation, reporting progress, etc.
When Progress is set in this parameter,
then this library always passes a DrawingOperation instance to the generic methods of
the IAsyncProgress interface.
If , then the degree of parallelization is configured automatically.
Boolean, if the operation completed successfully.
, if the operation has been canceled and the
ThrowIfCanceled property
of the
parallelConfig parameter was
.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 blocks the caller as it executes synchronously, though the
parallelConfig parameter allows configuring the degree of parallelism,
cancellation and progress reporting. Use the
BeginAdjustBrightness or
AdjustBrightnessAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.
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.
See the
Examples section of the
BitmapExtensions.AdjustBrightness method for a few examples.
