The OpenVX Specification  r31169
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Framework: Hints

Detailed Description

Defines the Hints Interface.

Hints are messages given to the OpenVX implementation that it may support. (These are optional.)

Enumerations

enum  vx_hint_e { VX_HINT_SERIALIZE = ((( VX_ID_KHRONOS ) << 20) | ( VX_ENUM_HINT << 12)) + 0x0 }
 These enumerations are given to the vxHint API to enable/disable platform optimizations and/or features. Hints are optional and usually are vendor-specific. More...
 

Functions

vx_status VX_API_CALL vxHint (vx_reference reference, vx_enum hint)
 Provides a generic API to give platform-specific hints to the implementation. More...
 

Enumeration Type Documentation

enum vx_hint_e

These enumerations are given to the vxHint API to enable/disable platform optimizations and/or features. Hints are optional and usually are vendor-specific.

See also
vxHint
Enumerator
VX_HINT_SERIALIZE 

Indicates to the implementation that the user wants to disable any parallelization techniques. Implementations may not be parallelized, so this is a hint only.

Definition at line 572 of file vx_types.h.

Function Documentation

vx_status VX_API_CALL vxHint ( vx_reference  reference,
vx_enum  hint 
)

Provides a generic API to give platform-specific hints to the implementation.

Parameters
[in]referenceThe reference to the object to hint at. This could be vx_context, vx_graph, vx_node, vx_image, vx_array, or any other reference.
[in]hintA vx_hint_e hint to give the OpenVX context. This is a platform-specific optimization or implementation mechanism.
Returns
A vx_status_e enumeration.
Return values
VX_SUCCESSNo error.
VX_ERROR_INVALID_REFERENCEIf context or reference is invalid.
VX_ERROR_NOT_SUPPORTEDIf the hint is not supported.