BitmapDataExtensionsDrawRectangle(IReadWriteBitmapData, Color32, Single, Single, Single, Single, DrawingOptions) 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: 10.0.0-rc.1

C#

public static void DrawRectangle(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	float x,
	float y,
	float width,
	float height,
	DrawingOptions? drawingOptions = null
)

VB

<ExtensionAttribute>
Public Shared Sub DrawRectangle ( 
	bitmapData As IReadWriteBitmapData,
	color As Color32,
	x As Single,
	y As Single,
	width As Single,
	height As Single,
	Optional drawingOptions As DrawingOptions = Nothing
)

C++

public:
[ExtensionAttribute]
static void DrawRectangle(
	IReadWriteBitmapData^ bitmapData, 
	Color32 color, 
	float x, 
	float y, 
	float width, 
	float height, 
	DrawingOptions^ drawingOptions = nullptr
)

F#

[<ExtensionAttribute>]
static member DrawRectangle : 
        bitmapData : IReadWriteBitmapData * 
        color : Color32 * 
        x : float32 * 
        y : float32 * 
        width : float32 * 
        height : float32 * 
        ?drawingOptions : DrawingOptions 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
*)
-> unit

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData instance to draw on.
color Color32: The color of the rectangle to draw.
x Single: The x-coordinate of the upper-left corner.
y Single: The y-coordinate of the upper-left corner.
width Single: The width of the rectangle.
height Single: The height of the rectangle.
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: .

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 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 adjusts the degree of parallelization automatically, blocks the caller, and does not support cancellation or reporting progress. You can use the overloads that have a ParallelConfig parameter to configure these, while still executing the method synchronously. Alternatively, use the BeginDrawRectangle or DrawRectangleAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

Exceptions

ArgumentNullException	bitmapData is .
OverflowException	The coordinates (after a possible transformation specified in drawingOptions) are outside the bounds of an int value.