BitmapDataExtensionsReplaceColor 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: 7.0.0
C#
public static void ReplaceColor(
	this IReadWriteBitmapData bitmapData,
	Color32 oldColor,
	Color32 newColor,
	IDitherer? ditherer = null
)

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

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 adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. Use the BeginReplaceColor or ReplaceColorAsync (in .NET Framework 4.0 and above) methods for asynchronous call and to adjust parallelization, set up cancellation and for reporting progress.

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

This method calls the TransformColors method internally. See the Remarks section of the TransformColors method for more details.

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.

The ditherer is ignored for KnownPixelFormats with more than 16 bits-per-pixel and for the Format16bppGrayScale format.

See Also