OpenVX ICD Extension  76df2d2
 All Functions Typedefs Groups Pages
OpenVX ICD Loader API

The OpenVX Installable Client Driver (ICD) Loader API. More...

Typedefs

typedef struct _vx_platform * vx_platform
 Platform handle of an implementation.
 

Functions

vx_context vxCreateContextFromPlatform (vx_platform platform)
 Creates a vx_context from a vx_platform. More...
 
vx_status vxIcdGetPlatforms (vx_size capacity, vx_platform platform[], vx_size *pNumItems)
 Queries list of available platforms. More...
 
vx_status vxQueryPlatform (vx_platform platform, vx_enum attribute, void *ptr, vx_size size)
 Queries the platform for some specific information. More...
 

Detailed Description

The OpenVX Installable Client Driver (ICD) Loader API.

The vx_khr_icd extension provides a mechanism for vendors to implement Installable Client Driver (ICD) for OpenVX. The OpenVX ICD Loader API provides a mechanism for applications to access these vendor implementations.

Function Documentation

vx_context vxCreateContextFromPlatform ( vx_platform  platform)

Creates a vx_context from a vx_platform.

This creates a top-level object context for OpenVX from a platform handle.

Returns
The reference to the implementation context vx_context. Any possible errors preventing a successful creation should be checked using vxGetStatus.
vx_status vxIcdGetPlatforms ( vx_size  capacity,
vx_platform  platform[],
vx_size *  pNumItems 
)

Queries list of available platforms.

Parameters
[in]capacityMaximum number of items that platform[] can hold.
[out]platform[]List of platform handles.
[out]pNumItemsNumber of platform handles returned.
Returns
A vx_status_e enumeration.
Return values
VX_SUCCESSNo errors.
VX_FAILUREIf no platforms are found.
vx_status vxQueryPlatform ( vx_platform  platform,
vx_enum  attribute,
void *  ptr,
vx_size  size 
)

Queries the platform for some specific information.

Parameters
[in]platformThe platform handle.
[in]attributeThe attribute to query. Use one of the following: VX_CONTEXT_VENDOR_ID, VX_CONTEXT_VERSION, VX_CONTEXT_EXTENSIONS_SIZE, VX_CONTEXT_EXTENSIONS.
[out]ptrThe location at which to store the resulting value.
[in]sizeThe size in bytes of the container to which ptr points.
Returns
A vx_status_e enumeration.
Return values
VX_SUCCESSNo errors.
VX_ERROR_INVALID_REFERENCEIf the platform is not a vx_platform.
VX_ERROR_INVALID_PARAMETERSIf any of the other parameters are incorrect.
VX_ERROR_NOT_SUPPORTEDIf the attribute is not supported on this implementation.