F_VN_ResetRoi

F_VN_ResetRoi 1:

Reset the region of interest (ROI) of an image. (After this operation, the ROI is set to the entire image.)

Syntax

Definition:

FUNCTION F_VN_ResetRoi : HRESULT
VAR_INPUT
    ipImage : ITcVnImage;
    hrPrev  : HRESULT;
END_VAR

F_VN_ResetRoi 2: Inputs

Name

Type

Description

ipImage

ITcVnImage

Image

hrPrev

HRESULT

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

F_VN_ResetRoi 3: Return value

HRESULT

Further information

The function F_VN_ResetRoi resets the Region of Interest of an image. After executing the function, the ROI of the image is at the position [0, 0] and has the size [ImageWidth, ImageHeight].

Application

The resetting of an ROI looks like this, for example:

hr = F_VN_ResetRoi(ipImageWork, hr);

Related functions

Required License

TC3 Vision Base

System Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT V3.1.4024.54 or later

PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU

Tc3_Vision