BitmapDataExtensionsBeginClear Method

Begins to clear the content of the specified bitmapData and fills it with the specified color asynchronously.


Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.0.0
public static IAsyncResult BeginClear(
	this IWritableBitmapData bitmapData,
	Color32 color,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null


bitmapData  IWritableBitmapData
The IWritableBitmapData to be cleared.
color  Color32
A Color32 that represents the desired result color of the bitmapData. If it has transparency, which is not supported by PixelFormat of bitmapData, then the result might be either completely transparent (depends also on AlphaThreshold), or the color will be blended with BackColor.
ditherer  IDitherer  (Optional)
The ditherer to be used for the clearing. Has no effect if PixelFormat of bitmapData has at least 24 bits-per-pixel size. 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

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 IWritableBitmapData. 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).


In .NET Framework 4.0 and above you can use also the ClearAsync method.

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

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

See Also