 |
VARJO TRACKING PLUGIN SDK DOCUMENTATION
|
Go to the documentation of this file.
10 #if defined __cplusplus
15 #define VARJO_FNTABLE_CALLTYPE __cdecl
17 #define VARJO_FNTABLE_CALLTYPE
279 const char* key,
const char* value);
294 const char* key,
char* value, int32_t valueLength);
319 const char* message);
334 const char* message);
469 #if defined __cplusplus
471 #endif // __cplusplus
473 #endif // VARJO_PLUGIN_H
const char * varjo_GetPluginName()
varjo_Vector3D acceleration
Device acceleration (m/s^2)
Definition: Varjo_plugin.h:412
varjo_PoseFlags poseFlags
Bit field value describing pose.
Definition: Varjo_plugin.h:413
static const varjo_PluginStatus varjo_PluginStatus_OK
Plugin status OK.
Definition: Varjo_plugin.h:59
static const varjo_PluginSystemState varjo_PluginSystemState_OK
Plugin system is functioning correctly.
Definition: Varjo_plugin.h:160
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AccelerationY
Flag indicating the Y-axis acceleration measurement is off-scale.
Definition: Varjo_plugin.h:102
GetConfigurationString_t GetConfigurationString
Definition: Varjo_plugin.h:297
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AngularVelocityZ
Flag indicating the Z-axis angular velocity measurement is off-scale.
Definition: Varjo_plugin.h:106
double w
Quaternion component w.
Definition: Varjo_plugin.h:390
const char *(VARJO_FNTABLE_CALLTYPE * GetProductId_t)(varjo_PluginUtilitySession session)
Definition: Varjo_plugin.h:176
int64_t varjo_Nanoseconds
Definition: Varjo_types.h:22
static const varjo_PoseFlags varjo_PoseFlags_HasConfidence
Flag indicating that the pose has confidence information.
Definition: Varjo_plugin.h:384
GetIMUCapabilities_t GetIMUCapabilities
Definition: Varjo_plugin.h:193
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AngularVelocityX
Flag indicating the X-axis angular velocity measurement is not valid.
Definition: Varjo_plugin.h:120
varjo_Nanoseconds(VARJO_FNTABLE_CALLTYPE * GetCurrentSystemTime_t)(varjo_PluginUtilitySession session)
Definition: Varjo_plugin.h:306
static const varjo_IMUComponent varjo_IMUComponent_Magnetometer
Constant identifying IMU component magnetometer.
Definition: Varjo_plugin.h:134
const char *(VARJO_FNTABLE_CALLTYPE * EnumConfigurationKeys_t)(varjo_PluginUtilitySession session, varjo_ConfigurationKeyIterator *handle)
Definition: Varjo_plugin.h:265
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AccelerationY
Flag indicating the Y-axis acceleration measurement is not valid.
Definition: Varjo_plugin.h:118
varjo_Vector3D velocity
Device linear velocity (m/s)
Definition: Varjo_plugin.h:410
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AttitudeZ
Flag indicating the Z-axis attitudey measurement is off-scale.
Definition: Varjo_plugin.h:109
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AttitudeX
Flag indicating the X-axis attitude measurement is not valid.
Definition: Varjo_plugin.h:123
EnumConfigurationKeys_t EnumConfigurationKeys
Definition: Varjo_plugin.h:270
double x
Quaternion component x.
Definition: Varjo_plugin.h:391
const char * varjo_GetPluginStatusDescription(varjo_PluginStatus pluginStatus)
Definition: Varjo_types.h:37
static const varjo_PoseFlags varjo_PoseFlags_HasPosition
Flag indicating that the pose has position information.
Definition: Varjo_plugin.h:379
varjo_PluginStatus varjo_TrackerStop(varjo_PluginContext context)
static const varjo_PluginType varjo_PluginType_HMD_Tracker
Flag indicating this plugin provides HMD tracking functionality.
Definition: Varjo_plugin.h:27
void(VARJO_FNTABLE_CALLTYPE * WriteLogMessage_t)(varjo_PluginUtilitySession session, const char *message)
Definition: Varjo_plugin.h:317
varjo_IMUCapability(VARJO_FNTABLE_CALLTYPE * GetIMUCapabilities_t)(varjo_PluginUtilitySession session)
Definition: Varjo_plugin.h:189
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AttitudeX
Flag indicating the X-axis attitude measurement is off-scale.
Definition: Varjo_plugin.h:107
varjo_PluginStatus varjo_PluginShutdown(varjo_PluginContext *context)
uint64_t varjo_PluginType
Definition: Varjo_plugin.h:26
varjo_Bool(VARJO_FNTABLE_CALLTYPE * SyncConfiguration_t)(varjo_PluginUtilitySession session)
Definition: Varjo_plugin.h:251
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AccelerationX
Flag indicating the X-axis acceleration measurement is off-scale.
Definition: Varjo_plugin.h:101
static const varjo_PluginSystemState varjo_PluginSystemState_Warning
Plugin system is reporting a state requiring user attention e.g. battery low.
Definition: Varjo_plugin.h:161
uint64_t varjo_GetPluginAPIVersion()
varjo_IMUDataOffscale offscaleFlags
Offscale flags.
Definition: Varjo_plugin.h:152
varjo_Nanoseconds timeStamp
Pose timestamp (ns)
Definition: Varjo_plugin.h:406
int64_t varjo_PluginSystemState
Definition: Varjo_plugin.h:159
static const varjo_PluginSystemState varjo_PluginSystemState_CriticalError
Plugin system is reporting a critical error state, e.g. tracking failure.
Definition: Varjo_plugin.h:162
Definition: Varjo_plugin.h:169
GetIMUComponentCalibration_t GetIMUComponentCalibration
Definition: Varjo_plugin.h:226
static const varjo_IMUComponent varjo_IMUComponent_Accelerometer
Constant identifying IMU component accelerometer.
Definition: Varjo_plugin.h:132
int32_t varjo_Bool
Definition: Varjo_types.h:15
int64_t frameNo
Frame number, increases monotonically.
Definition: Varjo_plugin.h:407
void(VARJO_FNTABLE_CALLTYPE * GetIMUComponentCalibration_t)(varjo_PluginUtilitySession session, varjo_IMUComponent component, varjo_IMUComponentCalibrationInfo *calibrationInfo)
Definition: Varjo_plugin.h:220
varjo_Vector3D angularVelocity
Device angular velocity (radians/s)
Definition: Varjo_plugin.h:150
#define VARJO_FNTABLE_CALLTYPE
Definition: Varjo_plugin.h:17
struct varjo_ImuSample varjo_ImuSample
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AngularVelocityX
Flag indicating the X-axis angular velocity measurement is off-scale.
Definition: Varjo_plugin.h:104
Definition: Varjo_plugin.h:389
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AccelerationZ
Flag indicating the Z-axis acceleration measurement is off-scale.
Definition: Varjo_plugin.h:103
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AttitudeY
Flag indicating the Y-axis attitude measurement is off-scale.
Definition: Varjo_plugin.h:108
varjo_Matrix4x4(VARJO_FNTABLE_CALLTYPE * GetIMUToHMDTransform_t)(varjo_PluginUtilitySession session)
Definition: Varjo_plugin.h:201
struct varjo_DevicePose varjo_DevicePose
Definition: Varjo_types.h:27
void(VARJO_FNTABLE_CALLTYPE * SetConfigurationString_t)(varjo_PluginUtilitySession session, const char *key, const char *value)
Definition: Varjo_plugin.h:277
SetConfigurationString_t SetConfigurationString
Definition: Varjo_plugin.h:282
struct varjo_ConfigurationKeyIterator_t * varjo_ConfigurationKeyIterator
Definition: Varjo_plugin.h:72
uint64_t varjo_IMUDataInvalid
Definition: Varjo_plugin.h:116
static const varjo_IMUCapability varjo_IMUCapability_Acceleration
IMU HW is capable of reporting accelerometer measurements.
Definition: Varjo_plugin.h:91
varjo_IMUDataInvalid validityFlags
Validity flags.
Definition: Varjo_plugin.h:153
SyncConfiguration_t SyncConfiguration
Definition: Varjo_plugin.h:255
Definition: Varjo_plugin.h:139
varjo_PluginStatus varjo_PluginInit(const varjo_PluginUtilityAPI *pluginUtilityAPI, varjo_PluginUtilitySession pluginUtilitySession, varjo_PluginContext *context)
uint64_t varjo_IMUCapability
Definition: Varjo_plugin.h:90
varjo_PluginType varjo_GetPluginType()
double value[16]
Definition: Varjo_plugin.h:84
static const varjo_PoseFlags varjo_PoseFlags_HasRotation
Flag indicating that the pose has rotation information.
Definition: Varjo_plugin.h:380
struct varjo_Matrix4x4 varjo_Matrix4x4
int32_t(VARJO_FNTABLE_CALLTYPE * GetConfigurationString_t)(varjo_PluginUtilitySession session, const char *key, char *value, int32_t valueLength)
Definition: Varjo_plugin.h:292
struct varjo_IMUComponentCalibrationInfo varjo_IMUDeviceCalibrationInfo
static const varjo_PoseFlags varjo_PoseFlags_TrackingLost
Flag indicating that no tracking data is available.
Definition: Varjo_plugin.h:377
WriteLogMessage_t WriteLogMessage
Definition: Varjo_plugin.h:322
static const varjo_PoseFlags varjo_PoseFlags_HasAcceleration
Flag indicating that the pose has acceleration information.
Definition: Varjo_plugin.h:383
varjo_Vector3D attitude
Device attitude.
Definition: Varjo_plugin.h:151
int32_t(VARJO_FNTABLE_CALLTYPE * ReadIMUSamples_t)(varjo_PluginUtilitySession session, varjo_ImuSample *samples, int32_t sampleCount)
Definition: Varjo_plugin.h:239
void(VARJO_FNTABLE_CALLTYPE * SetPluginSystemState_t)(varjo_PluginUtilitySession session, varjo_PluginSystemState state, const char *message)
Definition: Varjo_plugin.h:331
double confidence
Tracker confidence.
Definition: Varjo_plugin.h:414
Definition: Varjo_plugin.h:405
int64_t varjo_PluginStatus
Definition: Varjo_plugin.h:58
double y
Quaternion component y.
Definition: Varjo_plugin.h:392
GetCurrentSystemTime_t GetCurrentSystemTime
Definition: Varjo_plugin.h:310
GetProductId_t GetProductId
Definition: Varjo_plugin.h:180
varjo_PluginStatus varjo_TrackerStart(varjo_PluginContext context)
varjo_Matrix3x3 scale
Calibration scale.
Definition: Varjo_plugin.h:140
static const varjo_IMUCapability varjo_IMUCapability_Attitude
IMU HW is capable of reporting magnetometer measurements.
Definition: Varjo_plugin.h:93
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AngularVelocityY
Flag indicating the Y-axis angular velocity measurement is not valid.
Definition: Varjo_plugin.h:121
struct varjo_PluginUtilitySession_t * varjo_PluginUtilitySession
varjo_PluginUtilitySession
Definition: Varjo_plugin.h:77
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AngularVelocityZ
Flag indicating the Z-axis angular velocity measurement is not valid.
Definition: Varjo_plugin.h:122
struct varjo_Quaternion varjo_Quaternion
int64_t varjo_IMUComponent
Definition: Varjo_plugin.h:131
static const varjo_PoseFlags varjo_PoseFlags_TrackingDisconnected
Flag indicating that the tracker is disconnected.
Definition: Varjo_plugin.h:378
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AttitudeZ
Flag indicating the Z-axis attitude measurement is not valid.
Definition: Varjo_plugin.h:125
uint64_t varjo_IMUDataOffscale
Definition: Varjo_plugin.h:100
struct varjo_PluginContext_t * varjo_PluginContext
Definition: Varjo_plugin.h:344
uint64_t varjo_PoseFlags
Definition: Varjo_plugin.h:375
varjo_Vector3D angularVelocity
Device angular velocity (radians/s)
Definition: Varjo_plugin.h:411
varjo_Vector3D position
Device position (m)
Definition: Varjo_plugin.h:408
Definition: Varjo_plugin.h:147
static const varjo_IMUCapability varjo_IMUCapability_AngularVelocity
IMU HW is capable of reporting gyro measurements.
Definition: Varjo_plugin.h:92
static const varjo_PoseFlags varjo_PoseFlags_HasVelocity
Flag indicating that the pose has velocity information.
Definition: Varjo_plugin.h:381
static const varjo_IMUComponent varjo_IMUComponent_Gyro
Constant identifying IMU component gyro.
Definition: Varjo_plugin.h:133
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AccelerationX
Flag indicating the X-axis acceleration measurement is not valid.
Definition: Varjo_plugin.h:117
varjo_Vector3D acceleration
Device acceleration (m/s^2)
Definition: Varjo_plugin.h:149
static const varjo_PoseFlags varjo_PoseFlags_Ok
Flag indicating that the tracking is OK.
Definition: Varjo_plugin.h:376
struct varjo_PluginUtilityAPI varjo_PluginUtilityAPI
static const varjo_PoseFlags varjo_PoseFlags_HasAngularVelocity
Flag indicating that the pose has angular velocity information.
Definition: Varjo_plugin.h:382
varjo_Nanoseconds timeStamp
IMU sample timestamp (ns)
Definition: Varjo_plugin.h:148
GetIMUToHMDTransform_t GetIMUToHMDTransform
Definition: Varjo_plugin.h:205
varjo_Vector3D bias
Calibration bias.
Definition: Varjo_plugin.h:141
Definition: Varjo_plugin.h:83
static const varjo_IMUDataOffscale varjo_IMUDataOffscale_AngularVelocityY
Flag indicating the Y-axis angular velocity measurement is off-scale.
Definition: Varjo_plugin.h:105
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AccelerationZ
Flag indicating the Z-axis acceleration measurement is not valid.
Definition: Varjo_plugin.h:119
ReadIMUSamples_t ReadIMUSamples
Definition: Varjo_plugin.h:244
double z
Quaternion component z.
Definition: Varjo_plugin.h:393
varjo_PluginStatus varjo_GetHMDPose(varjo_PluginContext context, varjo_Nanoseconds timeStamp, varjo_DevicePose *pose)
Queries tracker for the HMD pose.
SetPluginSystemState_t SetPluginSystemState
Definition: Varjo_plugin.h:337
varjo_Quaternion rotation
Device rotation.
Definition: Varjo_plugin.h:409
static const varjo_IMUDataInvalid varjo_IMUDataInvalid_AttitudeY
Flag indicating the Y-axis attitude measurement is not valid.
Definition: Varjo_plugin.h:124