OSVR-Core  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Analog channel interface (base C API)

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

Typedefs

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

Functions

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

Detailed Description

Sending analog reports from a device in your plugin.

Function Documentation

OSVR_ReturnCode osvrDeviceAnalogConfigure ( OSVR_DeviceInitOptions  opts,
OSVR_AnalogDeviceInterface iface,
OSVR_ChannelCount  numChan 
)

#include <osvr/PluginKit/AnalogInterfaceC.h>

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).