/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/docs-6.1.2/rocAL/include/api/rocal_api_info.h Source File

• rocAL
• include
• api

rocal_api_info.h

Go to the documentation of this file.

1 /*

2 Copyright (c) 2019 - 2023 Advanced Micro Devices, Inc. All rights reserved.

3 

4 Permission is hereby granted, free of charge, to any person obtaining a copy

5 of this software and associated documentation files (the "Software"), to deal

6 in the Software without restriction, including without limitation the rights

7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

8 copies of the Software, and to permit persons to whom the Software is

9 furnished to do so, subject to the following conditions:

10 

11 The above copyright notice and this permission notice shall be included in

12 all copies or substantial portions of the Software.

13 

14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

20 THE SOFTWARE.

21 */

22 

23 #ifndef MIVISIONX_ROCAL_API_INFO_H

24 #define MIVISIONX_ROCAL_API_INFO_H

25 #include "rocal_api_types.h"

26 

41 extern "C" int ROCAL_API_CALL rocalGetOutputWidth(RocalContext rocal_context);

42 

49 extern "C" int ROCAL_API_CALL rocalGetOutputHeight(RocalContext rocal_context);

50 

57 extern "C" int ROCAL_API_CALL rocalGetOutputColorFormat(RocalContext rocal_context);

58 

66 extern "C" size_t ROCAL_API_CALL rocalGetRemainingImages(RocalContext rocal_context);

67 

74 extern "C" size_t ROCAL_API_CALL rocalGetImageWidth(RocalTensor image);

75 

82 extern "C" size_t ROCAL_API_CALL rocalGetImageHeight(RocalTensor image);

83 

90 extern "C" size_t ROCAL_API_CALL rocalGetImagePlanes(RocalTensor image);

91 

98 extern "C" size_t ROCAL_API_CALL rocalIsEmpty(RocalContext rocal_context);

99 

106 extern "C" size_t ROCAL_API_CALL rocalGetAugmentationBranchCount(RocalContext rocal_context);

107 

114 extern "C" RocalStatus ROCAL_API_CALL rocalGetStatus(RocalContext rocal_context);

115 

122 extern "C" const char* ROCAL_API_CALL rocalGetErrorMessage(RocalContext rocal_context);

123 

130 extern "C" TimingInfo ROCAL_API_CALL rocalGetTimingInfo(RocalContext rocal_context);

131 

138 extern "C" size_t ROCAL_API_CALL rocalGetLastBatchPaddedSize(RocalContext rocal_context);

139 

140 #endif // MIVISIONX_ROCAL_API_INFO_H

rocalGetTimingInfo

TimingInfo ROCAL_API_CALL rocalGetTimingInfo(RocalContext rocal_context)

Retrieves timing information.

rocalGetErrorMessage

const char *ROCAL_API_CALL rocalGetErrorMessage(RocalContext rocal_context)

Retrieves the error message.

rocalGetImageHeight

size_t ROCAL_API_CALL rocalGetImageHeight(RocalTensor image)

Retrieves the height of the image.

rocalGetRemainingImages

size_t ROCAL_API_CALL rocalGetRemainingImages(RocalContext rocal_context)

Retrieves the number of remaining images.

rocalGetOutputWidth

int ROCAL_API_CALL rocalGetOutputWidth(RocalContext rocal_context)

Retrieves the width of the output.

rocalGetOutputColorFormat

int ROCAL_API_CALL rocalGetOutputColorFormat(RocalContext rocal_context)

Retrieves the color format of the output.

rocalGetAugmentationBranchCount

size_t ROCAL_API_CALL rocalGetAugmentationBranchCount(RocalContext rocal_context)

Retrieves the number of augmentation branches.

rocalGetOutputHeight

int ROCAL_API_CALL rocalGetOutputHeight(RocalContext rocal_context)

Retrieves the height of the output.

rocalGetImagePlanes

size_t ROCAL_API_CALL rocalGetImagePlanes(RocalTensor image)

Retrieves the number of planes (channels) in the image.

rocalGetImageWidth

size_t ROCAL_API_CALL rocalGetImageWidth(RocalTensor image)

Retrieves the width of the image.

rocalGetStatus

RocalStatus ROCAL_API_CALL rocalGetStatus(RocalContext rocal_context)

Retrieves the status.

rocalIsEmpty

size_t ROCAL_API_CALL rocalIsEmpty(RocalContext rocal_context)

Checks if the RocalContext is empty.

rocalGetLastBatchPaddedSize

size_t ROCAL_API_CALL rocalGetLastBatchPaddedSize(RocalContext rocal_context)

Retrieves the information about the size of the last batch.

RocalStatus

RocalStatus

rocAL Status enum

Definition: rocal_api_types.h:112

RocalContext

void * RocalContext

typedef void* rocAL Context

Definition: rocal_api_types.h:63

rocal_api_types.h

The AMD rocAL Library - Types.

ROCAL_API_CALL

#define ROCAL_API_CALL

Definition: rocal_api_types.h:35

TimingInfo

Timing Info struct.

Definition: rocal_api_types.h:79