BitmapDataExtensionsBeginClear Method

public static IAsyncResult BeginClear(
	this IWritableBitmapData bitmapData,
	Color32 color,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginClear ( 
	bitmapData As IWritableBitmapData,
	color As Color32,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginClear(
	IWritableBitmapData^ bitmapData, 
	Color32 color, 
	IDitherer^ ditherer = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginClear : 
        bitmapData : IWritableBitmapData * 
        color : Color32 * 
        ?ditherer : IDitherer * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _ditherer = defaultArg ditherer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

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

Usage Note

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.

Reference