VARJO TRACKING PLUGIN SDK DOCUMENTATION
Varjo_plugin.h File Reference

Go to the source code of this file.

Data Structures

struct  varjo_Matrix4x4
 Double precision 4x4 matrix. More...
 
struct  varjo_IMUComponentCalibrationInfo
 Structure containing calibration parameters for an IMU device. More...
 
struct  varjo_ImuSample
 Structure describing a sample of IMU data. More...
 
struct  varjo_PluginUtilityAPI
 
struct  varjo_Quaternion
 Double precision quaternion. More...
 
struct  varjo_DevicePose
 Structure describing tracked device pose. More...
 

Macros

#define VARJO_FNTABLE_CALLTYPE
 

Typedefs

typedef uint64_t varjo_PluginType
 Bit-field type determining type of plugin API. More...
 
typedef int64_t varjo_PluginStatus
 Plugin status. More...
 
typedef struct varjo_ConfigurationKeyIterator_t * varjo_ConfigurationKeyIterator
 Settings key enumeration handle. More...
 
typedef struct varjo_PluginUtilitySession_t * varjo_PluginUtilitySession
 varjo_PluginUtilitySession More...
 
typedef struct varjo_Matrix4x4 varjo_Matrix4x4
 Double precision 4x4 matrix. More...
 
typedef uint64_t varjo_IMUCapability
 Bit-field type determining capabilities of IMU hardware. More...
 
typedef uint64_t varjo_IMUDataOffscale
 Bit-field type determining which values of IMU data are off-scale. More...
 
typedef uint64_t varjo_IMUDataInvalid
 Bit-field type determining which values of IMU data are not valid, e.g. More...
 
typedef int64_t varjo_IMUComponent
 Type identifying IMU component type. More...
 
typedef struct varjo_IMUComponentCalibrationInfo varjo_IMUDeviceCalibrationInfo
 Structure containing calibration parameters for an IMU device. More...
 
typedef struct varjo_ImuSample varjo_ImuSample
 Structure describing a sample of IMU data. More...
 
typedef int64_t varjo_PluginSystemState
 Plugin system state. More...
 
typedef struct varjo_PluginUtilityAPI varjo_PluginUtilityAPI
 
typedef struct varjo_PluginContext_t * varjo_PluginContext
 Plugin session context. More...
 
typedef uint64_t varjo_PoseFlags
 Bit-field type determining tracking status. More...
 
typedef struct varjo_Quaternion varjo_Quaternion
 Double precision quaternion. More...
 
typedef struct varjo_DevicePose varjo_DevicePose
 Structure describing tracked device pose. More...
 

Functions

varjo_PluginType varjo_GetPluginType ()
 Provides plugin types supported by the plugin library. More...
 
uint64_t varjo_GetPluginAPIVersion ()
 Provides the API version number supported by the plugin. More...
 
const char * varjo_GetPluginName ()
 Provides plugin name. More...
 
const char * varjo_GetPluginStatusDescription (varjo_PluginStatus pluginStatus)
 Provides a string description of a given status code. More...
 
varjo_PluginStatus varjo_PluginInit (const varjo_PluginUtilityAPI *pluginUtilityAPI, varjo_PluginUtilitySession pluginUtilitySession, varjo_PluginContext *context)
 Initializes plugin. More...
 
varjo_PluginStatus varjo_PluginShutdown (varjo_PluginContext *context)
 Deinitializes plugin. More...
 
varjo_PluginStatus varjo_TrackerStart (varjo_PluginContext context)
 Starts the tracker processing. More...
 
varjo_PluginStatus varjo_TrackerStop (varjo_PluginContext context)
 Stops the tracker processing. More...
 
varjo_PluginStatus varjo_GetHMDPose (varjo_PluginContext context, varjo_Nanoseconds timeStamp, varjo_DevicePose *pose)
 Queries tracker for the HMD pose. More...
 

Variables

static const varjo_PluginType varjo_PluginType_HMD_Tracker = 0x01
 Flag indicating this plugin provides HMD tracking functionality. More...
 
static const varjo_PluginStatus varjo_PluginStatus_OK = 0
 Plugin status OK. More...
 
static const varjo_IMUCapability varjo_IMUCapability_Acceleration = 0x01
 IMU HW is capable of reporting accelerometer measurements. More...
 
static const varjo_IMUCapability varjo_IMUCapability_AngularVelocity = 0x02
 IMU HW is capable of reporting gyro measurements. More...
 
static const varjo_IMUCapability varjo_IMUCapability_Attitude = 0x04
 IMU HW is capable of reporting magnetometer measurements. More...
 
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AccelerationX = 0x001
 Flag indicating the X-axis acceleration measurement is off-scale. More...
 
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AccelerationY = 0x002
 Flag indicating the Y-axis acceleration measurement is off-scale. More...
 
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AccelerationZ = 0x004
 Flag indicating the Z-axis acceleration measurement is off-scale. More...
 
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AngularVelocityX = 0x008
 Flag indicating the X-axis angular velocity measurement is off-scale. More...
 
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AngularVelocityY = 0x010
 Flag indicating the Y-axis angular velocity measurement is off-scale. More...
 
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AngularVelocityZ = 0x020
 Flag indicating the Z-axis angular velocity measurement is off-scale. More...
 
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AttitudeX = 0x040
 Flag indicating the X-axis attitude measurement is off-scale. More...
 
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AttitudeY = 0x080
 Flag indicating the Y-axis attitude measurement is off-scale. More...
 
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AttitudeZ = 0x100
 Flag indicating the Z-axis attitudey measurement is off-scale. More...
 
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AccelerationX = 0x001
 Flag indicating the X-axis acceleration measurement is not valid. More...
 
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AccelerationY = 0x002
 Flag indicating the Y-axis acceleration measurement is not valid. More...
 
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AccelerationZ = 0x004
 Flag indicating the Z-axis acceleration measurement is not valid. More...
 
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AngularVelocityX = 0x008
 Flag indicating the X-axis angular velocity measurement is not valid. More...
 
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AngularVelocityY = 0x010
 Flag indicating the Y-axis angular velocity measurement is not valid. More...
 
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AngularVelocityZ = 0x020
 Flag indicating the Z-axis angular velocity measurement is not valid. More...
 
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AttitudeX = 0x040
 Flag indicating the X-axis attitude measurement is not valid. More...
 
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AttitudeY = 0x080
 Flag indicating the Y-axis attitude measurement is not valid. More...
 
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AttitudeZ = 0x100
 Flag indicating the Z-axis attitude measurement is not valid. More...
 
static const varjo_IMUComponent varjo_IMUComponent_Accelerometer = 1
 Constant identifying IMU component accelerometer. More...
 
static const varjo_IMUComponent varjo_IMUComponent_Gyro = 2
 Constant identifying IMU component gyro. More...
 
static const varjo_IMUComponent varjo_IMUComponent_Magnetometer = 3
 Constant identifying IMU component magnetometer. More...
 
static const varjo_PluginSystemState varjo_PluginSystemState_OK = 0
 Plugin system is functioning correctly. More...
 
static const varjo_PluginSystemState varjo_PluginSystemState_Warning = 1
 Plugin system is reporting a state requiring user attention e.g. battery low. More...
 
static const varjo_PluginSystemState varjo_PluginSystemState_CriticalError = 2
 Plugin system is reporting a critical error state, e.g. tracking failure. More...
 
static const varjo_PoseFlags varjo_PoseFlags_Ok = 0x1
 Flag indicating that the tracking is OK. More...
 
static const varjo_PoseFlags varjo_PoseFlags_TrackingLost = 0x2
 Flag indicating that no tracking data is available. More...
 
static const varjo_PoseFlags varjo_PoseFlags_TrackingDisconnected = 0x4
 Flag indicating that the tracker is disconnected. More...
 
static const varjo_PoseFlags varjo_PoseFlags_HasPosition = 0x08
 Flag indicating that the pose has position information. More...
 
static const varjo_PoseFlags varjo_PoseFlags_HasRotation = 0x10
 Flag indicating that the pose has rotation information. More...
 
static const varjo_PoseFlags varjo_PoseFlags_HasVelocity = 0x20
 Flag indicating that the pose has velocity information. More...
 
static const varjo_PoseFlags varjo_PoseFlags_HasAngularVelocity = 0x40
 Flag indicating that the pose has angular velocity information. More...
 
static const varjo_PoseFlags varjo_PoseFlags_HasAcceleration = 0x80
 Flag indicating that the pose has acceleration information. More...
 
static const varjo_PoseFlags varjo_PoseFlags_HasConfidence = 0x100
 Flag indicating that the pose has confidence information. More...
 

Data Structure Documentation

◆ varjo_Matrix4x4

struct varjo_Matrix4x4

Double precision 4x4 matrix.

The matrix usage convention is that values are stored in column-major order.

Data Fields
double value[16]

◆ varjo_IMUComponentCalibrationInfo

struct varjo_IMUComponentCalibrationInfo

Structure containing calibration parameters for an IMU device.

Data Fields
varjo_Matrix3x3 scale Calibration scale.
varjo_Vector3D bias Calibration bias.

◆ varjo_ImuSample

struct varjo_ImuSample

Structure describing a sample of IMU data.

Data Fields
varjo_Nanoseconds timeStamp IMU sample timestamp (ns)
varjo_Vector3D acceleration Device acceleration (m/s^2)
varjo_Vector3D angularVelocity Device angular velocity (radians/s)
varjo_Vector3D attitude Device attitude.
varjo_IMUDataOffscale offscaleFlags Offscale flags.
varjo_IMUDataInvalid validityFlags Validity flags.

◆ varjo_PluginUtilityAPI

struct varjo_PluginUtilityAPI

Utility functions plugins can call

Data Fields
typedef const char *(VARJO_FNTABLE_CALLTYPE * GetProductId_t Returns Varjo product id string.
Parameters
session- Plugin utility session context acquired from varjo_PluginInit
Returns
NULL terminated C-string containing Varjo product id. e.g. "VR-1"
typedef varjo_IMUCapability(VARJO_FNTABLE_CALLTYPE * GetIMUCapabilities_t Returns hardware capabilities of the IMU.
Parameters
session- Plugin utility session context acquired from varjo_PluginInit
Returns
A combination of varjo_IMUCapability flags describing IMU hardware capabilities.
typedef varjo_Matrix4x4(VARJO_FNTABLE_CALLTYPE * GetIMUToHMDTransform_t Returns transformation matrix between IMU and the HMD coordinate systems.
Parameters
session- Plugin utility session context acquired from varjo_PluginInit
Returns
A transformation matrix between IMU and HMD coordinate systems.
typedef void(VARJO_FNTABLE_CALLTYPE * GetIMUComponentCalibration_t Returns calibration for an IMU component.

In VR-1, XR-1 and VR-2 series HMDs the IMU is located (from HMD user's perspective): 0.5mm to the right, 13.4mm down and 57.2mm forward from the HMD tracking point.

IMU is oriented such that its positive X points right, positive Y points down and positive Z points forward.

Calibration parameters are calculated after production and are constant in run time.

Calibration can be applied this way: IMUCCalibrated = (IMURaw - Bias) * Scale

Parameters
session- Plugin utility session context acquired from varjo_PluginInit
component- IMU hardare component for which the calibration is requested
Returns
IMU calibration parameters for a component
typedef int32_t(VARJO_FNTABLE_CALLTYPE * ReadIMUSamples_t Reads up to sampleCount samples of varjo_ImuSample into a samples buffer.

The varjo_ImuSample values obtained via ReadIMUSamples_t are not calibrated.

See also
GetIMUComponentCalibration_t
Parameters
session- Plugin utility session context acquired from varjo_PluginInit
samples- Pointer to the buffer where the IMU data samples should be stored
sampleCount- Number of IMU samples to read
Returns
Number of IMU samples read
typedef varjo_Bool(VARJO_FNTABLE_CALLTYPE * SyncConfiguration_t Atomically applies set configuration.
Parameters
session- Plugin utility session context acquired from varjo_PluginInit
typedef const char *(VARJO_FNTABLE_CALLTYPE * EnumConfigurationKeys_t Enumerates configuration keys.
Parameters
session- Plugin utility session context acquired from varjo_PluginInit
handle- enumeration handle, pass NULL to start enumeration
Returns
NULL when enumeration is over, otherwise a null-terminated C-string containing key name.
typedef void(VARJO_FNTABLE_CALLTYPE * SetConfigurationString_t Sets configuration entry.
Parameters
valuefor
key
session- Plugin utility session context acquired from varjo_PluginInit
typedef int32_t(VARJO_FNTABLE_CALLTYPE * GetConfigurationString_t Writes configuration entry.
Parameters
valuefor
key
session- Plugin utility session context acquired from varjo_PluginInit
Returns
If value is NULL, returns size of buffer necessary for value, otherwise length of the value for key written to value. Returs 0 if the requested configuration key is not found.
typedef varjo_Nanoseconds(VARJO_FNTABLE_CALLTYPE * GetCurrentSystemTime_t Returns current system time.
Parameters
session- Plugin utility session context acquired from varjo_PluginInit
Returns
Current time
typedef void(VARJO_FNTABLE_CALLTYPE * WriteLogMessage_t Writes a message to the log.
Parameters
session- Plugin utility session context acquired from varjo_PluginInit
typedef void(VARJO_FNTABLE_CALLTYPE * SetPluginSystemState_t Indicates a plugin system state to Varjo SW stack.
Parameters
session- Plugin utility session context acquired from varjo_PluginInit
state- a value of type varjo_PluginSystemState indicating plugin system state
message- optional message containing technical description of given state
Data Fields
GetProductId_t GetProductId
See also
GetProductId_t.
GetIMUCapabilities_t GetIMUCapabilities
See also
GetIMUCapabilities_t.
GetIMUToHMDTransform_t GetIMUToHMDTransform
See also
GetIMUToHMDTransform_t.
GetIMUComponentCalibration_t GetIMUComponentCalibration
See also
GetIMUComponentCalibration_t.
ReadIMUSamples_t ReadIMUSamples
See also
ReadIMUSamples_t.
SyncConfiguration_t SyncConfiguration
See also
SyncConfiguration_t.
EnumConfigurationKeys_t EnumConfigurationKeys
See also
EnumConfigurationKeys_t.
SetConfigurationString_t SetConfigurationString
See also
SetConfigurationString_t.
GetConfigurationString_t GetConfigurationString
See also
GetConfigurationString_t.
GetCurrentSystemTime_t GetCurrentSystemTime
See also
GetCurrentSystemTime_t.
WriteLogMessage_t WriteLogMessage
See also
WriteLogMessage_t.
SetPluginSystemState_t SetPluginSystemState
See also
SetPluginSystemState_t.

◆ varjo_Quaternion

struct varjo_Quaternion

Double precision quaternion.

Data Fields
double w Quaternion component w.
double x Quaternion component x.
double y Quaternion component y.
double z Quaternion component z.

◆ varjo_DevicePose

struct varjo_DevicePose

Structure describing tracked device pose.

Coordinate system is right-handed, positive X goes right, positive Y goes up and negative Z goes forward from HMD users perspective. Distance unit is meters.

Data Fields
varjo_Nanoseconds timeStamp Pose timestamp (ns)
int64_t frameNo Frame number, increases monotonically.
varjo_Vector3D position Device position (m)
varjo_Quaternion rotation Device rotation.
varjo_Vector3D velocity Device linear velocity (m/s)
varjo_Vector3D angularVelocity Device angular velocity (radians/s)
varjo_Vector3D acceleration Device acceleration (m/s^2)
varjo_PoseFlags poseFlags Bit field value describing pose.
double confidence Tracker confidence.

Macro Definition Documentation

◆ VARJO_FNTABLE_CALLTYPE

#define VARJO_FNTABLE_CALLTYPE

Typedef Documentation

◆ varjo_PluginType

typedef uint64_t varjo_PluginType

Bit-field type determining type of plugin API.

◆ varjo_PluginStatus

typedef int64_t varjo_PluginStatus

Plugin status.

◆ varjo_ConfigurationKeyIterator

typedef struct varjo_ConfigurationKeyIterator_t* varjo_ConfigurationKeyIterator

Settings key enumeration handle.

◆ varjo_PluginUtilitySession

typedef struct varjo_PluginUtilitySession_t* varjo_PluginUtilitySession

varjo_PluginUtilitySession

◆ varjo_Matrix4x4

Double precision 4x4 matrix.

The matrix usage convention is that values are stored in column-major order.

◆ varjo_IMUCapability

typedef uint64_t varjo_IMUCapability

Bit-field type determining capabilities of IMU hardware.

◆ varjo_IMUDataOffscale

typedef uint64_t varjo_IMUDataOffscale

Bit-field type determining which values of IMU data are off-scale.

These flags are set when a corresponding sensor reading exceeds a limit of it's measurement range

◆ varjo_IMUDataInvalid

typedef uint64_t varjo_IMUDataInvalid

Bit-field type determining which values of IMU data are not valid, e.g.

in case the IMU HW can not provide corresponding measurement type, or does not have a measurement sample

◆ varjo_IMUComponent

typedef int64_t varjo_IMUComponent

Type identifying IMU component type.

◆ varjo_IMUDeviceCalibrationInfo

Structure containing calibration parameters for an IMU device.

◆ varjo_ImuSample

Structure describing a sample of IMU data.

◆ varjo_PluginSystemState

typedef int64_t varjo_PluginSystemState

Plugin system state.

◆ varjo_PluginUtilityAPI

◆ varjo_PluginContext

typedef struct varjo_PluginContext_t* varjo_PluginContext

Plugin session context.

◆ varjo_PoseFlags

typedef uint64_t varjo_PoseFlags

Bit-field type determining tracking status.

◆ varjo_Quaternion

Double precision quaternion.

◆ varjo_DevicePose

Structure describing tracked device pose.

Coordinate system is right-handed, positive X goes right, positive Y goes up and negative Z goes forward from HMD users perspective. Distance unit is meters.

Function Documentation

◆ varjo_GetPluginType()

varjo_PluginType varjo_GetPluginType ( )

Provides plugin types supported by the plugin library.

Returns
a combination of varjo_PluginType flags

◆ varjo_GetPluginAPIVersion()

uint64_t varjo_GetPluginAPIVersion ( )

Provides the API version number supported by the plugin.

Use VARJO_PLUGIN_API_VERSION macro to indicate supported API version number.

Returns
Varjo plugin API version number.

◆ varjo_GetPluginName()

const char* varjo_GetPluginName ( )

Provides plugin name.

Returns
Null-terminated C-string containing plugin name

◆ varjo_GetPluginStatusDescription()

const char* varjo_GetPluginStatusDescription ( varjo_PluginStatus  pluginStatus)

Provides a string description of a given status code.

Parameters
pluginStatus- plugin status code
Returns
Null-terminated C-string containing description of a given status code

◆ varjo_PluginInit()

varjo_PluginStatus varjo_PluginInit ( const varjo_PluginUtilityAPI pluginUtilityAPI,
varjo_PluginUtilitySession  pluginUtilitySession,
varjo_PluginContext context 
)

Initializes plugin.

Parameters
pluginUtilityAPI- pointer to structure containing utility function pointers
pluginUtilitySession- handle to pass to varjo_PluginUtilityAPI functions
context- pointer to write plugin session context
Returns
varjo_PluginStatus_OK if plugin was initialized successfully, other value of type varjo_PluginStatus otherwise

◆ varjo_PluginShutdown()

varjo_PluginStatus varjo_PluginShutdown ( varjo_PluginContext context)

Deinitializes plugin.

Parameters
context- plugin session context acquired from varjo_PluginInit
Returns
varjo_PluginStatus_OK if plugin was shut down successfully, other value of type varjo_PluginStatus otherwise

◆ varjo_TrackerStart()

varjo_PluginStatus varjo_TrackerStart ( varjo_PluginContext  context)

Starts the tracker processing.

Parameters
context- plugin session context acquired from varjo_PluginInit
Returns
varjo_PluginStatus_OK if tracker started successfully, other value of type varjo_PluginStatus otherwise

◆ varjo_TrackerStop()

varjo_PluginStatus varjo_TrackerStop ( varjo_PluginContext  context)

Stops the tracker processing.

Parameters
context- plugin session context acquired from varjo_PluginInit
Returns
varjo_PluginStatus_OK if tracker stopped successfully, other value of type varjo_PluginStatus otherwise

◆ varjo_GetHMDPose()

varjo_PluginStatus varjo_GetHMDPose ( varjo_PluginContext  context,
varjo_Nanoseconds  timeStamp,
varjo_DevicePose pose 
)

Queries tracker for the HMD pose.

HMD's tracking point is expected to be located in the middle - between the centers of eye-piece lenses, and the on plane of the lens surface closest to the user eyes.

Parameters
context- plugin session context acquired from varjo_PluginInit
timeStamp- timestamp in nanoseconds for which tracking prediction is requested
pose- Pointer to a structure receiving tracking
Returns
varjo_PluginStatus_OK if HMD pose was queried successfully, other value of type varjo_PluginStatus otherwise

Variable Documentation

◆ varjo_PluginType_HMD_Tracker

const varjo_PluginType varjo_PluginType_HMD_Tracker = 0x01
static

Flag indicating this plugin provides HMD tracking functionality.

◆ varjo_PluginStatus_OK

const varjo_PluginStatus varjo_PluginStatus_OK = 0
static

Plugin status OK.

◆ varjo_IMUCapability_Acceleration

const varjo_IMUCapability varjo_IMUCapability_Acceleration = 0x01
static

IMU HW is capable of reporting accelerometer measurements.

◆ varjo_IMUCapability_AngularVelocity

const varjo_IMUCapability varjo_IMUCapability_AngularVelocity = 0x02
static

IMU HW is capable of reporting gyro measurements.

◆ varjo_IMUCapability_Attitude

const varjo_IMUCapability varjo_IMUCapability_Attitude = 0x04
static

IMU HW is capable of reporting magnetometer measurements.

◆ varjo_IMUDataOffscale_AccelerationX

const varjo_IMUDataOffscale varjo_IMUDataOffscale_AccelerationX = 0x001
static

Flag indicating the X-axis acceleration measurement is off-scale.

◆ varjo_IMUDataOffscale_AccelerationY

const varjo_IMUDataOffscale varjo_IMUDataOffscale_AccelerationY = 0x002
static

Flag indicating the Y-axis acceleration measurement is off-scale.

◆ varjo_IMUDataOffscale_AccelerationZ

const varjo_IMUDataOffscale varjo_IMUDataOffscale_AccelerationZ = 0x004
static

Flag indicating the Z-axis acceleration measurement is off-scale.

◆ varjo_IMUDataOffscale_AngularVelocityX

const varjo_IMUDataOffscale varjo_IMUDataOffscale_AngularVelocityX = 0x008
static

Flag indicating the X-axis angular velocity measurement is off-scale.

◆ varjo_IMUDataOffscale_AngularVelocityY

const varjo_IMUDataOffscale varjo_IMUDataOffscale_AngularVelocityY = 0x010
static

Flag indicating the Y-axis angular velocity measurement is off-scale.

◆ varjo_IMUDataOffscale_AngularVelocityZ

const varjo_IMUDataOffscale varjo_IMUDataOffscale_AngularVelocityZ = 0x020
static

Flag indicating the Z-axis angular velocity measurement is off-scale.

◆ varjo_IMUDataOffscale_AttitudeX

const varjo_IMUDataOffscale varjo_IMUDataOffscale_AttitudeX = 0x040
static

Flag indicating the X-axis attitude measurement is off-scale.

◆ varjo_IMUDataOffscale_AttitudeY

const varjo_IMUDataOffscale varjo_IMUDataOffscale_AttitudeY = 0x080
static

Flag indicating the Y-axis attitude measurement is off-scale.

◆ varjo_IMUDataOffscale_AttitudeZ

const varjo_IMUDataOffscale varjo_IMUDataOffscale_AttitudeZ = 0x100
static

Flag indicating the Z-axis attitudey measurement is off-scale.

◆ varjo_IMUDataInvalid_AccelerationX

const varjo_IMUDataInvalid varjo_IMUDataInvalid_AccelerationX = 0x001
static

Flag indicating the X-axis acceleration measurement is not valid.

◆ varjo_IMUDataInvalid_AccelerationY

const varjo_IMUDataInvalid varjo_IMUDataInvalid_AccelerationY = 0x002
static

Flag indicating the Y-axis acceleration measurement is not valid.

◆ varjo_IMUDataInvalid_AccelerationZ

const varjo_IMUDataInvalid varjo_IMUDataInvalid_AccelerationZ = 0x004
static

Flag indicating the Z-axis acceleration measurement is not valid.

◆ varjo_IMUDataInvalid_AngularVelocityX

const varjo_IMUDataInvalid varjo_IMUDataInvalid_AngularVelocityX = 0x008
static

Flag indicating the X-axis angular velocity measurement is not valid.

◆ varjo_IMUDataInvalid_AngularVelocityY

const varjo_IMUDataInvalid varjo_IMUDataInvalid_AngularVelocityY = 0x010
static

Flag indicating the Y-axis angular velocity measurement is not valid.

◆ varjo_IMUDataInvalid_AngularVelocityZ

const varjo_IMUDataInvalid varjo_IMUDataInvalid_AngularVelocityZ = 0x020
static

Flag indicating the Z-axis angular velocity measurement is not valid.

◆ varjo_IMUDataInvalid_AttitudeX

const varjo_IMUDataInvalid varjo_IMUDataInvalid_AttitudeX = 0x040
static

Flag indicating the X-axis attitude measurement is not valid.

◆ varjo_IMUDataInvalid_AttitudeY

const varjo_IMUDataInvalid varjo_IMUDataInvalid_AttitudeY = 0x080
static

Flag indicating the Y-axis attitude measurement is not valid.

◆ varjo_IMUDataInvalid_AttitudeZ

const varjo_IMUDataInvalid varjo_IMUDataInvalid_AttitudeZ = 0x100
static

Flag indicating the Z-axis attitude measurement is not valid.

◆ varjo_IMUComponent_Accelerometer

const varjo_IMUComponent varjo_IMUComponent_Accelerometer = 1
static

Constant identifying IMU component accelerometer.

◆ varjo_IMUComponent_Gyro

const varjo_IMUComponent varjo_IMUComponent_Gyro = 2
static

Constant identifying IMU component gyro.

◆ varjo_IMUComponent_Magnetometer

const varjo_IMUComponent varjo_IMUComponent_Magnetometer = 3
static

Constant identifying IMU component magnetometer.

◆ varjo_PluginSystemState_OK

const varjo_PluginSystemState varjo_PluginSystemState_OK = 0
static

Plugin system is functioning correctly.

◆ varjo_PluginSystemState_Warning

const varjo_PluginSystemState varjo_PluginSystemState_Warning = 1
static

Plugin system is reporting a state requiring user attention e.g. battery low.

◆ varjo_PluginSystemState_CriticalError

const varjo_PluginSystemState varjo_PluginSystemState_CriticalError = 2
static

Plugin system is reporting a critical error state, e.g. tracking failure.

◆ varjo_PoseFlags_Ok

const varjo_PoseFlags varjo_PoseFlags_Ok = 0x1
static

Flag indicating that the tracking is OK.

◆ varjo_PoseFlags_TrackingLost

const varjo_PoseFlags varjo_PoseFlags_TrackingLost = 0x2
static

Flag indicating that no tracking data is available.

◆ varjo_PoseFlags_TrackingDisconnected

const varjo_PoseFlags varjo_PoseFlags_TrackingDisconnected = 0x4
static

Flag indicating that the tracker is disconnected.

◆ varjo_PoseFlags_HasPosition

const varjo_PoseFlags varjo_PoseFlags_HasPosition = 0x08
static

Flag indicating that the pose has position information.

◆ varjo_PoseFlags_HasRotation

const varjo_PoseFlags varjo_PoseFlags_HasRotation = 0x10
static

Flag indicating that the pose has rotation information.

◆ varjo_PoseFlags_HasVelocity

const varjo_PoseFlags varjo_PoseFlags_HasVelocity = 0x20
static

Flag indicating that the pose has velocity information.

◆ varjo_PoseFlags_HasAngularVelocity

const varjo_PoseFlags varjo_PoseFlags_HasAngularVelocity = 0x40
static

Flag indicating that the pose has angular velocity information.

◆ varjo_PoseFlags_HasAcceleration

const varjo_PoseFlags varjo_PoseFlags_HasAcceleration = 0x80
static

Flag indicating that the pose has acceleration information.

◆ varjo_PoseFlags_HasConfidence

const varjo_PoseFlags varjo_PoseFlags_HasConfidence = 0x100
static

Flag indicating that the pose has confidence information.