AMD rocAL - Info API

Functions

API: AMD rocAL - Info API

The AMD rocAL Informational functions. More...

Functions
int ROCAL_API_CALL	rocalGetOutputWidth (RocalContext rocal_context)
	rocalGetOutputWidth More...
int ROCAL_API_CALL	rocalGetOutputHeight (RocalContext rocal_context)
	rocalGetOutputHeight More...
int ROCAL_API_CALL	rocalGetOutputColorFormat (RocalContext rocal_context)
	rocalGetOutputColorFormat More...
size_t ROCAL_API_CALL	rocalGetRemainingImages (RocalContext rocal_context)
	rocalGetRemainingImages More...
size_t ROCAL_API_CALL	rocalGetImageWidth (RocalImage image)
	rocalGetImageWidth More...
size_t ROCAL_API_CALL	rocalGetImageHeight (RocalImage image)
	rocalGetImageHeight More...
size_t ROCAL_API_CALL	rocalGetImagePlanes (RocalImage image)
	rocalGetImagePlanes More...
size_t ROCAL_API_CALL	rocalIsEmpty (RocalContext rocal_context)
	rocalIsEmpty More...
size_t ROCAL_API_CALL	rocalGetAugmentationBranchCount (RocalContext rocal_context)
	rocalGetAugmentationBranchCount More...
RocalStatus ROCAL_API_CALL	rocalGetStatus (RocalContext rocal_context)
	rocalGetStatus More...
const char *ROCAL_API_CALL	rocalGetErrorMessage (RocalContext rocal_context)
	rocalGetErrorMessage More...
TimingInfo ROCAL_API_CALL	rocalGetTimingInfo (RocalContext rocal_context)
	rocalGetTimingInfo More...

Detailed Description

The AMD rocAL Informational functions.

Function Documentation

◆ rocalGetAugmentationBranchCount()

size_t ROCAL_API_CALL rocalGetAugmentationBranchCount

(

RocalContext

rocal_context

)

rocalGetAugmentationBranchCount

Parameters

[in]

context

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

)

rocalGetErrorMessage

Parameters

[in]

context

Returns

The last error message generated by call to rocal API

◆ rocalGetImageHeight()

size_t ROCAL_API_CALL rocalGetImageHeight

(

RocalImage

image

)

rocalGetImageHeight

Parameters

[in]

image

Returns

Height of the pipeline output image, includes all images in the batch

Note

Returned value valid only after rocalVerify is called

◆ rocalGetImagePlanes()

size_t ROCAL_API_CALL rocalGetImagePlanes

(

RocalImage

image

)

rocalGetImagePlanes

Parameters

[in]

image

Returns

Color format of the pipeline output image.

Note

Returned value valid only after rocalVerify is called

◆ rocalGetImageWidth()

size_t ROCAL_API_CALL rocalGetImageWidth

(

RocalImage

image

)

rocalGetImageWidth

Parameters

[in]

image

Returns

Width of the graph output image

Note

Returned value valid only after rocalVerify is called

◆ rocalGetOutputColorFormat()

int ROCAL_API_CALL rocalGetOutputColorFormat

(

RocalContext

rocal_context

)

rocalGetOutputColorFormat

Parameters

[in]

context

Returns

The color format of the ROCAL's output. It's equivalent of what's passed to the loaders as input color format.

◆ rocalGetOutputHeight()

int ROCAL_API_CALL rocalGetOutputHeight

(

RocalContext

rocal_context

)

rocalGetOutputHeight

Parameters

[in]

context

Returns

The height of the ROCAL's output image in pixels. It includes all images in the batch.

◆ rocalGetOutputWidth()

int ROCAL_API_CALL rocalGetOutputWidth

(

RocalContext

rocal_context

)

rocalGetOutputWidth

Parameters

[in]

context

Returns

The width of the ROCAL's output image in pixels

◆ rocalGetRemainingImages()

size_t ROCAL_API_CALL rocalGetRemainingImages

(

RocalContext

rocal_context

)

rocalGetRemainingImages

Parameters

[in]

context

Returns

The number of images yet to be processed

◆ rocalGetStatus()

RocalStatus ROCAL_API_CALL rocalGetStatus

(

RocalContext

rocal_context

)

rocalGetStatus

Parameters

[in]

context

Returns

The status of tha last API call

◆ rocalGetTimingInfo()

TimingInfo ROCAL_API_CALL rocalGetTimingInfo

(

RocalContext

rocal_context

)

rocalGetTimingInfo

Parameters

[in]

context

Returns

The timing info associated with recent execution.

◆ rocalIsEmpty()

size_t ROCAL_API_CALL rocalIsEmpty

(

RocalContext

rocal_context

)

rocalIsEmpty

Parameters

[in]

context

Returns

1 if all images have been processed, otherwise 0

Note

Returned value valid only after rocalVerify is called