BitmapDataExtensionsBeginInvert Method

Begins to Invert the colors of the specified bitmapData 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 BeginInvert(
	this IReadWriteBitmapData bitmapData,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null
)

VB

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

C++

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

F#

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

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData to be inverted.
ditherer IDitherer (Optional): An optional IDitherer instance to dither the result of the transformation if the inverse of the bitmapData has no exact representation with its PixelFormat. 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 InvertAsync method.

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