BitmapSourceExtensionsConvertPixelFormatAsync(BitmapSource, PixelFormat, IQuantizer, IDitherer, TaskConfig) Method
Namespace: KGySoft.Drawing.WpfAssembly: KGySoft.Drawing.Wpf (in KGySoft.Drawing.Wpf.dll) Version: 9.0.0
public static Task<WriteableBitmap?> ConvertPixelFormatAsync(
this BitmapSource bitmap,
PixelFormat newPixelFormat,
IQuantizer? quantizer,
IDitherer? ditherer = null,
TaskConfig? asyncConfig = null
)
<ExtensionAttribute>
Public Shared Function ConvertPixelFormatAsync (
bitmap As BitmapSource,
newPixelFormat As PixelFormat,
quantizer As IQuantizer,
Optional ditherer As IDitherer = Nothing,
Optional asyncConfig As TaskConfig = Nothing
) As Task(Of WriteableBitmap)
public:
[ExtensionAttribute]
static Task<WriteableBitmap^>^ ConvertPixelFormatAsync(
BitmapSource^ bitmap,
PixelFormat newPixelFormat,
IQuantizer^ quantizer,
IDitherer^ ditherer = nullptr,
TaskConfig^ asyncConfig = nullptr
)
[<ExtensionAttribute>]
static member ConvertPixelFormatAsync :
bitmap : BitmapSource *
newPixelFormat : PixelFormat *
quantizer : IQuantizer *
?ditherer : IDitherer *
?asyncConfig : TaskConfig
(* Defaults:
let _ditherer = defaultArg ditherer null
let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<WriteableBitmap>
- bitmap BitmapSource
- The original bitmap 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: .
TaskWriteableBitmapA task that represents the asynchronous operation. Its result is the new
WriteableBitmap instance with the desired pixel format,
or
, if the operation was canceled and the
ThrowIfCanceledproperty of the
asyncConfig parameter was
.In Visual Basic and C#, you can call this method as an instance method on any object of type
BitmapSource. 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(BitmapSource, PixelFormat, Color, Byte, 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.
- This method can be called from any thread but if it is called from a different one from the thread of the source bitmap's dispatcher,
then the result WriteableBitmap will be created by using a synchronized callback. To avoid possible deadlocks, the thread of the source bitmap
must not be blocked and the dispatcher must run. The result will be usable in the same thread as the source bitmap.
To avoid blocking waiting for the result use the keyword in C# (when using .NET Framework 4.5 or newer),
or use the Task.ContinueWith method to access
the Result of the completed task from there.
- If quantizer is not a PredefinedColorsQuantizer, then the result WriteableBitmap is created by a synchronized callback
on the thread of the source bitmap even if you call this method from the same thread. Do not block the thread of the source bitmap;
otherwise, a deadlock may occur.
See the
Remarks section of the
ConvertPixelFormat(BitmapSource, PixelFormat, Color, Byte) method for more details and image examples.
