OverlayLine

Description

Draws a line in the overlay.


Syntax

[VB]
objActiveGige.OverlayLine StartX, StartY, EndX, EndY [,Width = 1]

[C/C++]
HRESULT OverlayLine( short StartX, short StartY, short EndX, short EndY, short Width);


Data Types [VB]

StartX, StartY, EndX, EndY: Integer
Width: Integer (optional)


Parameters [C/C++]

StartX [in], StartY [in]

Pixel coordinates of the starting point of the line, relative to the image origin.

EndX [in], EndY [in]

Pixel coordinates of the end point of the line, relative to the image origin.

Width [in]

Width of the line in pixels.

Return Values

S_OK

Success

E_FAIL

Failure.

Example

The following VB example overlays a filled red line of width 3 on the live video:

ActiveGige1.Acquire = True
ActiveGige1.OverlayLine 100,100,200,200,3
ActiveGige1.OverlayColor=RGB(255,0,0)
ActiveGige1.Overlay=  True

Remarks

To draw multiple lines, call this method several times. Also see OverlayColor, OverlayClear.