BitmapDataExtensionsCopyToAsync Method

public static Task<bool> CopyToAsync(
	this IReadableBitmapData source,
	IWritableBitmapData target,
	Rectangle? sourceRectangle = null,
	Point? targetLocation = null,
	IQuantizer? quantizer = null,
	IDitherer? ditherer = null,
	TaskConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function CopyToAsync ( 
	source As IReadableBitmapData,
	target As IWritableBitmapData,
	Optional sourceRectangle As Rectangle? = Nothing,
	Optional targetLocation As Point? = Nothing,
	Optional quantizer As IQuantizer = Nothing,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

public:
[ExtensionAttribute]
static Task<bool>^ CopyToAsync(
	IReadableBitmapData^ source, 
	IWritableBitmapData^ target, 
	Nullable<Rectangle> sourceRectangle = nullptr, 
	Nullable<Point> targetLocation = nullptr, 
	IQuantizer^ quantizer = nullptr, 
	IDitherer^ ditherer = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member CopyToAsync : 
        source : IReadableBitmapData * 
        target : IWritableBitmapData * 
        ?sourceRectangle : Nullable<Rectangle> * 
        ?targetLocation : Nullable<Point> * 
        ?quantizer : IQuantizer * 
        ?ditherer : IDitherer * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _sourceRectangle = defaultArg sourceRectangle null
        let _targetLocation = defaultArg targetLocation null
        let _quantizer = defaultArg quantizer null
        let _ditherer = defaultArg ditherer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<bool> 

Parameters

source  IReadableBitmapData

The source IReadableBitmapData to be copied into the target.

target  IWritableBitmapData

The target IWritableBitmapData into which source should be copied.

sourceRectangle  NullableRectangle  (Optional)

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

targetLocation  NullablePoint  (Optional)

A Point that specifies the target location, or to copy the source to the top-left corner of the target. Target size will be always the same as the source size. This parameter is optional.
Default value: .

quantizer  IQuantizer  (Optional)

An IQuantizer instance to be used. If not specified, then the copying operation might automatically pick a quantizer based on target PixelFormat. This parameter is optional.
Default value: .

ditherer  IDitherer  (Optional)

The ditherer to be used. Might be ignored if quantizer is not specified and target PixelFormat format has at least 24 bits-per-pixel size. 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