BitmapDataExtensionsClone(IReadableBitmapData, KnownPixelFormat, IDitherer) Method

Gets the clone of the specified source with identical size and the specified pixelFormat, using an optional ditherer.

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,
	KnownPixelFormat pixelFormat,
	IDitherer? ditherer
)

Parameters

source  IReadableBitmapData
An IReadableBitmapData instance to be cloned.
pixelFormat  KnownPixelFormat
The desired pixel format of the result.
ditherer  IDitherer
The ditherer to be used. Might be ignored if pixelFormat represents an at least 24 bits-per-pixel size.

Return Value

IReadWriteBitmapData
An IReadWriteBitmapData instance that represents the clone of the specified source.

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

  Note

This method adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. Use the BeginClone(IReadableBitmapData, KnownPixelFormat, IQuantizer, IDitherer, NullableRectangle, AsyncConfig) or CloneAsync(IReadableBitmapData, KnownPixelFormat, IQuantizer, IDitherer, NullableRectangle, TaskConfig) (in .NET Framework 4.0 and above) methods for asynchronous call and to adjust parallelization, set up cancellation and for reporting progress.

If pixelFormat can represent a narrower set of colors, then the result will be automatically quantized to its color space. To use dithering a ditherer must be explicitly specified.

Color depth of wide-color formats (Format16bppGrayScale, Format48bppRgb, Format64bppArgb, Format64bppPArgb) can be preserved only between the same pixel formats. If pixel formats are different, then colors might be quantized to 32bpp ones during the operation.

Exceptions

ArgumentNullExceptionsource is .
ArgumentOutOfRangeExceptionpixelFormat does not specify a valid format.

See Also