BitmapDataExtensionsAdjustBrightness(IReadWriteBitmapData, IAsyncContext, Single, IDitherer, ColorChannels) Method

public static bool AdjustBrightness(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext? context,
	float brightness,
	IDitherer? ditherer = null,
	ColorChannels channels = ColorChannels.Rgb
)

<ExtensionAttribute>
Public Shared Function AdjustBrightness ( 
	bitmapData As IReadWriteBitmapData,
	context As IAsyncContext,
	brightness As Single,
	Optional ditherer As IDitherer = Nothing,
	Optional channels As ColorChannels = ColorChannels.Rgb
) As Boolean

public:
[ExtensionAttribute]
static bool AdjustBrightness(
	IReadWriteBitmapData^ bitmapData, 
	IAsyncContext^ context, 
	float brightness, 
	IDitherer^ ditherer = nullptr, 
	ColorChannels channels = ColorChannels::Rgb
)

[<ExtensionAttribute>]
static member AdjustBrightness : 
        bitmapData : IReadWriteBitmapData * 
        context : IAsyncContext * 
        brightness : float32 * 
        ?ditherer : IDitherer * 
        ?channels : ColorChannels 
(* Defaults:
        let _ditherer = defaultArg ditherer null
        let _channels = defaultArg channels ColorChannels.Rgb
*)
-> bool 

Parameters

bitmapData  IReadWriteBitmapData

The IReadWriteBitmapData to be transformed.

context  IAsyncContext

An IAsyncContext instance that contains information for asynchronous processing about the current operation.

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.

Return Value

Usage Note

This method blocks the caller thread, but if context belongs to an async top level method, then the execution may already run on a pool thread. Degree of parallelism, the ability of cancellation and reporting progress depend on how these were configured at the top level method. To reconfigure the degree of parallelism of an existing context, you can use the AsyncContextWrapper class.

Alternatively, you can use this method to specify the degree of parallelism for synchronous execution. For example, by passing AsyncHelper.SingleThreadContext to the context parameter the method will be forced to use a single thread only.

When reporting progress, this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface.

Reference