BitmapDataExtensionsBeginTransformColors(IReadWriteBitmapData, FuncColor32, Color32, IDitherer, AsyncConfig) Method

public static IAsyncResult BeginTransformColors(
	this IReadWriteBitmapData bitmapData,
	Func<Color32, Color32> transformFunction,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginTransformColors ( 
	bitmapData As IReadWriteBitmapData,
	transformFunction As Func(Of Color32, Color32),
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginTransformColors(
	IReadWriteBitmapData^ bitmapData, 
	Func<Color32, Color32>^ transformFunction, 
	IDitherer^ ditherer = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginTransformColors : 
        bitmapData : IReadWriteBitmapData * 
        transformFunction : Func<Color32, Color32> * 
        ?ditherer : IDitherer * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _ditherer = defaultArg ditherer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

bitmapData  IReadWriteBitmapData

The IReadWriteBitmapData to be transformed.

transformFunction  FuncColor32, Color32

The transform function to be used on the colors of the specified bitmapData. It must be thread-safe.

ditherer  IDitherer  (Optional)

An optional IDitherer instance to dither the result of the transformation if transformFunction returns colors that is not compatible with the PixelFormat of the specified bitmapData. This parameter is optional.
Default value: .

asyncConfig  AsyncConfig  (Optional)

The configuration of the asynchronous 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. This parameter is optional.
Default value: .

Return Value

Usage Note

In .NET Framework 4.0 and above you can use also the TransformColorsAsync(IReadWriteBitmapData, FuncColor32, Color32, IDitherer, TaskConfig) method.

To finish the operation and to get the exception that occurred during the operation you have to call the EndTransformColors method.

This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.

Reference