BitmapDataExtensionsFillRoundedRectangle(IReadWriteBitmapData, Color32, Rectangle, Int32, DrawingOptions, ParallelConfig) Method

Fills a rounded rectangle with the specified color, 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 bool FillRoundedRectangle(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	Rectangle bounds,
	int cornerRadius,
	DrawingOptions drawingOptions,
	ParallelConfig parallelConfig
)

VB

<ExtensionAttribute>
Public Shared Function FillRoundedRectangle ( 
	bitmapData As IReadWriteBitmapData,
	color As Color32,
	bounds As Rectangle,
	cornerRadius As Integer,
	drawingOptions As DrawingOptions,
	parallelConfig As ParallelConfig
) As Boolean

C++

public:
[ExtensionAttribute]
static bool FillRoundedRectangle(
	IReadWriteBitmapData^ bitmapData, 
	Color32 color, 
	Rectangle bounds, 
	int cornerRadius, 
	DrawingOptions^ drawingOptions, 
	ParallelConfig^ parallelConfig
)

F#

[<ExtensionAttribute>]
static member FillRoundedRectangle : 
        bitmapData : IReadWriteBitmapData * 
        color : Color32 * 
        bounds : Rectangle * 
        cornerRadius : int * 
        drawingOptions : DrawingOptions * 
        parallelConfig : ParallelConfig -> bool

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData instance to draw on.
color Color32: The color of the rounded rectangle to fill.
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: A DrawingOptions instance that specifies the drawing options to use. If , then the default options are used.
parallelConfig ParallelConfig: The configuration of the 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. If , then the degree of parallelization is configured automatically.

Return Value

Boolean
, if the operation completed successfully.
, if the operation has been canceled and the ThrowIfCanceled property of the parallelConfig 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.

Note

This method blocks the caller as it executes synchronously, though the parallelConfig parameter allows configuring the degree of parallelism, cancellation and progress reporting. Use the BeginFillRoundedRectangle or FillRoundedRectangleAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

Exceptions

ArgumentNullException	bitmapData is .
OverflowException	The coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.
OperationCanceledException	The operation has been canceled and the ThrowIfCanceled property in parallelConfig was .