BitmapDataExtensionsBeginFillEllipse(IReadWriteBitmapData, Color32, Rectangle, DrawingOptions, AsyncConfig) Method

Begins to fill an ellipse with the specified color asynchronously.

Definition

Namespace: KGySoft.Drawing.Shapes
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 9.1.1
C#
public static IAsyncResult BeginFillEllipse(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	Rectangle bounds,
	DrawingOptions? drawingOptions = null,
	AsyncConfig? asyncConfig = null
)

Parameters

bitmapData  IReadWriteBitmapData
The IReadWriteBitmapData instance to draw on.
color  Color32
The color of the ellipse to fill.
bounds  Rectangle
The bounding rectangle that defines the ellipse.
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

IAsyncResult
An IAsyncResult that represents the asynchronous operation, which could still be pending.

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

When filling an ellipse, the right/bottom values of the bounding rectangle are exclusive, so if the width or height is zero, then nothing is drawn.

This method does not use optimized shortcuts. If the same ellipse is filled repeatedly, creating a Path with PreferCaching enabled and adding the ellipse to it can provide a better performance.

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

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

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

Exceptions

ArgumentNullExceptionbitmapData is .
OverflowExceptionThe coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.

See Also