BitmapDataExtensionsCloneAsync(IReadableBitmapData, KnownPixelFormat, Palette, NullableRectangle, TaskConfig) Method

public static Task<IReadWriteBitmapData?> CloneAsync(
	this IReadableBitmapData source,
	KnownPixelFormat pixelFormat,
	Palette? palette,
	Rectangle? sourceRectangle = null,
	TaskConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function CloneAsync ( 
	source As IReadableBitmapData,
	pixelFormat As KnownPixelFormat,
	palette As Palette,
	Optional sourceRectangle As Rectangle? = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of IReadWriteBitmapData)

public:
[ExtensionAttribute]
static Task<IReadWriteBitmapData^>^ CloneAsync(
	IReadableBitmapData^ source, 
	KnownPixelFormat pixelFormat, 
	Palette^ palette, 
	Nullable<Rectangle> sourceRectangle = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member CloneAsync : 
        source : IReadableBitmapData * 
        pixelFormat : KnownPixelFormat * 
        palette : Palette * 
        ?sourceRectangle : Nullable<Rectangle> * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _sourceRectangle = defaultArg sourceRectangle null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<IReadWriteBitmapData> 

Parameters

source  IReadableBitmapData

An IReadableBitmapData instance to be cloned.

pixelFormat  KnownPixelFormat

The desired pixel format of the result.

palette  Palette

If pixelFormat is an indexed format, then specifies the desired Palette of the returned IReadWriteBitmapData instance. It determines also the BackColor and AlphaThreshold properties of the result. If , then the target palette is taken from source if it also has a palette of no more entries than the target indexed format can have; otherwise, a default palette will be used based on pixelFormat.

sourceRectangle  NullableRectangle  (Optional)

A Rectangle that specifies the portion of the source to be cloned, or to clone the entire source. This parameter is optional.
Default value: .

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

Usage Note

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

Reference