BitmapDataExtensionsDrawLinesAsync(IReadWriteBitmapData, Color32, IEnumerablePoint, DrawingOptions, TaskConfig) Method

public static Task<bool> DrawLinesAsync(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	IEnumerable<Point> points,
	DrawingOptions? drawingOptions = null,
	TaskConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function DrawLinesAsync ( 
	bitmapData As IReadWriteBitmapData,
	color As Color32,
	points As IEnumerable(Of Point),
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

public:
[ExtensionAttribute]
static Task<bool>^ DrawLinesAsync(
	IReadWriteBitmapData^ bitmapData, 
	Color32 color, 
	IEnumerable<Point>^ points, 
	DrawingOptions^ drawingOptions = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member DrawLinesAsync : 
        bitmapData : IReadWriteBitmapData * 
        color : Color32 * 
        points : IEnumerable<Point> * 
        ?drawingOptions : DrawingOptions * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<bool> 

Parameters

bitmapData  IReadWriteBitmapData

The IReadWriteBitmapData instance to draw on.

color  Color32

The color of the lines to draw.

points  IEnumerablePoint

The points of the line segments 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: .

asyncConfig  TaskConfig  (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

Usage Note

The first point of the points array will be the starting point of the first line segment. Each additional point specifies the endpoint of a line segment, whose starting point is the endpoint of the previous line.

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

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

If the lines are 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.

Reference