ImageExtensionsBeginConvertPixelFormat(Image, PixelFormat, IQuantizer, IDitherer, AsyncConfig) Method

public static IAsyncResult BeginConvertPixelFormat(
	this Image image,
	PixelFormat newPixelFormat,
	IQuantizer? quantizer,
	IDitherer? ditherer = null,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginConvertPixelFormat ( 
	image As Image,
	newPixelFormat As PixelFormat,
	quantizer As IQuantizer,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginConvertPixelFormat(
	Image^ image, 
	PixelFormat newPixelFormat, 
	IQuantizer^ quantizer, 
	IDitherer^ ditherer = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginConvertPixelFormat : 
        image : Image * 
        newPixelFormat : PixelFormat * 
        quantizer : IQuantizer * 
        ?ditherer : IDitherer * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _ditherer = defaultArg ditherer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

image  Image

The original image to convert.

newPixelFormat  PixelFormat

The desired new pixel format.

quantizer  IQuantizer

An optional IQuantizer instance to determine the colors of the result. If and newPixelFormat is an indexed format, then a default palette and quantization logic will be used.

ditherer  IDitherer  (Optional)

The ditherer to be used. Might be ignored if quantizer is not specified and newPixelFormat represents an at least 24 bits-per-pixel size. This parameter is optional.
Default value: .

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(Image, PixelFormat, IQuantizer, IDitherer, 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