BitmapDataExtensionsBeginDrawPath(IReadWriteBitmapData, Color32, Path, DrawingOptions, AsyncConfig) Method

public static IAsyncResult BeginDrawPath(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	Path path,
	DrawingOptions? drawingOptions = null,
	AsyncConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function BeginDrawPath ( 
	bitmapData As IReadWriteBitmapData,
	color As Color32,
	path As Path,
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional asyncConfig As AsyncConfig = Nothing
) As IAsyncResult

public:
[ExtensionAttribute]
static IAsyncResult^ BeginDrawPath(
	IReadWriteBitmapData^ bitmapData, 
	Color32 color, 
	Path^ path, 
	DrawingOptions^ drawingOptions = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member BeginDrawPath : 
        bitmapData : IReadWriteBitmapData * 
        color : Color32 * 
        path : Path * 
        ?drawingOptions : DrawingOptions * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult 

Parameters

bitmapData  IReadWriteBitmapData

The IReadWriteBitmapData instance to draw on.

color  Color32

The color of the outline to draw.

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  AsyncConfig  (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 to the path instance instead, and use the identity matrix in drawingOptions.

In .NET Framework 4.0 and above you can use also the DrawPathAsync methods.

To finish the operation and to get the exception that occurred during the operation you have to call the EndDrawPath method.

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

Reference