BitmapDataExtensionsDrawRectangle(IReadWriteBitmapData, Color32, Rectangle, DrawingOptions, ParallelConfig) Method

Draws a one-pixel wide rectangle with the specified color.

Definition

Namespace: KGySoft.Drawing.Shapes
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 9.1.1

C#

public static bool DrawRectangle(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	Rectangle rectangle,
	DrawingOptions drawingOptions,
	ParallelConfig parallelConfig
)

VB

<ExtensionAttribute>
Public Shared Function DrawRectangle ( 
	bitmapData As IReadWriteBitmapData,
	color As Color32,
	rectangle As Rectangle,
	drawingOptions As DrawingOptions,
	parallelConfig As ParallelConfig
) As Boolean

C++

public:
[ExtensionAttribute]
static bool DrawRectangle(
	IReadWriteBitmapData^ bitmapData, 
	Color32 color, 
	Rectangle rectangle, 
	DrawingOptions^ drawingOptions, 
	ParallelConfig^ parallelConfig
)

F#

[<ExtensionAttribute>]
static member DrawRectangle : 
        bitmapData : IReadWriteBitmapData * 
        color : Color32 * 
        rectangle : Rectangle * 
        drawingOptions : DrawingOptions * 
        parallelConfig : ParallelConfig -> bool

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData instance to draw on.
color Color32: The color of the rectangle to draw.
rectangle Rectangle: The rectangle to draw.
drawingOptions DrawingOptions: A DrawingOptions instance that specifies the drawing options to use. If , then the default options are used.
parallelConfig ParallelConfig: The configuration of the 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. If , then the degree of parallelization is configured automatically.

Return Value

Boolean
, if the operation completed successfully.
, if the operation has been canceled and the ThrowIfCanceled property of the parallelConfig 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

When drawing a one-pixel wide rectangle, the right/bottom values of the coordinates are inclusive, so if the width and height are zero, a single pixel will be drawn.

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 drawingOptions is and the specified color is opaque, or when FastThinLines is enabled in drawingOptions, and 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.

Note

This method blocks the caller as it executes synchronously, though the parallelConfig parameter allows configuring the degree of parallelism, cancellation and progress reporting. Use the BeginDrawRectangle or DrawRectangleAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

If the rectangle is drawn by using a shortcut, then the operation cannot be canceled, it is not parallelized, and there is no progress reporting, regardless of the parallelConfig parameter.

Exceptions

ArgumentNullException	bitmapData is .
OverflowException	The coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.
OperationCanceledException	The operation has been canceled and the ThrowIfCanceled property in parallelConfig was .