All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Driver Class Referenceabstract

Public Member Functions

virtual ExternalCamera *VUFORIA_DRIVER_CALLING_CONVENTION createExternalCamera ()=0
 Construct a new ExternalCamera instance.
 
virtual void VUFORIA_DRIVER_CALLING_CONVENTION destroyExternalCamera (ExternalCamera *instance)=0
 Destruct an instance of an ExternalCamera object.
 
virtual ExternalPositionalDeviceTracker *VUFORIA_DRIVER_CALLING_CONVENTION createExternalPositionalDeviceTracker ()
 Construct a new instance of an external positional device tracker.
 
virtual void VUFORIA_DRIVER_CALLING_CONVENTION destroyExternalPositionalDeviceTracker (ExternalPositionalDeviceTracker *instance)
 Destruct an instance of an ExternalPositionalDeviceTracker object.
 
virtual uint32_t VUFORIA_DRIVER_CALLING_CONVENTION getCapabilities ()
 Query the driver implementation for supported capabilities.
 
virtual uint32_t VUFORIA_DRIVER_CALLING_CONVENTION getCameraOrientation (uint32_t deviceOrientationInDegrees)
 Get the camera orientation.
 
virtual const char *VUFORIA_DRIVER_CALLING_CONVENTION getDeviceHint (const char *name)
 Get the value for the specified hint.
 

Detailed Description

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

Note
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().

Member Function Documentation

◆ createExternalCamera()

virtual ExternalCamera *VUFORIA_DRIVER_CALLING_CONVENTION createExternalCamera ( )
pure virtual

Construct a new ExternalCamera instance.

Note
Vuforia uses 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

◆ destroyExternalCamera()

virtual void VUFORIA_DRIVER_CALLING_CONVENTION destroyExternalCamera ( ExternalCamera * instance)
pure virtual

Destruct an instance of an ExternalCamera object.

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

Parameters
instanceCamera instance to destroy

◆ createExternalPositionalDeviceTracker()

virtual ExternalPositionalDeviceTracker *VUFORIA_DRIVER_CALLING_CONVENTION createExternalPositionalDeviceTracker ( )
inlinevirtual

Construct a new instance of an external positional device tracker.

Note
Vuforia will call this function 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

◆ destroyExternalPositionalDeviceTracker()

virtual void VUFORIA_DRIVER_CALLING_CONVENTION destroyExternalPositionalDeviceTracker ( ExternalPositionalDeviceTracker * instance)
inlinevirtual

Destruct an instance of an ExternalPositionalDeviceTracker object.

Note
Vuforia will call this function to destroy the instance created with createExternalPositionalDeviceTracker()
Parameters
instanceExternalPositionalDeviceTracker instance to destroy

◆ getCapabilities()

virtual uint32_t VUFORIA_DRIVER_CALLING_CONVENTION getCapabilities ( )
inlinevirtual

Query the driver implementation for supported capabilities.

Note
Vuforia defaults to the Camera Image only capability

◆ getCameraOrientation()

virtual uint32_t VUFORIA_DRIVER_CALLING_CONVENTION getCameraOrientation ( uint32_t deviceOrientationInDegrees)
inlinevirtual

Get the camera orientation.

Note
The value may need to be adjusted based on the current device orientation provided in the parameter.
The camera orientation describes how much the camera sensor is rotated with respect to the natural orientation of a device. This value is needed for correctly displaying the camera frames coming from the Vuforia Driver.
Parameters
deviceOrientationInDegreesThe device orientation of the app that will display the driver data. The device orientation describes the orientation of the device with respect to its natural position. For instance, many mobile phones will naturally be in portrait orientation. So, if such a mobile phone is held in a landscape orientation, this will be a non-zero angle value.
Returns
the camera orientation value (in degrees) required for correct display. By default, the driver returns 0 degrees.

◆ getDeviceHint()

virtual const char *VUFORIA_DRIVER_CALLING_CONVENTION getDeviceHint ( const char * name)
inlinevirtual

Get the value for the specified hint.

Note
Vuforia Engine can modify its behavior based on hints about the device that it is running on. Drivers may provide values for certain hints to optimize performance on particular hardware.
Parameters
nameThe name of the hint as provided by the Vuforia team
Returns
the null terminated string value for the requested hint or nullptr if the hint name is not recognized