Object Array From List APIs

Detailed Description

APIs for creating an Object Array from List.

Functions
VX_API_ENTRY vx_object_array VX_API_CALL	tivxCreateObjectArrayFromList (vx_context context, vx_reference list[], vx_size count)
	Creates a reference to an ObjectArray of count objects which are uniform in type but can have non-uniform metadata. More...
VX_API_ENTRY vx_object_array VX_API_CALL	tivxCreateVirtualObjectArrayFromList (vx_graph graph, vx_reference list[], vx_size count)
	Creates an opaque reference to a virtual ObjectArray instantiated by a list with no direct user access. More...

Function Documentation

tivxCreateObjectArrayFromList()

VX_API_ENTRY vx_object_array VX_API_CALL tivxCreateObjectArrayFromList	(	vx_context	context,
		vx_reference	list[],
		vx_size	count
	)

Creates a reference to an ObjectArray of count objects which are uniform in type but can have non-uniform metadata.

This function allows an object array to be instantiated from an array of references passed through list[] parameter. It does not alter the references in the list nor keep or release this list. Internally, it modifies the additional attribute added with the extension, TIVX_OBJECT_ARRAY_IS_FROM_LIST.

Parameters

[in]	context	The reference to the overall Context.
[in]	list	An array of references that are to be stored in the object array. The type of the first reference in the list determines the type that will be enforced by the object array.
[in]	count	Number of references from the list parameter designated for the object array. Acceptable numbers are greater than 0 and less than TIVX_OBJECT_ARRAY_MAX_ITEMS.

Returns

An ObjectArray reference vx_object_array. Any possible errors preventing a successful creation should be checked using vxGetStatus.

tivxCreateVirtualObjectArrayFromList()

VX_API_ENTRY vx_object_array VX_API_CALL tivxCreateVirtualObjectArrayFromList	(	vx_graph	graph,
		vx_reference	list[],
		vx_size	count
	)

Creates an opaque reference to a virtual ObjectArray instantiated by a list with no direct user access.

This function creates an ObjectArray of count objects with similar behavior as tivxCreateObjectArrayFromList. The main difference is that the provided objects in the list must also be virtual in the given graph.

Parameters

[in]	graph	Reference to the graph where to create the virtual ObjectArray.
[in]	list	An array of references that are to be stored in the object array. The type of the first reference in the list determines the type that will be enforced by the object array. The references in the list must be virtual in the graph.
[in]	count	Number of references from the list parameter designated for the object array. Acceptable numbers are greater than 0 and less than TIVX_OBJECT_ARRAY_MAX_ITEMS.

Returns

An ObjectArray reference vx_object_array. Any possible errors preventing a successful creation should be checked using vxGetStatus.