IDevice Interface |
[This is preliminary documentation and is subject to change.]
Uniform interface to all device objects.
Namespace: RavingBots.MultiInput
Assembly: RavingBots.MultiInput (in RavingBots.MultiInput.dll) Version: 0.12
SyntaxC#
public interface IDevice
The IDevice type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CanVibrate | true if device supports vibration.
|
| Id |
A session-unique ID of this device.
|
| InternalName |
Value containing internal name/ID of the device reported by the OS.
|
| IsUsable | true if device is usable. The exact meaning of this is device-specific,
but unusable devices should not be considered when checking for input.
|
| Item |
Returns a virtual axis object or null if the axis is not supported by this device.
|
| Location |
Value describing the bus location of the device.
|
| Name |
Friendly name of this device.
|
| ProductId |
Product ID reported by the device/driver.
|
| Revision |
Revision/version reported by the device/driver.
|
| Serial |
Serial number reported by the device/driver.
|
| SupportedAxes |
Enumerable of all axes this device supports.
|
| VendorId |
Vendor ID reported by the device/driver.
|
Methods| Name | Description | |
|---|---|---|
 | Reset |
Resets the state of all axes on this device.
|
| Vibrate |
Makes this device vibrate for specified amount of time.
|
Remarks
This interface is one of the two core abstractions in Multi-Input (the other one
being IVirtualAxis). Most of your interaction with this library will
be through device objects and this interface.
 Note |
|---|
| We plan to make comprehensive API for extending the library with your own devices, but all of the internal machinery is still in flux and might change as we expand the device and platform support. |
Thread SafetyStatic members of this type are not safe for multi-threaded operations. Instance members of this type are not safe for multi-threaded operations.
See Also