BitmapDataExtensionsBeginDither Method

Begins to quantize an IReadWriteBitmapData with dithering asynchronously (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.0.0-preview.1

C#

public static IAsyncResult BeginDither(
	this IReadWriteBitmapData bitmapData,
	IQuantizer quantizer,
	IDitherer ditherer,
	AsyncConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function BeginDither ( 
	bitmapData As IReadWriteBitmapData,
	quantizer As IQuantizer,
	ditherer As IDitherer,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

C++

public:
[ExtensionAttribute]
static IAsyncResult^ BeginDither(
	IReadWriteBitmapData^ bitmapData, 
	IQuantizer^ quantizer, 
	IDitherer^ ditherer, 
	AsyncConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member BeginDither : 
        bitmapData : IReadWriteBitmapData * 
        quantizer : IQuantizer * 
        ditherer : IDitherer * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult

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.
asyncConfig AsyncConfig (Optional): The configuration of the asynchronous 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. This parameter is optional.
Default value: .

Return Value

IAsyncResult
An IAsyncResult that represents the asynchronous operation, which could still be pending.

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

In .NET Framework 4.0 and above you can use also the DitherAsync method.

To finish the operation and to get the exception that occurred during the operation you have to call the EndQuantize method.

This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.

Tip

See the Remarks section of the Dither method for more details.

Exceptions

ArgumentNullException

bitmapData, quantizer or ditherer is .