BitmapDataExtensionsFillRoundedRectangleAsync(IReadWriteBitmapData, Brush, Rectangle, Int32, DrawingOptions, TaskConfig) Method

public static Task<bool> FillRoundedRectangleAsync(
	this IReadWriteBitmapData bitmapData,
	Brush brush,
	Rectangle bounds,
	int cornerRadius,
	DrawingOptions? drawingOptions = null,
	TaskConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function FillRoundedRectangleAsync ( 
	bitmapData As IReadWriteBitmapData,
	brush As Brush,
	bounds As Rectangle,
	cornerRadius As Integer,
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

public:
[ExtensionAttribute]
static Task<bool>^ FillRoundedRectangleAsync(
	IReadWriteBitmapData^ bitmapData, 
	Brush^ brush, 
	Rectangle bounds, 
	int cornerRadius, 
	DrawingOptions^ drawingOptions = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member FillRoundedRectangleAsync : 
        bitmapData : IReadWriteBitmapData * 
        brush : Brush * 
        bounds : Rectangle * 
        cornerRadius : 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.

brush  Brush

The Brush to use for filling the rounded rectangle.

bounds  Rectangle

The bounding rectangle that defines the rounded rectangle.

cornerRadius  Int32

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

Usage Note

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.

Reference