BitmapDataExtensionsReplaceColor(IReadWriteBitmapData, Color32, Color32, IDitherer) Method
Replaces every oldColor occurrences to newColor in the specified bitmapData.
Namespace: KGySoft.Drawing.ImagingAssembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
public static void ReplaceColor(
this IReadWriteBitmapData bitmapData,
Color32 oldColor,
Color32 newColor,
IDitherer? ditherer = null
)
<ExtensionAttribute>
Public Shared Sub ReplaceColor (
bitmapData As IReadWriteBitmapData,
oldColor As Color32,
newColor As Color32,
Optional ditherer As IDitherer = Nothing
)
public:
[ExtensionAttribute]
static void ReplaceColor(
IReadWriteBitmapData^ bitmapData,
Color32 oldColor,
Color32 newColor,
IDitherer^ ditherer = nullptr
)
[<ExtensionAttribute>]
static member ReplaceColor :
bitmapData : IReadWriteBitmapData *
oldColor : Color32 *
newColor : Color32 *
?ditherer : IDitherer
(* Defaults:
let _ditherer = defaultArg ditherer null
*)
-> unit
- 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: .
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).
This method adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. You can use
the
ReplaceColor(IReadWriteBitmapData, Color32, Color32, IDitherer, ParallelConfig) overload to configure these, while still executing the method synchronously.
Alternatively, 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.
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.
