AMD rocAL - Info API#
API: AMD rocAL - Info API
The AMD rocAL Informational functions. More...
Functions | |
| int ROCAL_API_CALL | rocalGetOutputWidth (RocalContext rocal_context) |
| Retrieves the width of the output. More... | |
| int ROCAL_API_CALL | rocalGetOutputHeight (RocalContext rocal_context) |
| Retrieves the height of the output. More... | |
| int ROCAL_API_CALL | rocalGetOutputColorFormat (RocalContext rocal_context) |
| Retrieves the color format of the output. More... | |
| size_t ROCAL_API_CALL | rocalGetRemainingImages (RocalContext rocal_context) |
| Retrieves the number of remaining images. More... | |
| size_t ROCAL_API_CALL | rocalGetImageWidth (RocalTensor image) |
| Retrieves the width of the image. More... | |
| size_t ROCAL_API_CALL | rocalGetImageHeight (RocalTensor image) |
| Retrieves the height of the image. More... | |
| size_t ROCAL_API_CALL | rocalGetImagePlanes (RocalTensor image) |
| Retrieves the number of planes (channels) in the image. More... | |
| size_t ROCAL_API_CALL | rocalIsEmpty (RocalContext rocal_context) |
| Checks if the RocalContext is empty. More... | |
| size_t ROCAL_API_CALL | rocalGetAugmentationBranchCount (RocalContext rocal_context) |
| Retrieves the number of augmentation branches. More... | |
| RocalStatus ROCAL_API_CALL | rocalGetStatus (RocalContext rocal_context) |
| Retrieves the status. More... | |
| const char *ROCAL_API_CALL | rocalGetErrorMessage (RocalContext rocal_context) |
| Retrieves the error message. More... | |
| TimingInfo ROCAL_API_CALL | rocalGetTimingInfo (RocalContext rocal_context) |
| Retrieves timing information. More... | |
Detailed Description
The AMD rocAL Informational functions.
Function Documentation
◆ rocalGetAugmentationBranchCount()
| size_t ROCAL_API_CALL rocalGetAugmentationBranchCount | ( | RocalContext | rocal_context | ) |
Retrieves the number of augmentation branches.
- Parameters
-
[in] rocal_context The RocalContext
- Returns
- Number of augmentation graph branches. Defined by number of calls to the augmentation API's with the is_output flag set to true.
◆ rocalGetErrorMessage()
| const char* ROCAL_API_CALL rocalGetErrorMessage | ( | RocalContext | rocal_context | ) |
Retrieves the error message.
- Parameters
-
[in] rocal_context The RocalContext
- Returns
- A pointer to the error message string.
◆ rocalGetImageHeight()
| size_t ROCAL_API_CALL rocalGetImageHeight | ( | RocalTensor | image | ) |
Retrieves the height of the image.
- Parameters
-
[in] image The RocalTensor data.
- Returns
- The height of the image.
◆ rocalGetImagePlanes()
| size_t ROCAL_API_CALL rocalGetImagePlanes | ( | RocalTensor | image | ) |
Retrieves the number of planes (channels) in the image.
- Parameters
-
[in] image The RocalTensor data.
- Returns
- The number of planes (channels) in the image.
◆ rocalGetImageWidth()
| size_t ROCAL_API_CALL rocalGetImageWidth | ( | RocalTensor | image | ) |
Retrieves the width of the image.
- Parameters
-
[in] image The RocalTensor data.
- Returns
- The width of the image.
◆ rocalGetOutputColorFormat()
| int ROCAL_API_CALL rocalGetOutputColorFormat | ( | RocalContext | rocal_context | ) |
Retrieves the color format of the output.
- Parameters
-
[in] rocal_context The RocalContext.
- Returns
- The color format of the output.
◆ rocalGetOutputHeight()
| int ROCAL_API_CALL rocalGetOutputHeight | ( | RocalContext | rocal_context | ) |
Retrieves the height of the output.
- Parameters
-
[in] rocal_context The RocalContext
- Returns
- The height of the output.
◆ rocalGetOutputWidth()
| int ROCAL_API_CALL rocalGetOutputWidth | ( | RocalContext | rocal_context | ) |
Retrieves the width of the output.
- Parameters
-
[in] rocal_context The RocalContext
- Returns
- The width of the output.
◆ rocalGetRemainingImages()
| size_t ROCAL_API_CALL rocalGetRemainingImages | ( | RocalContext | rocal_context | ) |
Retrieves the number of remaining images.
- Parameters
-
[in] rocal_context The RocalContext.
- Returns
- The number of remaining images yet to be processed.
◆ rocalGetStatus()
| RocalStatus ROCAL_API_CALL rocalGetStatus | ( | RocalContext | rocal_context | ) |
Retrieves the status.
- Parameters
-
[in] rocal_context The RocalContext from which to retrieve the status.
- Returns
- The status of tha last API call
◆ rocalGetTimingInfo()
| TimingInfo ROCAL_API_CALL rocalGetTimingInfo | ( | RocalContext | rocal_context | ) |
Retrieves timing information.
- Parameters
-
[in] rocal_context The RocalContext
- Returns
- The timing info associated with recent execution.
◆ rocalIsEmpty()
| size_t ROCAL_API_CALL rocalIsEmpty | ( | RocalContext | rocal_context | ) |
Checks if the RocalContext is empty.
- Parameters
-
[in] rocal_context The RocalContext
- Returns
- return if RocalContext is empty or not.