BitmapDataExtensionsToTransparentAsync(IReadableBitmapData, TaskConfig) Method

Returns a new IReadWriteBitmapData asynchronously, which is the clone of the specified bitmapData with transparent background.

Definition

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

C#

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

VB

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

C++

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

F#

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

Parameters

bitmapData IReadableBitmapData: The IReadableBitmapData to convert to transparent.
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, which is the clone of the specified bitmapData with transparent background, 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 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

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.