BitmapDataExtensionsFillRectangle(IReadWriteBitmapData, IAsyncContext, Brush, RectangleF, DrawingOptions) Method

public static bool FillRectangle(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext? context,
	Brush brush,
	RectangleF rectangle,
	DrawingOptions? drawingOptions = null
)

<ExtensionAttribute>
Public Shared Function FillRectangle ( 
	bitmapData As IReadWriteBitmapData,
	context As IAsyncContext,
	brush As Brush,
	rectangle As RectangleF,
	Optional drawingOptions As DrawingOptions = Nothing
) As Boolean

public:
[ExtensionAttribute]
static bool FillRectangle(
	IReadWriteBitmapData^ bitmapData, 
	IAsyncContext^ context, 
	Brush^ brush, 
	RectangleF rectangle, 
	DrawingOptions^ drawingOptions = nullptr
)

[<ExtensionAttribute>]
static member FillRectangle : 
        bitmapData : IReadWriteBitmapData * 
        context : IAsyncContext * 
        brush : Brush * 
        rectangle : RectangleF * 
        ?drawingOptions : DrawingOptions 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
*)
-> bool 

Parameters

bitmapData  IReadWriteBitmapData

The IReadWriteBitmapData instance to draw on.

context  IAsyncContext

An IAsyncContext instance that contains information for asynchronous processing about the current operation.

brush  Brush

The Brush to use for filling the rectangle.

rectangle  RectangleF

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: .

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 location and size are integer values, 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 blocks the caller thread, but if context belongs to an async top level method, then the execution may already run on a pool thread. Degree of parallelism, the ability of cancellation and reporting progress depend on how these were configured at the top level method. To reconfigure the degree of parallelism of an existing context, you can use the AsyncContextWrapper class.

Alternatively, you can use this method to specify the degree of parallelism for synchronous execution. For example, by passing AsyncHelper.SingleThreadContext to the context parameter the method will be forced to use a single thread only.

When reporting progress, this library always passes a DrawingOperation instance to the generic methods of the IAsyncProgress interface.

Reference