Mech-Eye API 2.3.3
API reference documentation for Mech-Eye Industrial 3D Camera
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
mmind::eye::ROI Struct Reference

Describes a region of interest (ROI). More...

#include <CommonTypes.h>

Public Member Functions

constexpr ROI (unsigned upperLeftX, unsigned upperLeftY, size_t width, size_t height)
 
bool operator== (const ROI &other)
 

Public Attributes

unsigned upperLeftX
 The column coordinate of the upper-left corner of the ROI.
 
unsigned upperLeftY
 The row coordinate of the upper-left corner of the ROI.
 
size_t width
 
size_t height
 

Detailed Description

Describes a region of interest (ROI).

Definition at line 34 of file CommonTypes.h.

Constructor & Destructor Documentation

◆ ROI() [1/2]

constexpr mmind::eye::ROI::ROI ( )
inlineconstexpr

Definition at line 36 of file CommonTypes.h.

◆ ROI() [2/2]

constexpr mmind::eye::ROI::ROI ( unsigned upperLeftX,
unsigned upperLeftY,
size_t width,
size_t height )
inlineconstexpr

Definition at line 37 of file CommonTypes.h.

Member Function Documentation

◆ operator==()

bool mmind::eye::ROI::operator== ( const ROI & other)
inline

Definition at line 41 of file CommonTypes.h.

Member Data Documentation

◆ height

size_t mmind::eye::ROI::height

Definition at line 46 of file CommonTypes.h.

◆ upperLeftX

unsigned mmind::eye::ROI::upperLeftX

The column coordinate of the upper-left corner of the ROI.

Definition at line 43 of file CommonTypes.h.

◆ upperLeftY

unsigned mmind::eye::ROI::upperLeftY

The row coordinate of the upper-left corner of the ROI.

Definition at line 44 of file CommonTypes.h.

◆ width

size_t mmind::eye::ROI::width

Definition at line 45 of file CommonTypes.h.


The documentation for this struct was generated from the following file: