ReadableBitmapDataExtensionsBeginToBitmap(IReadableBitmapData, PixelFormat, IQuantizer, IDitherer, AsyncConfig) Method

Begins to convert the specified source to a Bitmap with a specific PixelFormat asynchronously.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 8.1.0
C#
public static IAsyncResult BeginToBitmap(
	this IReadableBitmapData source,
	PixelFormat pixelFormat,
	IQuantizer quantizer = null,
	IDitherer ditherer = null,
	AsyncConfig asyncConfig = null
)

Parameters

source  IReadableBitmapData
The source IReadableBitmapData instance to convert.
pixelFormat  PixelFormat
The desired result pixel format.
quantizer  IQuantizer  (Optional)
An optional IQuantizer instance to determine the colors of the result. If and pixelFormat is an indexed format, then a default palette and quantization logic will be used. This parameter is optional.
Default value: .
ditherer  IDitherer  (Optional)
The ditherer to be used. Might be ignored if quantizer is not specified and pixelFormat 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

IAsyncResult
An IAsyncResult that represents the asynchronous operation, which could still be pending.

Usage Note

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

Remarks

In .NET Framework 4.0 and above you can use also the ToBitmapAsync method.

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

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

Exceptions

ArgumentNullExceptionsource is .
ArgumentOutOfRangeExceptionpixelFormat does not specify a valid format.
PlatformNotSupportedExceptionThe specified pixelFormat is not supported on the current platform.

See Also