BitmapDataExtensionsClone(IReadableBitmapData, KnownPixelFormat, Color32, Byte) Method

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

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,
	Color32 backColor = default,
	byte alphaThreshold = 128
)

Parameters

source  IReadableBitmapData
An IReadableBitmapData instance to be cloned.
pixelFormat  KnownPixelFormat
The desired pixel format of the result.
backColor  Color32  (Optional)
If pixelFormat does not support alpha or supports only single-bit alpha, then specifies the color of the background. Source pixels with alpha, which will be opaque in the result will be blended with this color. The Color32.A property of the background color is ignored. This parameter is optional.
Default value: The default value of the Color32 type, which has the same RGB values as Black.
alphaThreshold  Byte  (Optional)
If pixelFormat can represent only single-bit alpha or pixelFormat is an indexed format and the target palette contains a transparent color, then specifies a threshold value for the Color32.A property, under which the color is considered transparent. If 0, then the result will not have transparent pixels. This parameter is optional.
Default value: 128.

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.

If pixelFormat represents an indexed format, 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. To specify the desired palette of the result use the Clone(IReadableBitmapData, KnownPixelFormat, Palette) overload.

Exceptions

ArgumentNullExceptionsource is .
ArgumentOutOfRangeExceptionpixelFormat does not specify a valid format.

See Also