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

public static IAsyncResult BeginToBitmap(
	this IReadableBitmapData source,
	PixelFormat pixelFormat,
	IQuantizer quantizer = null,
	IDitherer ditherer = null,
	AsyncConfig asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginToBitmap ( 
	source As IReadableBitmapData,
	pixelFormat As PixelFormat,
	Optional quantizer As IQuantizer = Nothing,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginToBitmap(
	IReadableBitmapData^ source, 
	PixelFormat pixelFormat, 
	IQuantizer^ quantizer = nullptr, 
	IDitherer^ ditherer = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginToBitmap : 
        source : IReadableBitmapData * 
        pixelFormat : PixelFormat * 
        ?quantizer : IQuantizer * 
        ?ditherer : IDitherer * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _quantizer = defaultArg quantizer null
        let _ditherer = defaultArg ditherer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

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

Usage Note

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.

Reference