BitmapDataExtensionsClone(IReadableBitmapData, KnownPixelFormat, Color32, Byte) Method

public static IReadWriteBitmapData Clone(
	this IReadableBitmapData source,
	KnownPixelFormat pixelFormat,
	Color32 backColor = default,
	byte alphaThreshold = 128
)

<ExtensionAttribute>
Public Shared Function Clone ( 
	source As IReadableBitmapData,
	pixelFormat As KnownPixelFormat,
	Optional backColor As Color32 = Nothing,
	Optional alphaThreshold As Byte = 128
) As IReadWriteBitmapData

public:
[ExtensionAttribute]
static IReadWriteBitmapData^ Clone(
	IReadableBitmapData^ source, 
	KnownPixelFormat pixelFormat, 
	Color32 backColor = Color32(), 
	unsigned char alphaThreshold = 128
)

[<ExtensionAttribute>]
static member Clone : 
        source : IReadableBitmapData * 
        pixelFormat : KnownPixelFormat * 
        ?backColor : Color32 * 
        ?alphaThreshold : byte 
(* Defaults:
        let _backColor = defaultArg backColor new Color32()
        let _alphaThreshold = defaultArg alphaThreshold 128
*)
-> IReadWriteBitmapData 

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

Usage Note

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 can be preserved if the target format can represent the colors of the source format without losing information.

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.

Reference