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

Fills a rounded rectangle with the specified color, applying the same corner radius to all corners, and using a context that may belong to a higher level, possibly asynchronous operation.

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,
	IAsyncContext context,
	Color32 color,
	Rectangle bounds,
	int cornerRadius,
	DrawingOptions drawingOptions = null
)

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 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  (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

Boolean
, if the operation completed successfully.
, if the operation has been canceled.

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.

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.

  Tip

See the Examples section of the AsyncHelper class for details about how to create a context for possibly async top level methods.

Exceptions

ArgumentNullExceptionbitmapData is .
OverflowExceptionThe coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.

See Also