TIOVX User Guide

The most basic type in the OpenVX system. Any type that inherits from tivx_reference_t must have a vx_reference_t as its first member to allow casting to this type. More...

#include <vx_reference.h>

Data Fields

uint32_t magic
 Magic code which confirms this is a reference.
 
vx_enum type
 Set to an enum value in vx_type_e.
 
vx_context context
 Pointer to the top level context. If this reference is the context, this will be NULL.
 
vx_reference scope
 The pointer to the object's scope parent. When virtual objects are scoped within a graph, this will point to that parent graph. This is left generic to allow future scoping variations. By default scope should be the same as context.
 
char name [VX_MAX_REFERENCE_NAME]
 Reference name.
 
vx_uint32 external_count
 The count of the number of users with this reference. When greater than 0, this can not be freed. When zero, the value can be considered inaccessible.
 
vx_uint32 internal_count
 The count of the number of framework references. When greater than 0, this can not be freed.
 
tivx_reference_callback_f mem_alloc_callback
 Object specific function that is called to allocate object memory.
 
tivx_reference_callback_f destructor_callback
 Object specific function that is called to destroy an object when reference count reaches zero.
 
tivx_reference_release_callback_f release_callback
 Object specific function that is called to release an object.
 
tivx_mutex lock
 Lock to take for the reference.
 
vx_bool is_virtual
 This indicates if the object is virtual or not.
 
vx_bool is_accessible
 Can this reference be accessed by user application Used for virtual reference's only.
 
vx_bool is_array_element
 Indicates that the object is an element of a pyramid or object array.
 
vx_bool is_allocated
 Is the buffer corresponding to this reference allocated This is only relevant to the data objects and will always be set to vx_false_e for non-data objects such as vx_graph, vx_node, vx_kernel, etc.
 
tivx_obj_desc_tobj_desc
 object descriptor
 

Detailed Description

The most basic type in the OpenVX system. Any type that inherits from tivx_reference_t must have a vx_reference_t as its first member to allow casting to this type.

Definition at line 63 of file vx_reference.h.


The documentation for this struct was generated from the following file: