BitmapDataExtensionsDrawPathAsync(IReadWriteBitmapData, Pen, Path, DrawingOptions, TaskConfig) Method

public static Task<bool> DrawPathAsync(
	this IReadWriteBitmapData bitmapData,
	Pen pen,
	Path path,
	DrawingOptions? drawingOptions = null,
	TaskConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function DrawPathAsync ( 
	bitmapData As IReadWriteBitmapData,
	pen As Pen,
	path As Path,
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

public:
[ExtensionAttribute]
static Task<bool>^ DrawPathAsync(
	IReadWriteBitmapData^ bitmapData, 
	Pen^ pen, 
	Path^ path, 
	DrawingOptions^ drawingOptions = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member DrawPathAsync : 
        bitmapData : IReadWriteBitmapData * 
        pen : Pen * 
        path : Path * 
        ?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.

pen  Pen

The Pen that determines the characteristics of the path outline.

path  Path

The Path instance 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

If the Transformation property of drawingOptions is not the identity matrix, then the path region is not cached, even if PreferCaching is enabled. To improve the performance of drawing transformed paths repeatedly, apply the transformations on the path instance instead, and use the identity matrix in drawingOptions.

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

Reference