ReadableBitmapDataExtensionsToWriteableBitmapAsync(IReadableBitmapData, PixelFormat, IQuantizer, IDitherer, TaskConfig) Method

Converts the specified source to a WriteableBitmap asynchronously.

Definition

Namespace: KGySoft.Drawing.Wpf
Assembly: KGySoft.Drawing.Wpf (in KGySoft.Drawing.Wpf.dll) Version: 9.0.0

C#

public static Task<WriteableBitmap?> ToWriteableBitmapAsync(
	this IReadableBitmapData source,
	PixelFormat pixelFormat,
	IQuantizer quantizer = null,
	IDitherer ditherer = null,
	TaskConfig asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function ToWriteableBitmapAsync ( 
	source As IReadableBitmapData,
	pixelFormat As PixelFormat,
	Optional quantizer As IQuantizer = Nothing,
	Optional ditherer As IDitherer = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of WriteableBitmap)

C++

public:
[ExtensionAttribute]
static Task<WriteableBitmap^>^ ToWriteableBitmapAsync(
	IReadableBitmapData^ source, 
	PixelFormat pixelFormat, 
	IQuantizer^ quantizer = nullptr, 
	IDitherer^ ditherer = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

F#

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

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

TaskWriteableBitmap
A task that represents the asynchronous operation. Its result is a WriteableBitmap instance that has the same content as the specified source, or , if the operation was canceled and the ThrowIfCanceledproperty 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 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

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

Caution

If quantizer is not a PredefinedColorsQuantizer, then the result WriteableBitmap is created by a synchronized callback using the dispatcher of the thread this method was called from. The caller thread must have a running dispatcher and must not be blocked; otherwise, a deadlock may occur.

Exceptions

ArgumentNullException	source is .
ArgumentOutOfRangeException	pixelFormat does not specify a valid format.
ArgumentException	The quantizer palette contains too many colors for the indexed format specified by pixelFormat.
InvalidOperationException	A deadlock has been detected while attempting to create the result.