F_VN_ResetRoi
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
Inputs
|
Name |
Type |
Description |
|---|---|---|
|
ipImage |
Image | |
|
hrPrev |
HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.) |
Return valueFurther 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
- F_VN_SetRoi for setting a Region of Interest
- F_VN_GetRoi for retrieving the set Region of Interest
- F_VN_ResetRoi for resetting the Region of Interest on the entire image
- F_VN_CopyImageRegion for copying an image region
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 |