![]() |
VARJO TRACKING PLUGIN SDK DOCUMENTATION
|
Utility functions plugins can call
typedef const char*(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::GetProductId_t) ( varjo_PluginUtilitySession session) |
Returns Varjo product id string
session | - Plugin utility session context acquired from varjo_PluginInit |
typedef varjo_IMUCapability(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::GetIMUCapabilities_t) ( varjo_PluginUtilitySession session) |
Returns hardware capabilities of the IMU
session | - Plugin utility session context acquired from varjo_PluginInit |
typedef varjo_Matrix4x4(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::GetIMUToHMDTransform_t) ( varjo_PluginUtilitySession session) |
Returns transformation matrix between IMU and the HMD coordinate systems
session | - Plugin utility session context acquired from varjo_PluginInit |
typedef void(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::GetIMUComponentCalibration_t) ( varjo_PluginUtilitySession session, varjo_IMUComponent component, varjo_IMUComponentCalibrationInfo *calibrationInfo) |
Returns calibration for an IMU component
Calibration parameters are calculated after production and are constant in run time.
Calibration can be applied this way: IMUCCalibrated = (IMURaw - Bias) * Scale
session | - Plugin utility session context acquired from varjo_PluginInit |
component | - IMU hardare component for which the calibration is requested |
component
typedef int32_t(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::ReadIMUSamples_t) ( varjo_PluginUtilitySession session, varjo_ImuSample *samples, int32_t sampleCount) |
Reads up to sampleCount
samples of varjo_ImuSample into a samples
buffer.
The varjo_ImuSample
values obtained via ReadIMUSamples_t are not calibrated.
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 |
typedef varjo_Bool(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::SyncConfiguration_t) ( varjo_PluginUtilitySession session) |
Atomically applies set configuration
session | - Plugin utility session context acquired from varjo_PluginInit |
typedef const char*(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::EnumConfigurationKeys_t) ( varjo_PluginUtilitySession session, varjo_ConfigurationKeyIterator *handle) |
Enumerates configuration keys
session | - Plugin utility session context acquired from varjo_PluginInit |
handle | - enumeration handle, pass NULL to start enumeration |
typedef void(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::SetConfigurationString_t) ( varjo_PluginUtilitySession session, const char *key, const char *value) |
Sets configuration entry
value | for |
key | |
session | - Plugin utility session context acquired from varjo_PluginInit |
typedef int32_t(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::GetConfigurationString_t) ( varjo_PluginUtilitySession session, const char *key, char *value, int32_t valueLength) |
Writes configuration entry
value | for |
key | |
session | - Plugin utility session context acquired from varjo_PluginInit |
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* varjo_PluginUtilityAPI::GetCurrentSystemTime_t) ( varjo_PluginUtilitySession session) |
Returns current system time
session | - Plugin utility session context acquired from varjo_PluginInit |
typedef void(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::WriteLogMessage_t) ( varjo_PluginUtilitySession session, const char *message) |
Writes a message
to the log
session | - Plugin utility session context acquired from varjo_PluginInit |
typedef void(VARJO_FNTABLE_CALLTYPE* varjo_PluginUtilityAPI::SetPluginSystemState_t) ( varjo_PluginUtilitySession session, varjo_PluginSystemState state, const char *message) |
Indicates a plugin system state
to Varjo SW stack.
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 |
GetProductId_t varjo_PluginUtilityAPI::GetProductId |
GetIMUCapabilities_t varjo_PluginUtilityAPI::GetIMUCapabilities |
GetIMUToHMDTransform_t varjo_PluginUtilityAPI::GetIMUToHMDTransform |
GetIMUComponentCalibration_t varjo_PluginUtilityAPI::GetIMUComponentCalibration |
ReadIMUSamples_t varjo_PluginUtilityAPI::ReadIMUSamples |
SyncConfiguration_t varjo_PluginUtilityAPI::SyncConfiguration |
EnumConfigurationKeys_t varjo_PluginUtilityAPI::EnumConfigurationKeys |
SetConfigurationString_t varjo_PluginUtilityAPI::SetConfigurationString |
GetConfigurationString_t varjo_PluginUtilityAPI::GetConfigurationString |
GetCurrentSystemTime_t varjo_PluginUtilityAPI::GetCurrentSystemTime |
WriteLogMessage_t varjo_PluginUtilityAPI::WriteLogMessage |
SetPluginSystemState_t varjo_PluginUtilityAPI::SetPluginSystemState |