F_VN_DrawLine

F_VN_DrawLine 1:

Draws a line.

Syntax

Definition:

FUNCTION F_VN_DrawLine : HRESULT
VAR_INPUT
    nX1         : UDINT;
    nY1         : UDINT;
    nX2         : UDINT;
    nY2         : UDINT;
    ipDestImage : ITcVnImage;
END_VAR
VAR_IN_OUT
    aColor      : TcVnVector4_LREAL;
END_VAR
VAR_INPUT
    nThickness  : DINT;
    hrPrev      : HRESULT;
END_VAR

F_VN_DrawLine 2: Inputs

Name

Type

Description

nX1

UDINT

x coordinate of the start point

nY1

UDINT

y coordinate of the start point

nX2

UDINT

x coordinate of the end point

nY2

UDINT

y coordinate of the end point

ipDestImage

ITcVnImage

Destination image

nThickness

DINT

Line thickness

hrPrev

HRESULT

HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

F_VN_DrawLine 3: In/Outputs

Name

Type

Description

aColor

TcVnVector4_LREAL

Color

F_VN_DrawLine 4: Return value

HRESULT

HRESULT

16#734

OUTOFRANGE

Part of the line lies outside of the image area. Use the function F_VN_ClipLineToBoundary_ITcVnImage to ensure that the specified line fits in the image area.

Required License

TC3 Vision Base

System Requirements