BitmapDataExtensionsDrawBeziers(IReadWriteBitmapData, IAsyncContext, Pen, IEnumerablePointF, DrawingOptions) Method

Draws a series of cubic Bézier curves with the specified Pen, 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 DrawBeziers(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext? context,
	Pen pen,
	IEnumerable<PointF> points,
	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.
pen  Pen
The Pen that determines the characteristics of the curves.
points  IEnumerablePointF
The points of the curves to draw.
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

The allowed number of points in the points parameter is 0, 1, or a multiple of 3 plus 1.

When points has at least four items, the first four points define the first Bézier curve. Each additional three points define a new Bézier curve, where the last point of the previous curve is the starting point of the next curve.

This method draws cubic Bézier curves. A cubic Bézier curve is defined by four points: the starting point, two control points, and the end point. To draw quadratic Bézier curves, you can use the DrawQuadraticCurves methods. In fact, those will transform the quadratic curves into cubic Bézier curve internally.

This method tries to use a shortcut to draw the curves directly, which is faster than creating a Path and adding the curves 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 Bézier curves are 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, pen, or points is .
ArgumentExceptionThe number of points is not a multiple of 3 plus 1.
OverflowExceptionThe coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.

See Also