BitmapSourceExtensionsBeginConvertPixelFormat(BitmapSource, PixelFormat, Color, Byte, AsyncConfig) Method

public static IAsyncResult BeginConvertPixelFormat(
	this BitmapSource bitmap,
	PixelFormat newPixelFormat,
	Color backColor = default,
	byte alphaThreshold = 128,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginConvertPixelFormat ( 
	bitmap As BitmapSource,
	newPixelFormat As PixelFormat,
	Optional backColor As Color = Nothing,
	Optional alphaThreshold As Byte = 128,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginConvertPixelFormat(
	BitmapSource^ bitmap, 
	PixelFormat newPixelFormat, 
	Color backColor = Color(), 
	unsigned char alphaThreshold = 128, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginConvertPixelFormat : 
        bitmap : BitmapSource * 
        newPixelFormat : PixelFormat * 
        ?backColor : Color * 
        ?alphaThreshold : byte * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _backColor = defaultArg backColor new Color()
        let _alphaThreshold = defaultArg alphaThreshold 128
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

bitmap  BitmapSource

The original image to convert.

newPixelFormat  PixelFormat

The desired new pixel format.

backColor  Color  (Optional)

If newPixelFormat 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 Color.A property of the background color is ignored. This parameter is optional.
Default value: The bitwise zero instance of Color, which has the same RGB values as Black.

alphaThreshold  Byte  (Optional)

If newPixelFormat is an indexed format and the target palette contains a transparent color, then specifies a threshold value for the Color.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.

asyncConfig  AsyncConfig  (Optional)

The configuration of the asynchronous 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. This parameter is optional.
Default value: .

Return Value

Usage Note

In .NET Framework 4.0 and above you can use also the ConvertPixelFormatAsync(BitmapSource, PixelFormat, Color, Byte, TaskConfig) method.

To get the result or the exception that occurred during the operation you have to call the EndConvertPixelFormat method.

This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.

Reference