User Facing Hint API

The Public Hint API. More...

Enumerations
enum	vx_hint_e {   VX_HINT_PERFORMANCE_DEFAULT = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_HINT) + 0x1 ,   VX_HINT_PERFORMANCE_LOW_POWER = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_HINT) + 0x2 ,   VX_HINT_PERFORMANCE_HIGH_SPEED = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_HINT) + 0x3 }
	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_API_ENTRY vx_status VX_API_CALL	vxHint (vx_reference reference, vx_enum hint, const void *data, vx_size data_size)
	Provides a generic API to give platform-specific hints to the implementation.

Detailed Description

The Public Hint API.

Enumeration Type Documentation

vx_hint_e

enum vx_hint_e

#include <vx_types.h>

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_PERFORMANCE_DEFAULT	Indicates to the implementation that user do not apply any specific requirements for performance.
VX_HINT_PERFORMANCE_LOW_POWER	Indicates the user preference is low power consumption versus highest performance.
VX_HINT_PERFORMANCE_HIGH_SPEED	Indicates the user preference for highest performance over low power consumption.

Function Documentation

vxHint()

VX_API_ENTRY vx_status VX_API_CALL vxHint	(	vx_reference	reference,
		vx_enum	hint,
		const void *	data,
		vx_size	data_size )

#include <vx_api.h>

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

Parameters

[in]	reference	The 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]	hint	A vx_hint_e hint to give to a vx_context. This is a platform-specific optimization or implementation mechanism.
[in]	data	Optional vendor specific data.
[in]	data_size	Size of the data structure data.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	No errors; any other value indicates failure.
VX_ERROR_INVALID_REFERENCE	reference is not a valid vx_reference reference.
VX_ERROR_NOT_SUPPORTED	If the hint is not supported.