BitmapDataExtensionsFillRectangleAsync(IReadWriteBitmapData, Brush, Rectangle, DrawingOptions, TaskConfig) Method

public static Task<bool> FillRectangleAsync(
	this IReadWriteBitmapData bitmapData,
	Brush brush,
	Rectangle rectangle,
	DrawingOptions? drawingOptions = null,
	TaskConfig? asyncConfig = null
)

<ExtensionAttribute>
Public Shared Function FillRectangleAsync ( 
	bitmapData As IReadWriteBitmapData,
	brush As Brush,
	rectangle As Rectangle,
	Optional drawingOptions As DrawingOptions = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

public:
[ExtensionAttribute]
static Task<bool>^ FillRectangleAsync(
	IReadWriteBitmapData^ bitmapData, 
	Brush^ brush, 
	Rectangle rectangle, 
	DrawingOptions^ drawingOptions = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

[<ExtensionAttribute>]
static member FillRectangleAsync : 
        bitmapData : IReadWriteBitmapData * 
        brush : Brush * 
        rectangle : Rectangle * 
        ?drawingOptions : DrawingOptions * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<bool> 

Parameters

bitmapData  IReadWriteBitmapData

The IReadWriteBitmapData instance to draw on.

brush  Brush

The Brush to use for filling the rectangle.

rectangle  Rectangle

The rectangle 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

Usage Note

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

This method tries to use a shortcut to fill the rectangle directly, which is faster than creating a Path and adding the rectangle to it. A shortcut is possible when the specified brush is a solid brush with an opaque color, and if drawingOptions is either , or 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.

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

Reference