An opaque array object that could be an array of any data-object (not data-type) of OpenVX except Delay and ObjectArray objects.
ObjectArray is a strongly-typed container of OpenVX data-objects. ObjectArray refers to the collection of similar data-objects as a single entity that can be created or assigned as inputs/outputs and as a single entity. In addition, a single object from the collection can be accessed individually by getting its reference. The single object remains as part of the ObjectArray through its entire life cycle.
|
typedef struct _vx_object_array * | vx_object_array |
| The ObjectArray Object. ObjectArray is a strongly-typed container of OpenVX data-objects.
|
|
◆ vxCreateObjectArray()
Creates a reference to an ObjectArray of count objects.
It uses the metadata of the exemplar to determine the object attributes [R01292], ignoring the object data [R01293]. It does not alter the exemplar [R01294] or keep or release the reference to the exemplar [R01295]. For the definition of supported attributes see vxSetMetaFormatAttribute
. In case the exemplar is a virtual object it must be of immutable metadata, thus it is not allowed to be dimensionless or formatless [R01296].
- Parameters
-
[in] | context | The reference to the overall Context [R01297]. |
[in] | exemplar | The exemplar object that defines the metadata of the created objects in the ObjectArray [R01298]. |
[in] | count | Number of Objects to create in the ObjectArray [R01299]. |
- Returns
- An ObjectArray reference
vx_object_array
[R01300]. Any possible errors preventing a successful creation should be checked using vxGetStatus
. Data objects are not initialized by this function.
◆ vxCreateVirtualObjectArray()
Creates an opaque reference to a virtual ObjectArray with no direct user access.
This function creates an ObjectArray of count objects with similar behavior as vxCreateObjectArray
[R01301]. The only difference is that the objects that are created are virtual in the given graph.
- Parameters
-
[in] | graph | Reference to the graph where to create the virtual ObjectArray [R01302]. |
[in] | exemplar | The exemplar object that defines the type of object in the ObjectArray [R01303]. Only exemplar type of vx_image , vx_array and vx_pyramid are allowed [R01304]. |
[in] | count | Number of Objects to create in the ObjectArray [R01305]. |
- Returns
- A ObjectArray reference
vx_object_array
[R01306]. Any possible errors preventing a successful creation should be checked using vxGetStatus
.
◆ vxGetObjectArrayItem()
Retrieves the reference to the OpenVX Object in location index of the ObjectArray [R01307].
This is a vx_reference, which can be used elsewhere in OpenVX. A call to vxRelease<Object> or vxReleaseReference
is necessary to release the Object for each call to this function.
- Parameters
-
[in] | arr | The ObjectArray [R01308]. |
[in] | index | The index of the object in the ObjectArray [R01309]. |
- Returns
- A reference to an OpenVX data object [R01310]. Any possible errors preventing a successful completion of the function should be checked using
vxGetStatus
[R01311].
◆ vxReleaseObjectArray()
Releases a reference of an ObjectArray object [R01312].
The object may not be garbage collected until its total reference and its contained objects count is zero. After returning from this function the reference is zeroed/cleared [R01313].
- Parameters
-
[in] | arr | The pointer to the ObjectArray to release [R01314]. |
- Returns
- A
The vx_status Constants
value.
- Return values
-
VX_SUCCESS | No errors; any other value indicates failure [R01315]. |
VX_ERROR_INVALID_REFERENCE | arr is not a valid vx_object_array reference. |
◆ vxQueryObjectArray()
Queries an atribute from the ObjectArray [R01316].
- Parameters
-
[in] | arr | The reference to the ObjectArray [R01317]. |
[in] | attribute | The attribute to query [R01318]. Use a The ObjectArray object attributes. value. |
[out] | ptr | The location at which to store the resulting value [R01319]. |
[in] | size | The size in bytes of the container to which ptr points [R01320]. |
- Returns
- A
The vx_status Constants
value.
- Return values
-
VX_SUCCESS | No errors; any other value indicates failure [R01321]. |
VX_ERROR_INVALID_REFERENCE | arr is not a valid vx_object_array reference. |
VX_ERROR_NOT_SUPPORTED | If the attribute is not a value supported on this implementation. |
VX_ERROR_INVALID_PARAMETERS | If any of the other parameters are incorrect. |