BitmapDataExtensionsReplaceColor(IReadWriteBitmapData, Color32, Color32, IDitherer, ParallelConfig) Method

Replaces every oldColor occurrences to newColor in the specified bitmapData.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.1

C#

public static bool ReplaceColor(
	this IReadWriteBitmapData bitmapData,
	Color32 oldColor,
	Color32 newColor,
	IDitherer? ditherer,
	ParallelConfig? parallelConfig
)

VB

<ExtensionAttribute>
Public Shared Function ReplaceColor ( 
	bitmapData As IReadWriteBitmapData,
	oldColor As Color32,
	newColor As Color32,
	ditherer As IDitherer,
	parallelConfig As ParallelConfig
) As Boolean

C++

public:
[ExtensionAttribute]
static bool ReplaceColor(
	IReadWriteBitmapData^ bitmapData, 
	Color32 oldColor, 
	Color32 newColor, 
	IDitherer^ ditherer, 
	ParallelConfig^ parallelConfig
)

F#

[<ExtensionAttribute>]
static member ReplaceColor : 
        bitmapData : IReadWriteBitmapData * 
        oldColor : Color32 * 
        newColor : Color32 * 
        ditherer : IDitherer * 
        parallelConfig : ParallelConfig -> bool

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: An optional IDitherer instance to dither the result if newColor is not compatible with the PixelFormat of the specified bitmapData.
parallelConfig ParallelConfig: The configuration of the 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. If , then the degree of parallelization is configured automatically.

Return Value

Boolean
, if the operation completed successfully.
, if the operation has been canceled and the ThrowIfCanceled property of the parallelConfig parameter was .

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

Note

This method blocks the caller as it executes synchronously, though the parallelConfig parameter allows configuring the degree of parallelism, cancellation and progress reporting. Use the BeginReplaceColor or ReplaceColorAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

If newColor has alpha, which cannot be represented by bitmapData, then it will be blended with BackColor.

If bitmapData has an indexed PixelFormat and ditherer is , then its palette entries are tried to be transformed instead of the actual pixels in the first place (if it is supported by bitmapData). To transform the colors of an indexed IBitmapData without changing the palette specify a non- ditherer. Transforming the palette is both faster and provides a better result.

If ditherer is , this method attempts to preserve the original color depth, including wide pixel formats. Otherwise, this method may quantize the colors to the 32-bit color space, even if no occurrence of oldColor is found. To replace colors that cannot be represented by a Color32 struct, use the TransformColors(IReadWriteBitmapData, FuncColor64, Color64, ParallelConfig) or TransformColors(IReadWriteBitmapData, FuncColorF, ColorF, ParallelConfig) methods instead.

The ditherer may have no effect for KnownPixelFormats with more than 16 bits-per-pixel and for grayscale formats.