User Facing Directive API

The Public Directive API. More...

Enumerations
enum	vx_directive_e {   VX_DIRECTIVE_DISABLE_LOGGING = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_DIRECTIVE) + 0x0 ,   VX_DIRECTIVE_ENABLE_LOGGING = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_DIRECTIVE) + 0x1 ,   VX_DIRECTIVE_DISABLE_PERFORMANCE = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_DIRECTIVE) + 0x2 ,   VX_DIRECTIVE_ENABLE_PERFORMANCE = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_DIRECTIVE) + 0x3 }
	These enumerations are given to the vxDirective API to enable/disable platform optimizations and/or features. Directives are not optional and usually are vendor-specific, by defining a vendor range of directives and starting their enumeration from there. More...

Functions
VX_API_ENTRY vx_status VX_API_CALL	vxDirective (vx_reference reference, vx_enum directive)
	Provides a generic API to give platform-specific directives to the implementations.

Detailed Description

The Public Directive API.

Enumeration Type Documentation

vx_directive_e

enum vx_directive_e

#include <vx_types.h>

These enumerations are given to the vxDirective API to enable/disable platform optimizations and/or features. Directives are not optional and usually are vendor-specific, by defining a vendor range of directives and starting their enumeration from there.

See also

vxDirective

Enumerator
VX_DIRECTIVE_DISABLE_LOGGING	Disables recording information for graph debugging.
VX_DIRECTIVE_ENABLE_LOGGING	Enables recording information for graph debugging.
VX_DIRECTIVE_DISABLE_PERFORMANCE	Disables performance counters for the context. By default performance counters are disabled.
VX_DIRECTIVE_ENABLE_PERFORMANCE	Enables performance counters for the context.

Function Documentation

vxDirective()

VX_API_ENTRY vx_status VX_API_CALL vxDirective	(	vx_reference	reference,
		vx_enum	directive )

#include <vx_api.h>

Provides a generic API to give platform-specific directives to the implementations.

Parameters

[in]	reference	The reference to the object to set the directive on. This could be vx_context, vx_graph, vx_node, vx_image, vx_array, or any other reference.
[in]	directive	The directive to set. See vx_directive_e.

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 directive is not supported.

Note

The performance counter directives are only available for the reference vx_context. Error VX_ERROR_NOT_SUPPORTED is returned when used with any other reference.