ReadableBitmapDataExtensionsToWriteableBitmapAsync(IReadableBitmapData, TaskConfig) Method

Converts the specified source to a WriteableBitmap asynchronously.

Definition

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

C#

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

VB

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

C++

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

F#

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

Parameters

source IReadableBitmapData: The source IReadableBitmapData instance to convert.
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

TaskWriteableBitmap
A task that represents the asynchronous operation. Its result is a WriteableBitmap instance that has the same content as the specified source, or , if the operation was canceled and the ThrowIfCanceledproperty 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 ToWriteableBitmap method for more details.

Exceptions

ArgumentNullException

source is .