Extension: XML API

The Khronos Extension for OpenVX XML Import and Export Support. More...

Enumerations
enum	vx_ext_import_type_e { VX_TYPE_IMPORT = 0x814 }
	The Object Type Enumeration for Imports. More...
enum	vx_ext_import_types_e { VX_IMPORT_TYPE_XML = 0 }
	The import type enumeration. More...
enum	vx_import_attribute_e {   VX_IMPORT_ATTRIBUTE_COUNT = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_IMPORT) + 0x0 ,   VX_IMPORT_ATTRIBUTE_TYPE = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_IMPORT) + 0x1 }
	The import attributes list. More...

Functions
VX_API_ENTRY vx_status VX_API_CALL	vxExportToXML (vx_context context, vx_char xmlfile[])
	Exports all objects in the context to an XML file which uses the OpenVX XML Schema.
VX_API_ENTRY vx_import VX_API_CALL	vxImportFromXML (vx_context context, vx_char xmlfile[])
	Imports all framework and data objects from an XML file into the given context.
VX_API_ENTRY vx_reference VX_API_CALL	vxGetImportReferenceByName (vx_import import, const vx_char *name)
	Used to retrieve a reference by name from the import when the name is known beforehand. If multiple references have the same name, then any one of them may be returned.
VX_API_ENTRY vx_reference VX_API_CALL	vxGetImportReferenceByIndex (vx_import import, vx_uint32 index)
	Used to retrieve a reference by the index from the import.
VX_API_ENTRY vx_status VX_API_CALL	vxQueryImport (vx_import import, vx_enum attribute, void *ptr, vx_size size)
	Used to query the import about its properties.
VX_API_ENTRY vx_status VX_API_CALL	vxReleaseImport (vx_import *import)
	Releases a reference to an import object. Also internally releases its references to its imported objects. These imported objects may not be garbage collected until their total reference counts are zero.

Detailed Description

The Khronos Extension for OpenVX XML Import and Export Support.

Enumeration Type Documentation

vx_ext_import_type_e

enum vx_ext_import_type_e

#include <vx_khr_xml.h>

The Object Type Enumeration for Imports.

Enumerator
VX_TYPE_IMPORT	A vx_import

vx_ext_import_types_e

enum vx_ext_import_types_e

#include <vx_khr_xml.h>

The import type enumeration.

See also

VX_IMPORT_ATTRIBUTE_TYPE

Enumerator
VX_IMPORT_TYPE_XML	The XML import type.

vx_import_attribute_e

enum vx_import_attribute_e

#include <vx_khr_xml.h>

The import attributes list.

See also

vxQueryImport

Enumerator
VX_IMPORT_ATTRIBUTE_COUNT	Returns the number of references in the import object. Use a vx_uint32 parameter.
VX_IMPORT_ATTRIBUTE_TYPE	Returns the type of import. Use a vx_ext_import_types_e parameter.

Function Documentation

vxExportToXML()

VX_API_ENTRY vx_status VX_API_CALL vxExportToXML	(	vx_context	context,
		vx_char	xmlfile[] )

#include <vx_khr_xml.h>

Exports all objects in the context to an XML file which uses the OpenVX XML Schema.

Parameters

[in]	context	The context to export.
[in]	xmlfile	The file name to write the XML into.

Note

The reference numbers contained in the xml file can appear in any order but should be inclusive from index number 0 to [number of references - 1]. For example, if there are 20 references in the xml file, none of the reference indices should be >= 20.

Returns

A vx_status_e enumeration.

See also

https://www.khronos.org/registry/vx/schema/openvx-1-1.xsd

vxGetImportReferenceByIndex()

VX_API_ENTRY vx_reference VX_API_CALL vxGetImportReferenceByIndex	(	vx_import	import,
		vx_uint32	index )

#include <vx_khr_xml.h>

Used to retrieve a reference by the index from the import.

Parameters

[in]	import	The reference to the import object.
[in]	index	The index of the reference in the import object to return.

Returns

vx_reference

Return values

0	Invalid import object or index.
*	The reference at the requested index number.

Note

Use vxQueryImport with VX_IMPORT_ATTRIBUTE_COUNT to retrieve the upper limit of references in the import.

Use vxReleaseReference to release the reference before releasing the context.

Precondition

vxImportFromXML

vxGetImportReferenceByName()

VX_API_ENTRY vx_reference VX_API_CALL vxGetImportReferenceByName	(	vx_import	import,
		const vx_char *	name )

#include <vx_khr_xml.h>

Used to retrieve a reference by name from the import when the name is known beforehand. If multiple references have the same name, then any one of them may be returned.

Parameters

[in]	import	The reference to the import object.
[in]	name	The reference string name.

Returns

vx_reference

Return values

0	Invalid import object or name does not match a reference in the import object.
*	The reference matching the requested name.

Note

Use vxReleaseReference to release the reference before releasing the context.

Precondition

vxImportFromXML

vxImportFromXML()

VX_API_ENTRY vx_import VX_API_CALL vxImportFromXML	(	vx_context	context,
		vx_char	xmlfile[] )

#include <vx_khr_xml.h>

Imports all framework and data objects from an XML file into the given context.

Parameters

[in]	context	The context to import into.
[in]	xmlfile	The XML file to read.

Note

The reference indices in the import object corresponds with the reference numbers in the XML file. It is assumed that the program has some means to know which references to use from imported list (either by name: vxGetImportReferenceByName, or by index from looking at the XML file (debug use case): vxGetImportReferenceByIndex). Alternativly, the program can use vxGetImportReferenceByIndex in a loop and query each one to understand what was imported. After all references of interest have been retrieved, this import obects should be released using vxReleaseImport.

Returns

vx_import object containing references to the imported objects in the context

See also

https://www.khronos.org/registry/vx/schema/openvx-1-1.xsd

vxQueryImport()

VX_API_ENTRY vx_status VX_API_CALL vxQueryImport	(	vx_import	import,
		vx_enum	attribute,
		void *	ptr,
		vx_size	size )

#include <vx_khr_xml.h>

Used to query the import about its properties.

Parameters

[in]	import	The reference to the import object.
[in]	attribute	The vx_import_attribute_e value to query for.
[out]	ptr	The location at which the resulting value will be stored.
[in]	size	The size of the container to which ptr points.

Returns

A vx_status_e enumeration.

Precondition

vxImportFromXML

vxReleaseImport()

VX_API_ENTRY vx_status VX_API_CALL vxReleaseImport

(

vx_import *

import

)

#include <vx_khr_xml.h>

Releases a reference to an import object. Also internally releases its references to its imported objects. These imported objects may not be garbage collected until their total reference counts are zero.

Parameters

[in]

import

The pointer to the import object to release.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	No errors.
VX_ERROR_INVALID_REFERENCE	If import is not a vx_import.

Note

After returning from this function the reference will be zeroed.

Precondition

vxImportFromXML