BitmapDataExtensionsDrawPath(IReadWriteBitmapData, Pen, Path, DrawingOptions, ParallelConfig) Method

Draws the outline of a Path with the specified Pen.

Definition

Namespace: KGySoft.Drawing.Shapes
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 10.0.0-rc.1

C#

public static bool DrawPath(
	this IReadWriteBitmapData bitmapData,
	Pen pen,
	Path path,
	DrawingOptions? drawingOptions = null,
	ParallelConfig? parallelConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function DrawPath ( 
	bitmapData As IReadWriteBitmapData,
	pen As Pen,
	path As Path,
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional parallelConfig As ParallelConfig = Nothing
) As Boolean

C++

public:
[ExtensionAttribute]
static bool DrawPath(
	IReadWriteBitmapData^ bitmapData, 
	Pen^ pen, 
	Path^ path, 
	DrawingOptions^ drawingOptions = nullptr, 
	ParallelConfig^ parallelConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member DrawPath : 
        bitmapData : IReadWriteBitmapData * 
        pen : Pen * 
        path : Path * 
        ?drawingOptions : DrawingOptions * 
        ?parallelConfig : ParallelConfig 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
        let _parallelConfig = defaultArg parallelConfig null
*)
-> 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: .
parallelConfig ParallelConfig (Optional): The configuration of the 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. If , then the degree of parallelization is configured automatically. This parameter is optional.
Default value: .

Return Value

Boolean
, if the operation completed successfully.
, if the operation has been canceled and the ThrowIfCanceled property of the parallelConfig parameter was .

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

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.

Note

This method blocks the caller as it executes synchronously, though the parallelConfig parameter allows configuring the degree of parallelism, cancellation and progress reporting. Use the BeginDrawPath or DrawPathAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

Exceptions

ArgumentNullException	bitmapData, pen or path is .
OverflowException	The coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.
OperationCanceledException	The operation has been canceled and the ThrowIfCanceled property in parallelConfig was .