BitmapDataExtensionsDrawRoundedRectangle(IReadWriteBitmapData, IAsyncContext, Color32, RectangleF, Single, DrawingOptions) Method

public static bool DrawRoundedRectangle(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext context,
	Color32 color,
	RectangleF bounds,
	float cornerRadius,
	DrawingOptions drawingOptions = null
)

<ExtensionAttribute>
Public Shared Function DrawRoundedRectangle ( 
	bitmapData As IReadWriteBitmapData,
	context As IAsyncContext,
	color As Color32,
	bounds As RectangleF,
	cornerRadius As Single,
	Optional drawingOptions As DrawingOptions = Nothing
) As Boolean

public:
[ExtensionAttribute]
static bool DrawRoundedRectangle(
	IReadWriteBitmapData^ bitmapData, 
	IAsyncContext^ context, 
	Color32 color, 
	RectangleF bounds, 
	float cornerRadius, 
	DrawingOptions^ drawingOptions = nullptr
)

[<ExtensionAttribute>]
static member DrawRoundedRectangle : 
        bitmapData : IReadWriteBitmapData * 
        context : IAsyncContext * 
        color : Color32 * 
        bounds : RectangleF * 
        cornerRadius : float32 * 
        ?drawingOptions : DrawingOptions 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
*)
-> bool 

Parameters

bitmapData  IReadWriteBitmapData

The IReadWriteBitmapData instance to draw on.

context  IAsyncContext

An IAsyncContext instance that contains information for asynchronous processing about the current operation.

color  Color32

The color of the rounded rectangle to draw.

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: .

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 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 rectangle will be drawn.

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 blocks the caller thread, but if context belongs to an async top level method, then the execution may already run on a pool thread. Degree of parallelism, the ability of cancellation and reporting progress depend on how these were configured at the top level method. To reconfigure the degree of parallelism of an existing context, you can use the AsyncContextWrapper class.

Alternatively, you can use this method to specify the degree of parallelism for synchronous execution. For example, by passing AsyncHelper.SingleThreadContext to the context parameter the method will be forced to use a single thread only.

When reporting progress, this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface.

Reference