OSVR-Core
Typedefs | Functions
Locomotion interface (base C API)

Sending locomotion reports from a device in your plugin. More...

Typedefs

typedef struct OSVR_LocomotionDeviceInterfaceObjectOSVR_LocomotionDeviceInterface
 Opaque type used in conjunction with a device token to send data on Locomotion Interface.
 

Functions

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceLocomotionConfigure (OSVR_INOUT_PTR OSVR_DeviceInitOptions opts, OSVR_OUT_PTR OSVR_LocomotionDeviceInterface *iface) OSVR_FUNC_NONNULL((1
 Specify that your device will implement the Locomotion interface. More...
 
OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceLocomotionReportNaviVelocity (OSVR_IN_PTR OSVR_LocomotionDeviceInterface iface, OSVR_IN OSVR_NaviVelocityState naviVelocity, OSVR_IN OSVR_ChannelCount sensor, OSVR_IN_PTR OSVR_TimeValue const *timestamp) OSVR_FUNC_NONNULL((1
 Report velocity data for a specific sensor. More...
 
OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceLocomotionReportNaviPosition (OSVR_IN_PTR OSVR_LocomotionDeviceInterface iface, OSVR_IN OSVR_NaviPositionState naviPosition, OSVR_IN OSVR_ChannelCount sensor, OSVR_IN_PTR OSVR_TimeValue const *timestamp) OSVR_FUNC_NONNULL((1
 Report position data for a specific sensor. More...
 

Detailed Description

Sending locomotion reports from a device in your plugin.

Function Documentation

§ osvrDeviceLocomotionConfigure()

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceLocomotionConfigure ( OSVR_INOUT_PTR OSVR_DeviceInitOptions  opts,
OSVR_OUT_PTR OSVR_LocomotionDeviceInterface iface 
)

Specify that your device will implement the Locomotion interface.

Parameters
optsThe device init options object.
[out]ifaceAn interface object you should retain with the same lifetime as the device token in order to send messages conforming to an Locomotion interface.
numSensorsThe number of sensors you will be reporting Locomotion data : You can report for 1 sensor per device.

§ osvrDeviceLocomotionReportNaviPosition()

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceLocomotionReportNaviPosition ( OSVR_IN_PTR OSVR_LocomotionDeviceInterface  iface,
OSVR_IN OSVR_NaviPositionState  naviPosition,
OSVR_IN OSVR_ChannelCount  sensor,
OSVR_IN_PTR OSVR_TimeValue const *  timestamp 
)

Report position data for a specific sensor.

Parameters
devDevice token
ifaceLocomotion Interface
naviPositionnavigation position
sensorSensor number
timestampTimestamp correlating to navigation position

§ osvrDeviceLocomotionReportNaviVelocity()

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceLocomotionReportNaviVelocity ( OSVR_IN_PTR OSVR_LocomotionDeviceInterface  iface,
OSVR_IN OSVR_NaviVelocityState  naviVelocity,
OSVR_IN OSVR_ChannelCount  sensor,
OSVR_IN_PTR OSVR_TimeValue const *  timestamp 
)

Report velocity data for a specific sensor.

Parameters
devDevice token
ifaceLocomotion Interface
naviVelocitynavigation velocity
sensorSensor number
timestampTimestamp correlating to navigation velocity