BitmapDataExtensionsBeginDrawArc(IReadWriteBitmapData, Pen, PointF, PointF, Single, Single, Single, Boolean, Boolean, DrawingOptions, AsyncConfig) Method

Begins to draw an elliptical arc between two points with the specified Pen asynchronously.

Definition

Namespace: KGySoft.Drawing.Shapes
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1
C#
public static IAsyncResult BeginDrawArc(
	this IReadWriteBitmapData bitmapData,
	Pen pen,
	PointF startPoint,
	PointF endPoint,
	float radiusX,
	float radiusY,
	float rotationAngle,
	bool isLargeArc,
	bool isClockwise,
	DrawingOptions? drawingOptions = null,
	AsyncConfig? asyncConfig = null
)

Parameters

bitmapData  IReadWriteBitmapData
The IReadWriteBitmapData instance to draw on.
pen  Pen
The Pen that determines the characteristics of the arc.
startPoint  PointF
The starting point of the arc to add.
endPoint  PointF
The end point of the arc to add.
radiusX  Single
The radius along the x-axis of the ellipse from which the arc is drawn.
radiusY  Single
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: .
asyncConfig  AsyncConfig  (Optional)
The configuration of the asynchronous 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. This parameter is optional.
Default value: .

Return Value

IAsyncResult
An IAsyncResult that represents the asynchronous operation, which could still be pending.

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.

In .NET Framework 4.0 and above you can use also the DrawArcAsync methods.

To finish the operation and to get the exception that occurred during the operation you have to call the EndDrawArc method.

This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.

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

Exceptions

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

See Also