BitmapDataExtensionsClone(IReadableBitmapData, IAsyncContext, KnownPixelFormat, WorkingColorSpace, Color32, Byte, NullableRectangle) Method

public static IReadWriteBitmapData? Clone(
	this IReadableBitmapData source,
	IAsyncContext? context,
	KnownPixelFormat pixelFormat,
	WorkingColorSpace workingColorSpace,
	Color32 backColor = default,
	byte alphaThreshold = 128,
	Rectangle? sourceRectangle = null
)

<ExtensionAttribute>
Public Shared Function Clone ( 
	source As IReadableBitmapData,
	context As IAsyncContext,
	pixelFormat As KnownPixelFormat,
	workingColorSpace As WorkingColorSpace,
	Optional backColor As Color32 = Nothing,
	Optional alphaThreshold As Byte = 128,
	Optional sourceRectangle As Rectangle? = Nothing
) As IReadWriteBitmapData

public:
[ExtensionAttribute]
static IReadWriteBitmapData^ Clone(
	IReadableBitmapData^ source, 
	IAsyncContext^ context, 
	KnownPixelFormat pixelFormat, 
	WorkingColorSpace workingColorSpace, 
	Color32 backColor = Color32(), 
	unsigned char alphaThreshold = 128, 
	Nullable<Rectangle> sourceRectangle = nullptr
)

[<ExtensionAttribute>]
static member Clone : 
        source : IReadableBitmapData * 
        context : IAsyncContext * 
        pixelFormat : KnownPixelFormat * 
        workingColorSpace : WorkingColorSpace * 
        ?backColor : Color32 * 
        ?alphaThreshold : byte * 
        ?sourceRectangle : Nullable<Rectangle> 
(* Defaults:
        let _backColor = defaultArg backColor new Color32()
        let _alphaThreshold = defaultArg alphaThreshold 128
        let _sourceRectangle = defaultArg sourceRectangle null
*)
-> IReadWriteBitmapData 

Parameters

source  IReadableBitmapData

An IReadableBitmapData instance to be cloned.

context  IAsyncContext

An IAsyncContext instance that contains information for asynchronous processing about the current operation. If , then the degree of parallelization is configured automatically.

pixelFormat  KnownPixelFormat

The desired pixel format of the result.

workingColorSpace  WorkingColorSpace

Specifies the value of the WorkingColorSpace property of the cloned instance and affects the possible blending operations during the cloning.

backColor  Color32  (Optional)

If pixelFormat does not support alpha or supports only single-bit alpha, then specifies the color of the background. Source pixels with alpha, which will be opaque in the result will be blended with this color. The Color32.A property of the background color is ignored. This parameter is optional.
Default value: The default value of the Color32 type, which has the same RGB values as Black.

alphaThreshold  Byte  (Optional)

If pixelFormat can represent only single-bit alpha or pixelFormat is an indexed format and the target palette contains a transparent color, then specifies a threshold value for the Color32.A property, under which the color is considered transparent. If 0, then the result will not have transparent pixels. This parameter is optional.
Default value: 128.

sourceRectangle  NullableRectangle  (Optional)

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

Return Value

Usage Note

This method blocks the caller thread but if context belongs to an async top level method, then the execution may already run on a pool thread. Degree of parallelism, the ability of cancellation and reporting progress depend on how these were configured at the top level method. To reconfigure the degree of parallelism of an existing context, you can use the AsyncContextWrapper class.

Alternatively, you can use this method to specify the degree of parallelism for synchronous execution. For example, by passing AsyncHelper.SingleThreadContext to the context parameter the method will be forced to use a single thread only.

When reporting progress, this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface.

Reference