BitmapDataExtensionsBeginToGrayscale Method

Begins to convert the specified bitmapData to grayscale asynchronously.

Definition

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

C#

public static IAsyncResult BeginToGrayscale(
	this IReadableBitmapData bitmapData,
	AsyncConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function BeginToGrayscale ( 
	bitmapData As IReadableBitmapData,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

C++

public:
[ExtensionAttribute]
static IAsyncResult^ BeginToGrayscale(
	IReadableBitmapData^ bitmapData, 
	AsyncConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member BeginToGrayscale : 
        bitmapData : IReadableBitmapData * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult

Parameters

bitmapData IReadableBitmapData: The IReadableBitmapData to convert to grayscale.
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
A task that represents the asynchronous operation. Its result is an IReadWriteBitmapData containing the grayscale version of the original bitmapData.

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

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

To get the result or the exception that occurred during the operation you have to call the EndToGrayscale 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 ToGrayscale method for more details.