BitmapDataExtensionsClone(IReadableBitmapData, KnownPixelFormat, Color32, Byte, ParallelConfig) Method

public static IReadWriteBitmapData? Clone(
	this IReadableBitmapData source,
	KnownPixelFormat pixelFormat,
	Color32 backColor,
	byte alphaThreshold,
	ParallelConfig? parallelConfig
)

<ExtensionAttribute>
Public Shared Function Clone ( 
	source As IReadableBitmapData,
	pixelFormat As KnownPixelFormat,
	backColor As Color32,
	alphaThreshold As Byte,
	parallelConfig As ParallelConfig
) As IReadWriteBitmapData

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

[<ExtensionAttribute>]
static member Clone : 
        source : IReadableBitmapData * 
        pixelFormat : KnownPixelFormat * 
        backColor : Color32 * 
        alphaThreshold : byte * 
        parallelConfig : ParallelConfig -> IReadWriteBitmapData 

Parameters

source  IReadableBitmapData

An IReadableBitmapData instance to be cloned.

pixelFormat  KnownPixelFormat

The desired pixel format of the result.

backColor  Color32

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.

alphaThreshold  Byte

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.

parallelConfig  ParallelConfig

The configuration of the operation such as parallelization, cancellation, reporting progress, etc. When Progress is set in this parameter, then this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface. If , then the degree of parallelization is configured automatically.

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, ParallelConfig) overload.

Reference