BitmapDataExtensionsDrawArc(IReadWriteBitmapData, Pen, Point, Point, Int32, Int32, Single, Boolean, Boolean, DrawingOptions, ParallelConfig) Method

Draws an elliptical arc between two points with the specified Pen.

Definition

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

public static bool DrawArc(
	this IReadWriteBitmapData bitmapData,
	Pen pen,
	Point startPoint,
	Point endPoint,
	int radiusX,
	int radiusY,
	float rotationAngle,
	bool isLargeArc,
	bool isClockwise,
	DrawingOptions? drawingOptions = null,
	ParallelConfig? parallelConfig = null
)

<ExtensionAttribute>
Public Shared Function DrawArc ( 
	bitmapData As IReadWriteBitmapData,
	pen As Pen,
	startPoint As Point,
	endPoint As Point,
	radiusX As Integer,
	radiusY As Integer,
	rotationAngle As Single,
	isLargeArc As Boolean,
	isClockwise As Boolean,
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional parallelConfig As ParallelConfig = Nothing
) As Boolean

C++

public:
[ExtensionAttribute]
static bool DrawArc(
	IReadWriteBitmapData^ bitmapData, 
	Pen^ pen, 
	Point startPoint, 
	Point endPoint, 
	int radiusX, 
	int radiusY, 
	float rotationAngle, 
	bool isLargeArc, 
	bool isClockwise, 
	DrawingOptions^ drawingOptions = nullptr, 
	ParallelConfig^ parallelConfig = nullptr
)

[<ExtensionAttribute>]
static member DrawArc : 
        bitmapData : IReadWriteBitmapData * 
        pen : Pen * 
        startPoint : Point * 
        endPoint : Point * 
        radiusX : int * 
        radiusY : int * 
        rotationAngle : float32 * 
        isLargeArc : bool * 
        isClockwise : bool * 
        ?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.
pen Pen: The Pen that determines the characteristics of the arc.
startPoint Point: The starting point of the arc to add.
endPoint Point: The end point of the arc to add.
radiusX Int32: The radius along the x-axis of the ellipse from which the arc is drawn.
radiusY Int32: The radius along the y-axis of the ellipse from which the arc is drawn.
rotationAngle Single: The angle, in degrees, by which the ellipse is rotated relative to the x-axis.
isLargeArc Boolean: if the arc span is 180 degrees or greater; otherwise, .
isClockwise Boolean: if the arc is drawn in a clockwise direction; otherwise, .
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

This method tries to use a shortcut to draw the arc directly, which is faster than creating a Path and adding the arc to it. A shortcut is possible when the specified pen has a width between 0.25 and 1, it uses a solid Brush with an opaque color, and if drawingOptions is either , or its FastThinLines is enabled in drawingOptions, 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 arc is drawn repeatedly, creating a Path with PreferCaching enabled can provide a better performance.

This overload provides the same parameters that are used in SVG paths for elliptical arcs, and also by several XAML-based frameworks, such as WPF, UWP, and WinUI.

If radiusX or radiusY is negative, their absolute value will be used.

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 BeginDrawArc or DrawArcAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

If the arc is drawn by using a shortcut, then the operation cannot be canceled, it is not parallelized, and there is no progress reporting, regardless of the parallelConfig parameter.

Exceptions

ArgumentNullException	bitmapData or pen 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 .