BitmapDataExtensionsFillPolygon(IReadWriteBitmapData, Color32, IEnumerablePoint, DrawingOptions) Method

Fills a 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 FillPolygon(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	IEnumerable<Point> points,
	DrawingOptions? drawingOptions = null
)

VB

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

C++

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

F#

[<ExtensionAttribute>]
static member FillPolygon : 
        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 fill.
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 does not use optimized shortcuts. If the same polygon is filled repeatedly, creating a Path with PreferCaching enabled and adding the polygon to it 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 BeginFillPolygon or FillPolygonAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

Exceptions

ArgumentNullException	bitmapData or points is .
OverflowException	The coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.