BitmapDataExtensionsDrawLines(IReadWriteBitmapData, IAsyncContext, Color32, IEnumerablePointF, DrawingOptions) Method

public static bool DrawLines(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext? context,
	Color32 color,
	IEnumerable<PointF> points,
	DrawingOptions? drawingOptions = null
)

<ExtensionAttribute>
Public Shared Function DrawLines ( 
	bitmapData As IReadWriteBitmapData,
	context As IAsyncContext,
	color As Color32,
	points As IEnumerable(Of PointF),
	Optional drawingOptions As DrawingOptions = Nothing
) As Boolean

public:
[ExtensionAttribute]
static bool DrawLines(
	IReadWriteBitmapData^ bitmapData, 
	IAsyncContext^ context, 
	Color32 color, 
	IEnumerable<PointF>^ points, 
	DrawingOptions^ drawingOptions = nullptr
)

[<ExtensionAttribute>]
static member DrawLines : 
        bitmapData : IReadWriteBitmapData * 
        context : IAsyncContext * 
        color : Color32 * 
        points : IEnumerable<PointF> * 
        ?drawingOptions : DrawingOptions 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
*)
-> bool 

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 lines to draw.

points  IEnumerablePointF

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: .

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 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.

Reference