BitmapDataExtensionsFillPathAsync(IReadWriteBitmapData, Brush, Path, DrawingOptions, TaskConfig) Method

Begins to fill a Path with the specified Brush asynchronously.

Definition

Namespace: KGySoft.Drawing.Shapes
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 9.1.1
C#
public static Task<bool> FillPathAsync(
	this IReadWriteBitmapData bitmapData,
	Brush brush,
	Path path,
	DrawingOptions? drawingOptions = null,
	TaskConfig? asyncConfig = null
)

Parameters

bitmapData  IReadWriteBitmapData
The IReadWriteBitmapData instance to draw on.
brush  Brush
The Brush to use for filling the Path.
path  Path
The Path instance to fill.
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  TaskConfig  (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

TaskBoolean
A task that represents the asynchronous operation. Its result is , if the operation completed successfully, or , if the operation has been canceled and the ThrowIfCanceled property in asyncConfig 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 filling transformed paths repeatedly, apply the transformations on the path instance instead, and use the identity matrix in drawingOptions.

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

Exceptions

ArgumentNullExceptionbitmapData, brush, or path is .
OverflowExceptionThe coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.
TaskCanceledExceptionThe operation has been canceled and the ThrowIfCanceled property in asyncConfig was . This exception is thrown when the result is awaited.

See Also