BitmapDataExtensionsBeginTransformColors Method

Begins to transform the colors of this bitmapData asynchronously, using the specified transformFunction delegate.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 7.0.0
C#
public static IAsyncResult BeginTransformColors(
	this IReadWriteBitmapData bitmapData,
	Func<Color32, Color32> transformFunction,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null
)

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

IAsyncResult
An IAsyncResult that represents the asynchronous operation, which could still be pending.

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

In .NET Framework 4.0 and above you can use also the TransformColorsAsync 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.

Exceptions

ArgumentNullExceptionbitmapData or transformFunction is .

See Also