BitmapDataExtensionsDither(IReadWriteBitmapData, IQuantizer, IDitherer) Method

Quantizes an IReadWriteBitmapData with dithering (reduces the number of colors while trying to preserve details) using the specified quantizer and ditherer.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.2.0

C#

public static void Dither(
	this IReadWriteBitmapData bitmapData,
	IQuantizer quantizer,
	IDitherer ditherer
)

VB

<ExtensionAttribute>
Public Shared Sub Dither ( 
	bitmapData As IReadWriteBitmapData,
	quantizer As IQuantizer,
	ditherer As IDitherer
)

C++

public:
[ExtensionAttribute]
static void Dither(
	IReadWriteBitmapData^ bitmapData, 
	IQuantizer^ quantizer, 
	IDitherer^ ditherer
)

F#

[<ExtensionAttribute>]
static member Dither : 
        bitmapData : IReadWriteBitmapData * 
        quantizer : IQuantizer * 
        ditherer : IDitherer -> unit

Parameters

bitmapData IReadWriteBitmapData: An IReadWriteBitmapData instance to be quantized.
quantizer IQuantizer: An IQuantizer implementation to be used for quantizing the specified bitmapData.
ditherer IDitherer: An IDitherer implementation to be used for dithering during the quantization 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. You can use the Dither(IReadWriteBitmapData, IQuantizer, IDitherer, ParallelConfig) overload to configure these, while still executing the method synchronously. Alternatively, use the BeginDither or DitherAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

This method quantizes bitmapData with dithering 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 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.
For some built-in dithering solutions see the OrderedDitherer, ErrorDiffusionDitherer, RandomNoiseDitherer and InterleavedGradientNoiseDitherer classes. All of them have several examples in their Remarks section.

Exceptions

ArgumentNullException	bitmapData, quantizer or ditherer is .
InvalidOperationException	The IQuantizer.Initialize method or the IDitherer.Initialize method returned .