The OpenVX Specification
r28647
|
Defines the Delay Object interface.
A Delay is an opaque object that contains a manually-controlled, temporally-delayed list of objects.
Typedefs | |
typedef struct _vx_delay * | vx_delay |
The delay object. This is like a ring buffer of objects that is maintained by the OpenVX implementation. More... | |
Enumerations | |
enum | vx_delay_attribute_e { VX_DELAY_ATTRIBUTE_TYPE = ((( VX_ID_KHRONOS ) << 20) | ( VX_TYPE_DELAY << 8)) + 0x0, VX_DELAY_ATTRIBUTE_COUNT = ((( VX_ID_KHRONOS ) << 20) | ( VX_TYPE_DELAY << 8)) + 0x1 } |
The delay attribute list. More... | |
Functions | |
vx_status | vxAgeDelay (vx_delay delay) |
Ages the internal delay ring by one. This means that once this API is called the reference from index 0 will go to index -1 and so forth until \( -count+1 \) is reached. This last object will become 0. Once the delay has been aged, it updates the reference in any associated nodes. More... | |
vx_delay | vxCreateDelay (vx_context context, vx_reference exemplar, vx_size count) |
Creates a Delay object. More... | |
vx_reference | vxGetReferenceFromDelay (vx_delay delay, vx_int32 index) |
Retrieves a reference from a delay object. More... | |
vx_status | vxQueryDelay (vx_delay delay, vx_enum attribute, void *ptr, vx_size size) |
Queries a vx_delay object attribute. More... | |
vx_status | vxReleaseDelay (vx_delay *delay) |
Releases a reference to a delay object. The object may not be garbage collected until its total reference count is zero. More... | |
typedef struct _vx_delay* vx_delay |
The delay object. This is like a ring buffer of objects that is maintained by the OpenVX implementation.
Definition at line 188 of file vx_types.h.
enum vx_delay_attribute_e |
The delay attribute list.
Enumerator | |
---|---|
VX_DELAY_ATTRIBUTE_TYPE |
The type of reference contained in the delay. Use a |
VX_DELAY_ATTRIBUTE_COUNT |
The number of items in the delay. Use a |
Definition at line 1110 of file vx_types.h.
Queries a vx_delay
object attribute.
[in] | delay | The coordinates object to set. |
[in] | attribute | The attribute to query. Use a vx_delay_attribute_e enumeration. |
[out] | ptr | The location at which to store the resulting value. |
[in] | size | The size of the container to which ptr points. |
vx_status_e
enumeration. Releases a reference to a delay object. The object may not be garbage collected until its total reference count is zero.
[in] | delay | The pointer to the delay to release. |
vx_status_e
enumeration. VX_SUCCESS | No errors. |
VX_ERROR_INVALID_REFERENCE | If graph is not a vx_graph . |
vx_delay vxCreateDelay | ( | vx_context | context, |
vx_reference | exemplar, | ||
vx_size | count | ||
) |
Creates a Delay object.
This function uses only the metadata from the exemplar, ignoring the object data. It does not alter the exemplar or keep or release the reference to the exemplar.
[in] | context | The reference to the system context. |
[in] | exemplar | The exemplar object. |
[in] | count | The number of reference in the delay. |
vx_delay
vx_reference vxGetReferenceFromDelay | ( | vx_delay | delay, |
vx_int32 | index | ||
) |
Retrieves a reference from a delay object.
[in] | delay | The reference to the delay object. |
[in] | index | An index into the delay from which to extract the reference. |
vx_reference
vxReleaseImage
). Use the vxReleaseDelay
only. Ages the internal delay ring by one. This means that once this API is called the reference from index 0 will go to index -1 and so forth until \( -count+1 \) is reached. This last object will become 0. Once the delay has been aged, it updates the reference in any associated nodes.
[in] | delay |
vx_status_e
enumeration. VX_SUCCESS | Delay was aged. |
VX_ERROR_INVALID_REFERENCE | The value passed as delay was not a vx_delay . |