BitmapDataExtensionsBeginToTransparent(IReadableBitmapData, AsyncConfig) Method

Begins to convert the specified bitmapData to another one with transparent background asynchronously.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.0.0-preview.1

C#

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

VB

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

C++

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

F#

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

Parameters

bitmapData IReadableBitmapData: The IReadableBitmapData to convert to transparent.
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 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 ToTransparentAsync(IReadableBitmapData, TaskConfig) method.

To get the result or the exception that occurred during the operation you have to call the EndToTransparent 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 ToTransparent(IReadableBitmapData) method for more details.