BitmapDataExtensionsFillRoundedRectangleAsync(IReadWriteBitmapData, Color32, RectangleF, Single, DrawingOptions, TaskConfig) Method

Fills a rounded rectangle with the specified color asynchronously, applying the same corner radius to all corners.

Definition

Namespace: KGySoft.Drawing.Shapes
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
C#
public static Task<bool> FillRoundedRectangleAsync(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	RectangleF bounds,
	float cornerRadius,
	DrawingOptions? drawingOptions = null,
	TaskConfig? asyncConfig = null
)

Parameters

bitmapData  IReadWriteBitmapData
The IReadWriteBitmapData instance to draw on.
color  Color32
The color of the rounded rectangle to fill.
bounds  RectangleF
The bounding rectangle that defines the rounded rectangle.
cornerRadius  Single
The size of the corner radius of the rounded rectangle for all corners.
drawingOptions  DrawingOptions  (Optional)
A DrawingOptions instance that specifies the drawing options to use. If , then the default options are used. 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

TaskBoolean
A task that represents the asynchronous operation. Its result is , if the operation completed successfully, or , if the operation has been canceled and the ThrowIfCanceled property in asyncConfig parameter was .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReadWriteBitmapData. 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

When filling a rounded rectangle, the right/bottom values of the bounding rectangle are exclusive, so if the width or height is zero, then nothing is drawn.

If cornerRadius is negative, the absolute value will be used. If it is greater than the half of the smaller side of the bounding rectangle, it will be adjusted to the half of the smaller side, so the result will be an oval shape. If the cornerRadius is 0, a simple filled rectangle will be drawn.

This method does not use optimized shortcuts. If the same rounded rectangle is filled repeatedly, creating a Path with PreferCaching enabled and adding the rounded rectangle to it can provide a better performance.

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

Exceptions

ArgumentNullExceptionbitmapData is .
OverflowExceptionThe coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.
TaskCanceledExceptionThe operation has been canceled and the ThrowIfCanceled property in asyncConfig was . This exception is thrown when the result is awaited.

See Also