BitmapDataExtensionsBeginClone(IReadableBitmapData, KnownPixelFormat, IQuantizer, IDitherer, NullableRectangle, AsyncConfig) Method

public static IAsyncResult BeginClone(
	this IReadableBitmapData source,
	KnownPixelFormat pixelFormat,
	IQuantizer? quantizer,
	IDitherer? ditherer = null,
	Rectangle? sourceRectangle = null,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginClone ( 
	source As IReadableBitmapData,
	pixelFormat As KnownPixelFormat,
	quantizer As IQuantizer,
	Optional ditherer As IDitherer = Nothing,
	Optional sourceRectangle As Rectangle? = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginClone(
	IReadableBitmapData^ source, 
	KnownPixelFormat pixelFormat, 
	IQuantizer^ quantizer, 
	IDitherer^ ditherer = nullptr, 
	Nullable<Rectangle> sourceRectangle = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginClone : 
        source : IReadableBitmapData * 
        pixelFormat : KnownPixelFormat * 
        quantizer : IQuantizer * 
        ?ditherer : IDitherer * 
        ?sourceRectangle : Nullable<Rectangle> * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _ditherer = defaultArg ditherer null
        let _sourceRectangle = defaultArg sourceRectangle null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

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  AsyncConfig  (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

In .NET Framework 4.0 and above you can use also the CloneAsync(IReadableBitmapData, KnownPixelFormat, Palette, NullableRectangle, TaskConfig) method.

To get the result or the exception that occurred during the operation you have to call the EndClone method.

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

Reference