BitmapDataExtensionsClone(IReadableBitmapData, KnownPixelFormat, Palette) Method

Gets the clone of the specified source with identical size and the specified pixelFormat and palette.

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,
	Palette? palette
)

Parameters

source  IReadableBitmapData
An IReadableBitmapData instance to be cloned.
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.

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

This overload automatically quantizes colors if pixelFormat represents a narrower set of colors than source PixelFormat. To use a custom quantizer use the overloads with an IQuantizer parameter.

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

Exceptions

ArgumentNullExceptionsource is .
ArgumentOutOfRangeExceptionpixelFormat does not specify a valid format.
ArgumentExceptionpalette contains too many colors for the specified pixelFormat.

See Also