BitmapDataExtensionsCloneAsync(IReadableBitmapData, KnownPixelFormat, IQuantizer, IDitherer, NullableRectangle, TaskConfig) Method

public static Task<IReadWriteBitmapData?> CloneAsync(
	this IReadableBitmapData source,
	KnownPixelFormat pixelFormat,
	IQuantizer? quantizer,
	IDitherer? ditherer = null,
	Rectangle? sourceRectangle = null,
	TaskConfig? asyncConfig = null
)

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

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

[<ExtensionAttribute>]
static member CloneAsync : 
        source : IReadableBitmapData * 
        pixelFormat : KnownPixelFormat * 
        quantizer : IQuantizer * 
        ?ditherer : IDitherer * 
        ?sourceRectangle : Nullable<Rectangle> * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _ditherer = defaultArg ditherer null
        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.

quantizer  IQuantizer

An optional IQuantizer instance to determine the colors of the result. If and pixelFormat is an indexed format, then a default palette and quantization logic will be used.

ditherer  IDitherer  (Optional)

The ditherer to be used. Might be ignored if quantizer is not specified and pixelFormat represents an at least 24 bits-per-pixel size. This parameter is optional.
Default value: .

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