BitmapDataExtensionsFillPolygon(IReadWriteBitmapData, Brush, IEnumerablePointF, DrawingOptions, ParallelConfig) Method

Fills a polygon with the specified Brush.

Definition

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

C#

public static bool FillPolygon(
	this IReadWriteBitmapData bitmapData,
	Brush brush,
	IEnumerable<PointF> points,
	DrawingOptions? drawingOptions = null,
	ParallelConfig? parallelConfig = null
)

VB

<ExtensionAttribute>
Public Shared Function FillPolygon ( 
	bitmapData As IReadWriteBitmapData,
	brush As Brush,
	points As IEnumerable(Of PointF),
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional parallelConfig As ParallelConfig = Nothing
) As Boolean

C++

public:
[ExtensionAttribute]
static bool FillPolygon(
	IReadWriteBitmapData^ bitmapData, 
	Brush^ brush, 
	IEnumerable<PointF>^ points, 
	DrawingOptions^ drawingOptions = nullptr, 
	ParallelConfig^ parallelConfig = nullptr
)

F#

[<ExtensionAttribute>]
static member FillPolygon : 
        bitmapData : IReadWriteBitmapData * 
        brush : Brush * 
        points : IEnumerable<PointF> * 
        ?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.
brush Brush: The Brush to use for filling the polygon.
points IEnumerablePointF: 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: .
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

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 blocks the caller as it executes synchronously, though the parallelConfig parameter allows configuring the degree of parallelism, cancellation and progress reporting. Use the BeginFillPolygon or FillPolygonAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

Exceptions

ArgumentNullException	bitmapData, brush, or points 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 .