BitmapDataExtensionsBeginReplaceColor Method

public static IAsyncResult BeginReplaceColor(
	this IReadWriteBitmapData bitmapData,
	Color32 oldColor,
	Color32 newColor,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginReplaceColor ( 
	bitmapData As IReadWriteBitmapData,
	oldColor As Color32,
	newColor As Color32,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginReplaceColor(
	IReadWriteBitmapData^ bitmapData, 
	Color32 oldColor, 
	Color32 newColor, 
	IDitherer^ ditherer = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginReplaceColor : 
        bitmapData : IReadWriteBitmapData * 
        oldColor : Color32 * 
        newColor : 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.

oldColor  Color32

The original color to be replaced.

newColor  Color32

The new color to replace oldColor with.

ditherer  IDitherer  (Optional)

An optional IDitherer instance to dither the result if newColor 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 ReplaceColorAsync method.

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

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

Reference