BitmapDataExtensionsGetColorsAsync Method

Gets the colors used in the specified bitmapData asynchronously. A limit can be defined in maxColors.

Definition

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

C#

public static Task<ICollection<Color32>> GetColorsAsync(
	this IReadableBitmapData bitmapData,
	int maxColors = 0,
	bool forceScanningContent = false,
	TaskConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function GetColorsAsync ( 
	bitmapData As IReadableBitmapData,
	Optional maxColors As Integer = 0,
	Optional forceScanningContent As Boolean = false,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of ICollection(Of Color32))

C++

public:
[ExtensionAttribute]
static Task<ICollection<Color32>^>^ GetColorsAsync(
	IReadableBitmapData^ bitmapData, 
	int maxColors = 0, 
	bool forceScanningContent = false, 
	TaskConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member GetColorsAsync : 
        bitmapData : IReadableBitmapData * 
        ?maxColors : int * 
        ?forceScanningContent : bool * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _maxColors = defaultArg maxColors 0
        let _forceScanningContent = defaultArg forceScanningContent false
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<ICollection<Color32>>

Parameters

bitmapData IReadableBitmapData: The IReadableBitmapData, whose colors have to be returned. If it is indexed and the forceScanningContent parameter is , then its palette entries are returned and maxColors is ignored.
maxColors Int32 (Optional): A limit of the returned colors. If forceScanningContent parameter is , then this parameter is ignored for indexed bitmaps. Use 0 for no limit. This parameter is optional.
Default value: 0.
forceScanningContent Boolean (Optional): to force scanning the actual image content even if the specified bitmapData is indexed and has a palette. This parameter is optional.
Default value: .
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

TaskICollectionColor32
A task that represents the asynchronous operation. Its result is an ICollectionT of Color32 entries. If the operation was canceled and the ThrowIfCanceled property of the asyncConfig parameter was , then the result of the task is an empty collection.

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