BitmapExtensionsReplaceColor Method

Replaces every oldColor occurrences to newColor in the specified bitmap.

Definition

Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 10.0.0-rc.1

C#

public static void ReplaceColor(
	this Bitmap bitmap,
	Color oldColor,
	Color newColor,
	IDitherer? ditherer = null
)

VB

<ExtensionAttribute>
Public Shared Sub ReplaceColor ( 
	bitmap As Bitmap,
	oldColor As Color,
	newColor As Color,
	Optional ditherer As IDitherer = Nothing
)

C++

public:
[ExtensionAttribute]
static void ReplaceColor(
	Bitmap^ bitmap, 
	Color oldColor, 
	Color newColor, 
	IDitherer^ ditherer = nullptr
)

F#

[<ExtensionAttribute>]
static member ReplaceColor : 
        bitmap : Bitmap * 
        oldColor : Color * 
        newColor : Color * 
        ?ditherer : IDitherer 
(* Defaults:
        let _ditherer = defaultArg ditherer null
*)
-> unit

Parameters

bitmap Bitmap: The Bitmap to be transformed.
oldColor Color: The original color to be replaced.
newColor Color: 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 bitmap. 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 Bitmap. 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 BitmapDataExtensions.BeginReplaceColor or BitmapDataExtensions.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 bitmap, then it will be blended with black. Call TransformColors to use a custom background color instead.

If bitmap has an indexed PixelFormat and ditherer is , then its palette entries will be transformed instead of the actual pixels. To transform the colors of an indexed Bitmap without changing the palette specify a non- ditherer. Transforming the palette is both faster and provides a better result.

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

BitmapExtensionsReplaceColor Method

Definition

Parameters

Usage Note

Remarks

See Also

Reference