Extension: 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_API_ENTRY vx_status VX_API_CALL	vxIcdGetPlatforms (vx_size capacity, vx_platform platform[], vx_size *pNumItems)
	Queries list of available platforms.
VX_API_ENTRY vx_status VX_API_CALL	vxQueryPlatform (vx_platform platform, vx_enum attribute, void *ptr, vx_size size)
	Queries the platform for some specific information.
VX_API_ENTRY vx_context VX_API_CALL	vxCreateContextFromPlatform (vx_platform platform)
	Creates a vx_context from a vx_platform.

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.

Typedef Documentation

vx_platform

typedef struct _vx_platform* vx_platform

#include <vx_khr_icd.h>

Platform handle of an implementation.

Function Documentation

vxCreateContextFromPlatform()

VX_API_ENTRY vx_context VX_API_CALL vxCreateContextFromPlatform

(

vx_platform

platform

)

#include <vx_khr_icd.h>

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.

vxIcdGetPlatforms()

VX_API_ENTRY vx_status VX_API_CALL vxIcdGetPlatforms	(	vx_size	capacity,
		vx_platform	platform[],
		vx_size *	pNumItems )

#include <vx_khr_icd.h>

Queries list of available platforms.

Parameters

[in]	capacity	Maximum number of items that platform[] can hold.
[out]	platform[]	List of platform handles.
[out]	pNumItems	Number of platform handles returned.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	No errors.
VX_FAILURE	If no platforms are found.

vxQueryPlatform()

VX_API_ENTRY vx_status VX_API_CALL vxQueryPlatform	(	vx_platform	platform,
		vx_enum	attribute,
		void *	ptr,
		vx_size	size )

#include <vx_khr_icd.h>

Queries the platform for some specific information.

Parameters

[in]	platform	The platform handle.
[in]	attribute	The attribute to query. Use one of the following: VX_CONTEXT_VENDOR_ID, VX_CONTEXT_VERSION, VX_CONTEXT_EXTENSIONS_SIZE, VX_CONTEXT_EXTENSIONS.
[out]	ptr	The location at which to store the resulting value.
[in]	size	The size in bytes of the container to which ptr points.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	No errors.
VX_ERROR_INVALID_REFERENCE	If the platform is not a vx_platform.
VX_ERROR_INVALID_PARAMETERS	If any of the other parameters are incorrect.
VX_ERROR_NOT_SUPPORTED	If the attribute is not supported on this implementation.