C++ Java Unity
C++ Reference
Public Member Functions | List of all members
VuforiaDriver Class Referenceabstract

Detailed Description

Interface used by Vuforia to interact with the Vuforia Driver implementation.

The sequence of events between Vuforia and the external driver implementation is as follows:

  1. Vuforia calls vuforiaDriver_init().
  2. Vuforia uses the VuforiaDriver.
  3. On shutdown Vuforia calls vuforiaDriver_deinit().

Public Member Functions

virtual ExternalCamera *VUFORIA_DRIVER_CALLING_CONVENTION createExternalCamera ()=0
 Constructs a new instance of an ExternalCamera. More...
 
virtual void VUFORIA_DRIVER_CALLING_CONVENTION destroyExternalCamera (ExternalCamera *instance)=0
 Destructs an instance of an ExternalCamera object. More...
 
virtual ExternalPositionalDeviceTracker *VUFORIA_DRIVER_CALLING_CONVENTION createExternalPositionalDeviceTracker ()
 
virtual void VUFORIA_DRIVER_CALLING_CONVENTION destroyExternalPositionalDeviceTracker (ExternalPositionalDeviceTracker *instance)
 Destructs an instance of an ExternalPositionalDeviceTracker object. More...
 
virtual uint32_t VUFORIA_DRIVER_CALLING_CONVENTION getCapabilities ()
 Query the driver implementation for supported capabilities. More...
 

Member Function Documentation

virtual ExternalCamera* VUFORIA_DRIVER_CALLING_CONVENTION createExternalCamera ( )
pure virtual

Constructs a new instance of an ExternalCamera.

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

Returns
New camera instance.
virtual void VUFORIA_DRIVER_CALLING_CONVENTION destroyExternalCamera ( ExternalCamera *  instance)
pure virtual

Destructs an instance of an ExternalCamera object.

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

Parameters
instancecamera instance to destroy.
virtual ExternalPositionalDeviceTracker* VUFORIA_DRIVER_CALLING_CONVENTION createExternalPositionalDeviceTracker ( )
inlinevirtual

Constructs a new instance of an external positional device tracker. Vuforia will call this only if the driver capability includes CAMERA_POSE. Vuforia will use this instance to receive pose(s). The object is expected to be valid until destroyExternalPositionalDeviceTracker() is called. The memory for the object is owned by the library. Only one instance of ExternalPositionalDeviceTracker is created, a second call to createExternalPositionalDeviceTracker without a call to destroyExternalPositionalDeviceTracker is an error and the implementation should return a nullptr.

Returns
New ExternalPositionalDeviceTracker instance.
virtual void VUFORIA_DRIVER_CALLING_CONVENTION destroyExternalPositionalDeviceTracker ( ExternalPositionalDeviceTracker *  instance)
inlinevirtual

Destructs an instance of an ExternalPositionalDeviceTracker object.

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

Parameters
instanceExternalPositionalDeviceTracker instance to destroy.
virtual uint32_t VUFORIA_DRIVER_CALLING_CONVENTION getCapabilities ( )
inlinevirtual

Query the driver implementation for supported capabilities.

Vuforia will default to the Camera Image only capability.