BitmapDataExtensionsDrawConicCurve(IReadWriteBitmapData, IAsyncContext, Color32, PointF, PointF, PointF, Single, DrawingOptions) Method

Draws a one-pixel wide conic curve with the specified color, 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 DrawConicCurve(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext context,
	Color32 color,
	PointF p1,
	PointF p2,
	PointF p3,
	float weight,
	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 curve to draw.
p1  PointF
The starting point of the conic curve.
p2  PointF
The control point of the conic curve.
p3  PointF
The ending point of the conic curve.
weight  Single
The weight of the conic curve, which determines the shape of the curve. Must be a positive value.
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

If the weight is 1, the conic curve is equivalent to a parabolic (quadratic) Bézier curve. If the weight is less than 1, the curve is an elliptic arc, and if it's greater than 1, the curve is a hyperbolic arc.

This method tries to use a shortcut to draw the curve directly, which is faster than creating a Path and adding the curve to it. A shortcut is possible when drawingOptions is and the specified color is opaque, or when FastThinLines is enabled in drawingOptions, and 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 curve is drawn repeatedly, creating a Path with PreferCaching enabled 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 .
ArgumentOutOfRangeExceptionweight must be a finite non-negative value.
OverflowExceptionThe coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.

See Also