BitmapDataExtensionsDrawLine(IReadWriteBitmapData, Color32, Int32, Int32, Int32, Int32, DrawingOptions) Method

Draws a one-pixel wide line between two points 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 void DrawLine(
	this IReadWriteBitmapData bitmapData,
	Color32 color,
	int x1,
	int y1,
	int x2,
	int y2,
	DrawingOptions? drawingOptions = null
)

VB

<ExtensionAttribute>
Public Shared Sub DrawLine ( 
	bitmapData As IReadWriteBitmapData,
	color As Color32,
	x1 As Integer,
	y1 As Integer,
	x2 As Integer,
	y2 As Integer,
	Optional drawingOptions As DrawingOptions = Nothing
)

C++

public:
[ExtensionAttribute]
static void DrawLine(
	IReadWriteBitmapData^ bitmapData, 
	Color32 color, 
	int x1, 
	int y1, 
	int x2, 
	int y2, 
	DrawingOptions^ drawingOptions = nullptr
)

F#

[<ExtensionAttribute>]
static member DrawLine : 
        bitmapData : IReadWriteBitmapData * 
        color : Color32 * 
        x1 : int * 
        y1 : int * 
        x2 : int * 
        y2 : int * 
        ?drawingOptions : DrawingOptions 
(* Defaults:
        let _drawingOptions = defaultArg drawingOptions null
*)
-> unit

Parameters

bitmapData IReadWriteBitmapData: The IReadWriteBitmapData instance to draw on.
color Color32: The color of the line to draw.
x1 Int32: The x-coordinate of the starting point.
y1 Int32: The y-coordinate of the starting point.
x2 Int32: The x-coordinate of the end point.
y2 Int32: The y-coordinate of the end point.
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

The right/bottom values of the coordinates are inclusive, so if the start and end points are the same, a single pixel will be drawn.

This method tries to use a shortcut to draw the line directly, which is faster than creating a Path and adding the line 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 line 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 BeginDrawLine or DrawLineAsync (in .NET Framework 4.0 and above) methods to perform the operation asynchronously.

Exceptions

ArgumentNullException	bitmapData is .
OverflowException	A Path is created internally and the width or height of Path.Bounds overflows.