BitmapDataExtensionsClone(IReadableBitmapData, IAsyncContext, NullableRectangle) Method

Gets the clone of the specified portion of source inside of an already created, possibly asynchronous context.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 7.0.0
C#
public static IReadWriteBitmapData? Clone(
	this IReadableBitmapData source,
	IAsyncContext? context,
	Rectangle? sourceRectangle = null
)

Parameters

source  IReadableBitmapData
An IReadableBitmapData instance to be cloned.
context  IAsyncContext
An IAsyncContext instance that contains information for asynchronous processing about the current operation.
sourceRectangle  NullableRectangle  (Optional)
A Rectangle that specifies the portion of the source to be cloned.

Return Value

IReadWriteBitmapData
An IReadWriteBitmapData instance that represents the clone of the specified source, or , if the operation was canceled.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadableBitmapData. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

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.

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

  Tip

See the Examples section of the AsyncHelper class for details about how to create a context for possibly async top level methods.

Exceptions

ArgumentNullExceptionsource is .
ArgumentOutOfRangeExceptionsourceRectangle has no overlapping region with source bounds.

See Also