BitmapDataExtensionsBeginReplaceColor Method

Begins to replace every oldColor occurrences to newColor in the specified bitmapData asynchronously.


Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.0.0-preview.1
public static IAsyncResult BeginReplaceColor(
	this IReadWriteBitmapData bitmapData,
	Color32 oldColor,
	Color32 newColor,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null


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

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


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.


See the Remarks section of the ReplaceColor method for more details.

See Also