BitmapDataExtensionsTransformColors(IReadWriteBitmapData, FuncColor32, Color32, IDitherer) Method

Transforms the colors of this bitmapData using the specified transformFunction delegate.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 7.0.0
C#
public static void TransformColors(
	this IReadWriteBitmapData bitmapData,
	Func<Color32, Color32> transformFunction,
	IDitherer? ditherer
)

Parameters

bitmapData  IReadWriteBitmapData
The IReadWriteBitmapData to be transformed.
transformFunction  FuncColor32, Color32
The transform function to be used on the colors of the specified bitmapData. It must be thread-safe.
ditherer  IDitherer
An optional IDitherer instance to dither the result of the transformation if transformFunction returns colors that is not compatible with the PixelFormat of the specified bitmapData.

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 BeginTransformColors or TransformColorsAsync (in .NET Framework 4.0 and above) methods for asynchronous call and to adjust parallelization, set up cancellation and for reporting progress.

This method transforms the bitmapData in place (its original content will be overwritten). To return a new instance use the Clone extension method with an IQuantizer instance created by the PredefinedColorsQuantizer.FromCustomFunction method.

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.

On multi-core systems transformFunction might be called concurrently so it must be thread-safe.

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

Exceptions

ArgumentNullExceptionbitmapData or transformFunction is .

See Also