BitmapDataExtensionsDrawRoundedRectangleAsync(IReadWriteBitmapData, Color32, Rectangle, Int32, Int32, Int32, Int32, DrawingOptions, TaskConfig) Method

public static Task<bool> DrawRoundedRectangleAsync(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	Rectangle bounds,
	int radiusTopLeft,
	int radiusTopRight,
	int radiusBottomRight,
	int radiusBottomLeft,
	DrawingOptions? drawingOptions = null,
	TaskConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function DrawRoundedRectangleAsync ( 
	bitmapData As IReadWriteBitmapData,
	color As Color32,
	bounds As Rectangle,
	radiusTopLeft As Integer,
	radiusTopRight As Integer,
	radiusBottomRight As Integer,
	radiusBottomLeft As Integer,
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

public:
[ExtensionAttribute]
static Task<bool>^ DrawRoundedRectangleAsync(
	IReadWriteBitmapData^ bitmapData, 
	Color32 color, 
	Rectangle bounds, 
	int radiusTopLeft, 
	int radiusTopRight, 
	int radiusBottomRight, 
	int radiusBottomLeft, 
	DrawingOptions^ drawingOptions = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member DrawRoundedRectangleAsync : 
        bitmapData : IReadWriteBitmapData * 
        color : Color32 * 
        bounds : Rectangle * 
        radiusTopLeft : int * 
        radiusTopRight : int * 
        radiusBottomRight : int * 
        radiusBottomLeft : int * 
        ?drawingOptions : DrawingOptions * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<bool> 

Parameters

bitmapData  IReadWriteBitmapData

The IReadWriteBitmapData instance to draw on.

color  Color32

The color of the rounded rectangle to draw.

bounds  Rectangle

The bounding rectangle that defines the rounded rectangle.

radiusTopLeft  Int32

The size of the top-left corner radius of the rounded rectangle.

radiusTopRight  Int32

The size of the top-right corner radius of the rounded rectangle.

radiusBottomRight  Int32

The size of the bottom-right corner radius of the rounded rectangle.

radiusBottomLeft  Int32

The size of the bottom-left corner radius of the rounded rectangle.

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

Usage Note

When drawing a one-pixel wide rounded rectangle, the right/bottom values of the bounding rectangle are inclusive, so if the width and height are zero, a single pixel will be drawn.

If a corner radius parameter is negative, its absolute value will be used. If the sum of any adjacent corner radius parameters is greater than the corresponding side of the bounding rectangle, then all corner radius parameters will be scaled down proportionally to fit into the bounding rectangle.

This method tries to use a shortcut to draw the rounded rectangle directly, which is faster than creating a Path and adding the rounded rectangle to it. A shortcut is possible when drawingOptions is and the specified color is opaque, or when FastThinLines is enabled in drawingOptions, and it specifies that no anti-aliasing and no alpha blending is required, the transformation is the identity matrix, and neither Quantizer nor Ditherer is specified.

When no shortcut can be used and the same rounded rectangle is drawn repeatedly, creating a Path with PreferCaching enabled can provide a better performance.

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

If the rounded rectangle is drawn by using a shortcut, then the operation is executed synchronously, it cannot be canceled, it is not parallelized, and there is no progress reporting, regardless of the asyncConfig parameter.

Reference