Framework: Hints

Detailed Description

Defines the Hints Interface.

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

Modules
	VX_HINT Values
	Values provided to the vxHint API to enable/disable platform optimizations and/or features. Hints are optional and usually are vendor-specific.

Functions
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. More...

Function Documentation

vxHint()

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.

Parameters

[in]	reference	The reference to the object to hint at [R00464]. This could be vx_context, vx_graph, vx_node, vx_image, vx_array, or any other reference.
[in]	hint	A VX_HINT Values hint to give to a vx_context [R00465]. This is a platform-specific optimization or implementation mechanism.
[in]	data	Optional vendor specific data [R00466].
[in]	data_size	Size of the data structure data [R00467].

Returns

A The vx_status Constants value.

Return values

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