BitmapExtensionsQuantize Method

Quantizes a bitmap using the specified quantizer (reduces the number of colors).

Definition

Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 8.1.0
C#
public static void Quantize(
	this Bitmap bitmap,
	IQuantizer quantizer
)

Parameters

bitmap  Bitmap
A Bitmap instance to be quantized.
quantizer  IQuantizer
An IQuantizer implementation to be used for quantizing the specified bitmap.

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.BeginQuantize or BitmapDataExtensions.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 bitmap in place (its original content will be overwritten). To return a new instance use the ConvertPixelFormat extension method instead.

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

If bitmap has already the same set of colors that the specified quantizer, then it can happen that calling this method does not change bitmap 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 bitmap see the OptimizedPaletteQuantizer class.

Exceptions

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

See Also