BitmapDataExtensionsDrawPolygon(IReadWriteBitmapData, Color32, IEnumerablePoint, DrawingOptions) Method

Draws a one-pixel wide polygon with the specified color.

Definition

Namespace: KGySoft.Drawing.Shapes
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 9.1.1

C#

public static void DrawPolygon(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	IEnumerable<Point> points,
	DrawingOptions? drawingOptions = null
)

VB

<ExtensionAttribute>
Public Shared Sub DrawPolygon ( 
	bitmapData As IReadWriteBitmapData,
	color As Color32,
	points As IEnumerable(Of Point),
	Optional drawingOptions As DrawingOptions = Nothing
)

C++

public:
[ExtensionAttribute]
static void DrawPolygon(
	IReadWriteBitmapData^ bitmapData, 
	Color32 color, 
	IEnumerable<Point>^ points, 
	DrawingOptions^ drawingOptions = nullptr
)

F#

[<ExtensionAttribute>]
static member DrawPolygon : 
        bitmapData : IReadWriteBitmapData * 
        color : Color32 * 
        points : IEnumerable<Point> * 
        ?drawingOptions : DrawingOptions 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
*)
-> unit

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData instance to draw on.
color Color32: The color of the polygon to draw.
points IEnumerablePoint: The vertices of the polygon 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: .

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

Every pair of two consecutive points specifies a side of the polygon. In addition, if the last point and the first point do not coincide, they specify the last side of the polygon.

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

Note

This method adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. You can use the overloads that have a ParallelConfig parameter to configure these, while still executing the method synchronously. Alternatively, use the BeginDrawPolygon or DrawPolygonAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

Exceptions

ArgumentNullException	bitmapData or points is .
OverflowException	A Path is created internally and the width or height of Path.Bounds overflows.