BitmapDataExtensionsCloneAsync(IReadableBitmapData, TaskConfig) Method

Gets the clone of the specified source with identical size asynchronously.

Definition

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

C#

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

VB

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

C++

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

F#

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

Parameters

source IReadableBitmapData: An IReadableBitmapData instance to be cloned.
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 the new IReadWriteBitmapData instance that represents the clone of the specified source, 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

Alternatively, you can also use the BeginClone(IReadableBitmapData, AsyncConfig) method, which is available on every platform.

This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.

Exceptions

ArgumentNullException

source is .