Vuforia Driver API

Topics
	External Camera
	External Positional Device Tracker

Classes
struct	PlatformData
	Empty struct as a placeholder for platforms that don't have platform-specific initialization data. More...
class	Driver
	Interface used by Vuforia to interact with the Vuforia Driver implementation. More...

Enumerations
enum	Capability : uint32_t {   CAMERA_IMAGE = 0 ,   CAMERA_POSE = 1 }
	Driver capabilities. More...

Functions
VUFORIA_DRIVER_API_EXPORT uint32_t VUFORIA_DRIVER_CALLING_CONVENTION	vuforiaDriver_getAPIVersion ()
	Query the Vuforia Driver API version number.
VUFORIA_DRIVER_API_EXPORT uint32_t VUFORIA_DRIVER_CALLING_CONVENTION	vuforiaDriver_getLibraryVersion (char *versionString, const uint32_t maxLen)
	Return the library version number.
VUFORIA_DRIVER_API_EXPORT VuforiaDriver::Driver *VUFORIA_DRIVER_CALLING_CONVENTION	vuforiaDriver_init (VuforiaDriver::PlatformData *platformData, void *userData)
	Construct a new instance of a VuforiaDriver.
VUFORIA_DRIVER_API_EXPORT void VUFORIA_DRIVER_CALLING_CONVENTION	vuforiaDriver_deinit (VuforiaDriver::Driver *instance)
	Destruct an instance of a VuforiaDriver object.

Variables
const uint32_t	VUFORIA_DRIVER_API_VERSION = 7
	External provider API-version number that this header defines.

Detailed Description

Enumeration Type Documentation

Capability

enum Capability : uint32_t

Driver capabilities.

Enumerator
CAMERA_IMAGE	Driver supports camera Image(s)
CAMERA_POSE	Driver supports camera pose(s)

Function Documentation

vuforiaDriver_getAPIVersion()

VUFORIA_DRIVER_API_EXPORT uint32_t VUFORIA_DRIVER_CALLING_CONVENTION vuforiaDriver_getAPIVersion

(

)

Query the Vuforia Driver API version number.

Note

This function returns the version of the Vuforia Driver API that this plugin conforms to.

Returns

Should return EXTERNAL_PROVIDER_API_VERSION defined in this file.

vuforiaDriver_getLibraryVersion()

VUFORIA_DRIVER_API_EXPORT uint32_t VUFORIA_DRIVER_CALLING_CONVENTION vuforiaDriver_getLibraryVersion	(	char *	versionString,
		const uint32_t	maxLen )

Return the library version number.

Note

This function should write a versionString-parameter with a user defined library version string with maximum length of maxLen.

Empty strings are not supported

Parameters

versionString	This should be populated with the library version string
maxLen	Maximum length in bytes that can fit to versionString

Returns

The number of bytes written into versionString

vuforiaDriver_init()

VUFORIA_DRIVER_API_EXPORT VuforiaDriver::Driver *VUFORIA_DRIVER_CALLING_CONVENTION vuforiaDriver_init	(	VuforiaDriver::PlatformData *	platformData,
		void *	userData )

Construct a new instance of a VuforiaDriver.

Note

Vuforia will use this instance to interact with the library. The object is expected to be valid until vuforiaDriver_deinit() is called. The memory for the object is owned by the library. Only one instance of VuforiaDriver is created, a second call to vuforiaDriver_init without a call to vuforiaDriver_deinit is an error and the implementation should return a nullptr.

Parameters

platformData	Platform-specific initialization data, that has been defined in the beginning of this header file
userData	User data that the developer provides as the "userData" parameter in the VuDriverConfig Engine configuration data structure

Returns

New Vuforia Driver instance

vuforiaDriver_deinit()

VUFORIA_DRIVER_API_EXPORT void VUFORIA_DRIVER_CALLING_CONVENTION vuforiaDriver_deinit

(

VuforiaDriver::Driver *

instance

)

Destruct an instance of a VuforiaDriver object.

Note

Vuforia will call this to destroy the instance that was created with vuforiaDriver_init().

Parameters

instance

Vuforia Driver instance to destroy