BitmapDataExtensionsToGrayscaleAsync Method

Returns a new IReadWriteBitmapData asynchronously, which is the grayscale version of the specified bitmapData.

Definition

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

C#

public static Task<IReadWriteBitmapData?> ToGrayscaleAsync(
	this IReadWriteBitmapData bitmapData,
	TaskConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function ToGrayscaleAsync ( 
	bitmapData As IReadWriteBitmapData,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of IReadWriteBitmapData)

C++

public:
[ExtensionAttribute]
static Task<IReadWriteBitmapData^>^ ToGrayscaleAsync(
	IReadWriteBitmapData^ bitmapData, 
	TaskConfig^ asyncConfig = nullptr
)

F#

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

Parameters

bitmapData IReadWriteBitmapData: The IReadableBitmapData to convert to grayscale.
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

TaskIReadWriteBitmapData
A task that represents the asynchronous operation. Its result is an IReadWriteBitmapData containing the grayscale version of the original bitmapData, or , if the operation was canceled and the ThrowIfCanceled property 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 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 ToGrayscale method for more details.