BitmapDataExtensionsClone(IReadableBitmapData, Rectangle, KnownPixelFormat, IQuantizer, IDitherer) Method

Gets the clone of the specified portion of source with the specified pixelFormat, using an optional quantizer and ditherer.


Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.1.0
public static IReadWriteBitmapData Clone(
	this IReadableBitmapData source,
	Rectangle sourceRectangle,
	KnownPixelFormat pixelFormat,
	IQuantizer? quantizer,
	IDitherer? ditherer = null


source  IReadableBitmapData
An IReadableBitmapData instance to be cloned.
sourceRectangle  Rectangle
A Rectangle that specifies the portion of the source 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: .

Return Value

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).



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, even if there is no quantizer specified. To use dithering a ditherer must be explicitly specified though.

If quantizer is specified but it uses more/different colors than pixelFormat can represent, then the result will eventually be quantized to pixelFormat, though the result may have a poorer quality than expected.

Color depth can be preserved if quantizer is not specigied and the target format can represent the colors of the source format without losing information.


ArgumentNullExceptionsource is .
ArgumentOutOfRangeExceptionpixelFormat does not specify a valid format.
sourceRectangle has no overlapping region with source bounds.
ArgumentExceptionquantizer uses a palette with too many colors for the specified pixelFormat.

See Also