BitmapDataExtensionsClone(IReadableBitmapData, IAsyncContext, KnownPixelFormat, Palette, NullableRectangle) Method

Gets the clone of the specified portion of source with the specified pixelFormat and palette 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,
	KnownPixelFormat pixelFormat,
	Palette? palette,
	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.
pixelFormat  KnownPixelFormat
The desired pixel format of the result.
palette  Palette
If pixelFormat is an indexed format, then specifies the desired Palette of the returned IReadWriteBitmapData instance. It determines also the BackColor and AlphaThreshold properties of the result. If , then the target palette is taken from source if it also has a palette of no more entries than the target indexed format can have; otherwise, a default palette will be used based on pixelFormat.
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

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 .
ArgumentOutOfRangeExceptionpixelFormat does not specify a valid format.
-or-
sourceRectangle has no overlapping region with source bounds.
ArgumentExceptionpalette contains too many colors for the specified pixelFormat.

See Also