BitmapDataExtensionsQuantize(IReadWriteBitmapData, IQuantizer) Method

Quantizes an IReadWriteBitmapData using the specified quantizer (reduces the number of colors).

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 7.0.0-preview.3
C#
public static void Quantize(
	this IReadWriteBitmapData bitmapData,
	IQuantizer quantizer
)

Parameters

bitmapData  IReadWriteBitmapData
An IReadWriteBitmapData instance to be quantized.
quantizer  IQuantizer
An IQuantizer implementation to be used for quantizing 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 BeginQuantize or QuantizeAsync (in .NET Framework 4.0 and above) methods for asynchronous call and to adjust parallelization, set up cancellation and for reporting progress.

This method quantizes the specified bitmapData in place (its original content will be overwritten). To return a new instance use the Clone extension method instead.

If the KnownPixelFormat or the palette of bitmapData is not compatible with the colors of the specified quantizer, then the result may not be correct.

If bitmapData has already the same set of colors that the specified quantizer, then it can happen that calling this method does not change the bitmapData at all.

  Tip

  • To use predefined colors or custom quantization functions use the static methods of the PredefinedColorsQuantizer class.
    See the Remarks section of its members for details and examples.
  • To use an optimized palette of a specified number of colors adjusted for bitmapData see the OptimizedPaletteQuantizer class.

Exceptions

ArgumentNullExceptionbitmapData or quantizer is .
InvalidOperationExceptionThe quantizer's Initialize method returned .

See Also