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

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

Typedefs

typedef struct OSVR_AnalogDeviceInterfaceObjectOSVR_AnalogDeviceInterface
 Opaque type used in conjunction with a device token to send data on an analog interface.
 

Functions

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceAnalogConfigure (OSVR_INOUT_PTR OSVR_DeviceInitOptions opts, OSVR_OUT_PTR OSVR_AnalogDeviceInterface *iface, OSVR_IN OSVR_ChannelCount numChan) OSVR_FUNC_NONNULL((1
 Specify that your device will implement the Analog interface. More...
 
OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceAnalogSetValue (OSVR_IN_PTR OSVR_DeviceToken dev, OSVR_IN_PTR OSVR_AnalogDeviceInterface iface, OSVR_IN OSVR_AnalogState val, OSVR_IN OSVR_ChannelCount chan) OSVR_FUNC_NONNULL((1
 Report the value of a single channel.
 
OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceAnalogSetValueTimestamped (OSVR_INOUT_PTR OSVR_DeviceToken dev, OSVR_IN_PTR OSVR_AnalogDeviceInterface iface, OSVR_IN OSVR_AnalogState val, OSVR_IN OSVR_ChannelCount chan, OSVR_IN_PTR OSVR_TimeValue const *timestamp) OSVR_FUNC_NONNULL((1
 Report the value of a single channel with the supplied timestamp.
 
OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceAnalogSetValues (OSVR_IN_PTR OSVR_DeviceToken dev, OSVR_IN_PTR OSVR_AnalogDeviceInterface iface, OSVR_IN_PTR OSVR_AnalogState val[], OSVR_IN OSVR_ChannelCount chans) OSVR_FUNC_NONNULL((1
 Report the value of multiple channels.
 
OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceAnalogSetValuesTimestamped (OSVR_IN_PTR OSVR_DeviceToken dev, OSVR_IN_PTR OSVR_AnalogDeviceInterface iface, OSVR_IN_PTR OSVR_AnalogState val[], OSVR_IN OSVR_ChannelCount chans, OSVR_IN_PTR OSVR_TimeValue const *timestamp) OSVR_FUNC_NONNULL((1
 Report the value of multiple channels with the supplied timestamp.
 

Detailed Description

Sending analog reports from a device in your plugin.

Function Documentation

§ osvrDeviceAnalogConfigure()

OSVR_PLUGINKIT_EXPORT OSVR_ReturnCode osvrDeviceAnalogConfigure ( OSVR_INOUT_PTR OSVR_DeviceInitOptions  opts,
OSVR_OUT_PTR OSVR_AnalogDeviceInterface iface,
OSVR_IN OSVR_ChannelCount  numChan 
)

Specify that your device will implement the Analog 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 analog interface.
numChanThe number of channels you will be reporting. This parameter may be subject to external limitations (presently 128).