BitmapDataExtensionsDrawRectangle(IReadWriteBitmapData, IAsyncContext, Pen, RectangleF, DrawingOptions) Method

public static bool DrawRectangle(
	this IReadWriteBitmapData bitmapData,
	IAsyncContext? context,
	Pen pen,
	RectangleF rectangle,
	DrawingOptions? drawingOptions = null
)

<ExtensionAttribute>
Public Shared Function DrawRectangle ( 
	bitmapData As IReadWriteBitmapData,
	context As IAsyncContext,
	pen As Pen,
	rectangle As RectangleF,
	Optional drawingOptions As DrawingOptions = Nothing
) As Boolean

public:
[ExtensionAttribute]
static bool DrawRectangle(
	IReadWriteBitmapData^ bitmapData, 
	IAsyncContext^ context, 
	Pen^ pen, 
	RectangleF rectangle, 
	DrawingOptions^ drawingOptions = nullptr
)

[<ExtensionAttribute>]
static member DrawRectangle : 
        bitmapData : IReadWriteBitmapData * 
        context : IAsyncContext * 
        pen : Pen * 
        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.

pen  Pen

The Pen that determines the characteristics of the rectangle.

rectangle  RectangleF

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

Return Value

Usage Note

This method tries to use a shortcut to draw the rectangle directly, which is faster than creating a Path and adding the rectangle to it. A shortcut is possible when the specified pen has a width between 0.25 and 1, it uses a solid Brush with an opaque color, and if drawingOptions is either , or its FastThinLines is enabled in drawingOptions, 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.

When no shortcut can be used and the same rectangle is drawn repeatedly, creating a Path with PreferCaching enabled can provide a better performance.

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