BitmapDataExtensionsBeginMakeGrayscale Method

Begins to make this bitmapData grayscale asynchronously.

Definition

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

C#

public static IAsyncResult BeginMakeGrayscale(
	this IReadWriteBitmapData bitmapData,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function BeginMakeGrayscale ( 
	bitmapData As IReadWriteBitmapData,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

C++

public:
[ExtensionAttribute]
static IAsyncResult^ BeginMakeGrayscale(
	IReadWriteBitmapData^ bitmapData, 
	IDitherer^ ditherer = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member BeginMakeGrayscale : 
        bitmapData : IReadWriteBitmapData * 
        ?ditherer : IDitherer * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _ditherer = defaultArg ditherer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData to make grayscale.
ditherer IDitherer (Optional): An optional IDitherer instance to dither the result if grayscale colors cannot be represented by the PixelFormat or the current palette of the specified bitmapData. This parameter is optional.
Default value: .
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
An IAsyncResult that represents the asynchronous operation, which could still be pending.

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

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

To finish the operation and to get the exception that occurred during the operation you have to call the EndMakeGrayscale 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 MakeGrayscale method for more details.