ImageExtensionsConvertPixelFormatAsync(Image, PixelFormat, IQuantizer, IDitherer, TaskConfig) Method

Converts the specified image to a Bitmap of the desired PixelFormat asynchronously.


Namespace: KGySoft.Drawing
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 8.1.0
public static Task<Bitmap?> ConvertPixelFormatAsync(
	this Image image,
	PixelFormat newPixelFormat,
	IQuantizer? quantizer,
	IDitherer? ditherer = null,
	TaskConfig? asyncConfig = null


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  TaskConfig  (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

A task that represents the asynchronous operation. Its result is the new Bitmap instance with the desired pixel format, or , if the operation was canceled and the ThrowIfCanceled property of the asyncConfig parameter was .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Image. 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).


Alternatively, you can also use the BeginConvertPixelFormat(Image, PixelFormat, IQuantizer, IDitherer, AsyncConfig) method, which is available on every platform.

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

See Also