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

Fills a rounded rectangle with the specified Brush, applying a custom corner radius to each corner.

Definition

Namespace: KGySoft.Drawing.Shapes
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1

public static bool FillRoundedRectangle(
	this IReadWriteBitmapData bitmapData,
	Brush brush,
	Rectangle bounds,
	int radiusTopLeft,
	int radiusTopRight,
	int radiusBottomRight,
	int radiusBottomLeft,
	DrawingOptions? drawingOptions = null,
	ParallelConfig? parallelConfig = null
)

<ExtensionAttribute>
Public Shared Function FillRoundedRectangle ( 
	bitmapData As IReadWriteBitmapData,
	brush As Brush,
	bounds As Rectangle,
	radiusTopLeft As Integer,
	radiusTopRight As Integer,
	radiusBottomRight As Integer,
	radiusBottomLeft As Integer,
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional parallelConfig As ParallelConfig = Nothing
) As Boolean

C++

public:
[ExtensionAttribute]
static bool FillRoundedRectangle(
	IReadWriteBitmapData^ bitmapData, 
	Brush^ brush, 
	Rectangle bounds, 
	int radiusTopLeft, 
	int radiusTopRight, 
	int radiusBottomRight, 
	int radiusBottomLeft, 
	DrawingOptions^ drawingOptions = nullptr, 
	ParallelConfig^ parallelConfig = nullptr
)

[<ExtensionAttribute>]
static member FillRoundedRectangle : 
        bitmapData : IReadWriteBitmapData * 
        brush : Brush * 
        bounds : Rectangle * 
        radiusTopLeft : int * 
        radiusTopRight : int * 
        radiusBottomRight : int * 
        radiusBottomLeft : int * 
        ?drawingOptions : DrawingOptions * 
        ?parallelConfig : ParallelConfig 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
        let _parallelConfig = defaultArg parallelConfig null
*)
-> 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.
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: .
parallelConfig ParallelConfig (Optional): 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. This parameter is optional.
Default value: .

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 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 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 or brush 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 .