BitmapDataExtensionsResizeAsync Method

Resizes the specified source asynchronously.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1

C#

public static Task<IReadWriteBitmapData?> ResizeAsync(
	this IReadableBitmapData source,
	Size newSize,
	ScalingMode scalingMode = ScalingMode.Auto,
	bool keepAspectRatio = false,
	TaskConfig? asyncConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function ResizeAsync ( 
	source As IReadableBitmapData,
	newSize As Size,
	Optional scalingMode As ScalingMode = ScalingMode.Auto,
	Optional keepAspectRatio As Boolean = false,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of IReadWriteBitmapData)

C++

public:
[ExtensionAttribute]
static Task<IReadWriteBitmapData^>^ ResizeAsync(
	IReadableBitmapData^ source, 
	Size newSize, 
	ScalingMode scalingMode = ScalingMode::Auto, 
	bool keepAspectRatio = false, 
	TaskConfig^ asyncConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member ResizeAsync : 
        source : IReadableBitmapData * 
        newSize : Size * 
        ?scalingMode : ScalingMode * 
        ?keepAspectRatio : bool * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _scalingMode = defaultArg scalingMode ScalingMode.Auto
        let _keepAspectRatio = defaultArg keepAspectRatio false
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<IReadWriteBitmapData>

Parameters

source IReadableBitmapData: The source IReadableBitmapData to resize.
newSize Size: The requested new size.
scalingMode ScalingMode (Optional): A ScalingMode value, which determines the quality of the result as well as the processing time. This parameter is optional.
Default value: Auto.
keepAspectRatio Boolean (Optional): to keep aspect ratio of the specified source; otherwise, . 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

TaskIReadWriteBitmapData
An IAsyncResult that represents the asynchronous operation, which could still be pending.

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.

Tip

See the Remarks section of the Resize(IReadableBitmapData, Size, ScalingMode, Boolean) method for more details.