BitmapDataExtensionsGetColorCountAsync Method

Gets the actual number of colors of the specified bitmapData asynchronously. Colors are counted even for indexed bitmaps.

Definition

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

C#

public static Task<int> GetColorCountAsync(
	this IReadableBitmapData bitmapData,
	TaskConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function GetColorCountAsync ( 
	bitmapData As IReadableBitmapData,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Integer)

C++

public:
[ExtensionAttribute]
static Task<int>^ GetColorCountAsync(
	IReadableBitmapData^ bitmapData, 
	TaskConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member GetColorCountAsync : 
        bitmapData : IReadableBitmapData * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<int>

Parameters

bitmapData IReadableBitmapData: The bitmap, whose colors have to be counted to count its colors.
asyncConfig TaskConfig (Optional): The configuration of the asynchronous operation such as 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

TaskInt32
A task that represents the asynchronous operation. Its result is the actual number of colors of the specified bitmapData, or 0, if the operation was canceled and the ThrowIfCanceledproperty of the asyncConfig parameter was .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadableBitmapData. 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, though the operation is not parallelized and the MaxDegreeOfParallelism property of the asyncConfig parameter is ignored.

Tip

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