KGy SOFT Drawing Libraries Help
Bitmap
Loads a managed IReadWriteBitmapData instance from the specified stream asynchronously that was saved by
the BitmapDataExtensions.Save method.
Definition
Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
A Task that represents the asynchronous operation, which could still be pending. its result can be , if the operation was canceled and the ThrowIfCanceled property of the asyncConfig parameter was .
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
C#
public static Task<IReadWriteBitmapData?> LoadAsync(
Stream stream,
TaskConfig? asyncConfig = null
)VB
Public Shared Function LoadAsync (
stream As Stream,
Optional asyncConfig As TaskConfig = Nothing
) As Task(Of IReadWriteBitmapData)C++
public:
static Task<IReadWriteBitmapData^>^ LoadAsync(
Stream^ stream,
TaskConfig^ asyncConfig = nullptr
)F#
static member LoadAsync :
stream : Stream *
?asyncConfig : TaskConfig
(* Defaults:
let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<IReadWriteBitmapData> Parameters
- stream Stream
- The stream to load the bitmap data from.
- asyncConfig TaskConfig (Optional)
- The configuration of the asynchronous operation such as 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
TaskIReadWriteBitmapDataA Task that represents the asynchronous operation, which could still be pending. its result can be , if the operation was canceled and the ThrowIfCanceled property of the asyncConfig parameter was .
Remarks
This method is not a blocking call, though the operation is not parallelized and the MaxDegreeOfParallelism property of the asyncConfig parameter is ignored.