BitmapDataExtensionsQuantizeAsync Method

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

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1

C#

public static Task<bool> QuantizeAsync(
	this IReadWriteBitmapData bitmapData,
	IQuantizer quantizer,
	TaskConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function QuantizeAsync ( 
	bitmapData As IReadWriteBitmapData,
	quantizer As IQuantizer,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

C++

public:
[ExtensionAttribute]
static Task<bool>^ QuantizeAsync(
	IReadWriteBitmapData^ bitmapData, 
	IQuantizer^ quantizer, 
	TaskConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member QuantizeAsync : 
        bitmapData : IReadWriteBitmapData * 
        quantizer : IQuantizer * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<bool>

Parameters

bitmapData IReadWriteBitmapData: An IReadWriteBitmapData instance to be quantized.
quantizer IQuantizer: An IQuantizer implementation to be used for quantizing the specified bitmapData.
asyncConfig TaskConfig (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

TaskBoolean
A task that represents the asynchronous operation. Its result is , if the operation completed successfully, or , if the operation has been canceled and the ThrowIfCanceled property in asyncConfig 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

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 Quantize method for more details.

Exceptions

ArgumentNullException	bitmapData or quantizer is .
InvalidOperationException	The quantizer's Initialize method returned .