OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Button channel interface (base C API)

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

Typedefs

typedef struct
OSVR_ButtonDeviceInterfaceObject
OSVR_ButtonDeviceInterface
 Opaque type used in conjunction with a device token to send data on a button interface.
 

Functions

OSVR_ReturnCode osvrDeviceButtonConfigure (OSVR_DeviceInitOptions opts, OSVR_ButtonDeviceInterface *iface, OSVR_ChannelCount numChan)
 Specify that your device will implement the Button interface. More...
 
OSVR_ReturnCode osvrDeviceButtonSetValue (OSVR_DeviceToken dev, OSVR_ButtonDeviceInterface iface, OSVR_ButtonState val, OSVR_ChannelCount chan)
 Report the value of a single channel.
 
OSVR_ReturnCode osvrDeviceButtonSetValueTimestamped (OSVR_DeviceToken dev, OSVR_ButtonDeviceInterface iface, OSVR_ButtonState val, OSVR_ChannelCount chan, OSVR_TimeValue const *timestamp)
 Report the value of a single channel with the supplied timestamp.
 
OSVR_ReturnCode osvrDeviceButtonSetValues (OSVR_DeviceToken dev, OSVR_ButtonDeviceInterface iface, OSVR_ButtonState val[], OSVR_ChannelCount chans)
 Report the value of multiple channels.
 
OSVR_ReturnCode osvrDeviceButtonSetValuesTimestamped (OSVR_DeviceToken dev, OSVR_ButtonDeviceInterface iface, OSVR_ButtonState val[], OSVR_ChannelCount chans, OSVR_TimeValue const *timestamp)
 Report the value of multiple channels with the supplied timestamp.
 

Detailed Description

Sending button reports from a device in your plugin.

Function Documentation

OSVR_ReturnCode osvrDeviceButtonConfigure ( OSVR_DeviceInitOptions  opts,
OSVR_ButtonDeviceInterface iface,
OSVR_ChannelCount  numChan 
)

#include <osvr/PluginKit/ButtonInterfaceC.h>

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

Definition at line 46 of file ButtonInterfaceC.cpp.