Functions used to select ROIs. More...
Collaboration diagram for VL53L1 ROI Functions:
Functions | |
| VL53L1_Error | VL53L1_GetUserROI (VL53L1_DEV Dev, VL53L1_UserRoi_t *pUserROi) |
| Get the ROI managed by the Device. More... | |
| VL53L1_Error | VL53L1_SetUserROI (VL53L1_DEV Dev, VL53L1_UserRoi_t *pUserROi) |
| Set the ROI to be used for ranging. More... | |
Detailed Description
Functions used to select ROIs.
Function Documentation
◆ VL53L1_GetUserROI()
| VL53L1_Error VL53L1_GetUserROI | ( | VL53L1_DEV | Dev, |
| VL53L1_UserRoi_t * | pUserROi | ||
| ) |
Get the ROI managed by the Device.
- Function Description
- Get the ROI managed by the Device
- Parameters
-
Dev Device Handle pUserROi Pointer to the Structure definining the ROI
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1620 of file vl53l1_api.c.
◆ VL53L1_SetUserROI()
| VL53L1_Error VL53L1_SetUserROI | ( | VL53L1_DEV | Dev, |
| VL53L1_UserRoi_t * | pUserROi | ||
| ) |
Set the ROI to be used for ranging.
- Function Description
- The user defined ROI is a rectangle described as per the following system from the Top Left corner to the Bottom Right corner.
Minimal ROI size is 4x4 spads
- Parameters
-
Dev Device Handle pUserROi Pointer to the Structure definining the ROI
- Returns
- VL53L1_ERROR_NONE Success
- "Other error code" See VL53L1_Error
Definition at line 1597 of file vl53l1_api.c.