BitmapDataExtensionsDrawPie(IReadWriteBitmapData, Pen, Rectangle, Single, Single, DrawingOptions, ParallelConfig) Method

Draws a pie shape 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 DrawPie(
	this IReadWriteBitmapData bitmapData,
	Pen pen,
	Rectangle bounds,
	float startAngle,
	float sweepAngle,
	DrawingOptions? drawingOptions = null,
	ParallelConfig? parallelConfig = null
)

<ExtensionAttribute>
Public Shared Function DrawPie ( 
	bitmapData As IReadWriteBitmapData,
	pen As Pen,
	bounds As Rectangle,
	startAngle As Single,
	sweepAngle As Single,
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional parallelConfig As ParallelConfig = Nothing
) As Boolean

C++

public:
[ExtensionAttribute]
static bool DrawPie(
	IReadWriteBitmapData^ bitmapData, 
	Pen^ pen, 
	Rectangle bounds, 
	float startAngle, 
	float sweepAngle, 
	DrawingOptions^ drawingOptions = nullptr, 
	ParallelConfig^ parallelConfig = nullptr
)

[<ExtensionAttribute>]
static member DrawPie : 
        bitmapData : IReadWriteBitmapData * 
        pen : Pen * 
        bounds : Rectangle * 
        startAngle : float32 * 
        sweepAngle : float32 * 
        ?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 pie shape.
bounds Rectangle: The bounding rectangle that defines the ellipse from which the pie is drawn.
startAngle Single: The starting angle of the pie shape, measured in degrees clockwise from the x-axis.
sweepAngle Single: The sweep angle of the pie shape, measured in degrees clockwise from startAngle.
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

The pie shape is defined by a partial outline of an ellipse and the two radial lines that intersect the endpoints of the partial outline.

This method tries to use a shortcut to draw the pie shape directly, which is faster than creating a Path and adding the pie 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 pie shape is drawn repeatedly, creating a Path with PreferCaching enabled can provide a better performance.

Note

This method adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. You can use the overloads that have a ParallelConfig parameter to configure these, while still executing the method synchronously. Alternatively, use the BeginDrawPie or DrawPieAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

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 .