Object: Reference

Detailed Description

Defines the Reference Object interface.

All objects in OpenVX are derived (in the object-oriented sense) from vx_reference. All objects shall be able to be cast back to this type safely.

Typedefs
typedef struct _vx_reference *	vx_reference
	A generic opaque reference to any object within OpenVX. More...

Enumerations
enum	vx_reference_attribute_e {   VX_REF_ATTRIBUTE_COUNT = ((( VX_ID_KHRONOS ) << 20) | ( VX_TYPE_REFERENCE << 8)) + 0x0,   VX_REF_ATTRIBUTE_TYPE = ((( VX_ID_KHRONOS ) << 20) | ( VX_TYPE_REFERENCE << 8)) + 0x1 }
	The reference attributes list. More...

Functions
vx_status VX_API_CALL	vxQueryReference (vx_reference ref, vx_enum attribute, void *ptr, vx_size size)
	Queries any reference type for some basic information (count, type). More...

Typedef Documentation

typedef struct _vx_reference* vx_reference

A generic opaque reference to any object within OpenVX.

A user of OpenVX should not assume that this can be cast directly to anything; however, any object in OpenVX can be cast back to this for the purposes of querying attributes of the object or for passing the object as a parameter to functions that take a vx_reference type. If the API does not take that specific type but may take others, an error may be returned from the API.

Definition at line 134 of file vx_types.h.

Enumeration Type Documentation

enum vx_reference_attribute_e

The reference attributes list.

Enumerator
VX_REF_ATTRIBUTE_COUNT	Returns the reference count of the object. Use a vx_uint32 parameter.
VX_REF_ATTRIBUTE_TYPE	Returns the vx_type_e of the reference. Use a vx_enum parameter.

Definition at line 676 of file vx_types.h.

Function Documentation

vx_status VX_API_CALL vxQueryReference	(	vx_reference	ref,
		vx_enum	attribute,
		void *	ptr,
		vx_size	size
	)

Queries any reference type for some basic information (count, type).

Parameters

[in]	ref	The reference to query.
[in]	attribute	The value for which to query. Use vx_reference_attribute_e.
[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.