BitmapDataExtensionsDither(IReadWriteBitmapData, IQuantizer, IDitherer, ParallelConfig) 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: 10.0.0-rc.1
C#
public static bool Dither(
	this IReadWriteBitmapData bitmapData,
	IQuantizer quantizer,
	IDitherer ditherer,
	ParallelConfig? parallelConfig
)

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.
parallelConfig  ParallelConfig
The configuration of the operation such as parallelization, cancellation, reporting progress, etc. When Progress is set in this parameter, then this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface. If , then the degree of parallelization is configured automatically.

Return Value

Boolean
, if the operation completed successfully.
, if the operation has been canceled and the ThrowIfCanceled property of the parallelConfig parameter was .

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 blocks the caller as it executes synchronously, though the parallelConfig parameter allows configuring the degree of parallelism, cancellation and progress reporting. 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

Exceptions

ArgumentNullExceptionbitmapData, quantizer or ditherer is .
InvalidOperationExceptionThe IQuantizer.Initialize method or the IDitherer.Initialize method returned .

See Also