ReadableBitmapDataExtensionsBeginToWriteableBitmap(IReadableBitmapData, PixelFormat, IQuantizer, IDitherer, AsyncConfig) Method
Namespace: KGySoft.Drawing.WpfAssembly: KGySoft.Drawing.Wpf (in KGySoft.Drawing.Wpf.dll) Version: 9.0.0
public static IAsyncResult BeginToWriteableBitmap(
this IReadableBitmapData source,
PixelFormat pixelFormat,
IQuantizer quantizer = null,
IDitherer ditherer = null,
AsyncConfig asyncConfig = null
)
<ExtensionAttribute>
Public Shared Function BeginToWriteableBitmap (
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^ BeginToWriteableBitmap(
IReadableBitmapData^ source,
PixelFormat pixelFormat,
IQuantizer^ quantizer = nullptr,
IDitherer^ ditherer = nullptr,
AsyncConfig^ asyncConfig = nullptr
)
[<ExtensionAttribute>]
static member BeginToWriteableBitmap :
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
- 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: .
IAsyncResultAn
IAsyncResult that represents the asynchronous operation, which could still be pending.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).
In .NET Framework 4.0 and above you can use also the ToWriteableBitmapAsync method.
To get the result or the exception that occurred during the operation you have to call the EndToWriteableBitmap method.
This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.
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.
