Interface IVRDevice

An interface representing a VR hardware device.

Namespace: Liminal.SDK.VR
Assembly: Liminal.SDK.dll
Syntax
public interface IVRDevice

Properties

| Improve this Doc View Source

Headset

Gets the IVRHeadset of the device.

Declaration
IVRHeadset Headset { get; }
Property Value
Type Description
IVRHeadset
| Improve this Doc View Source

InputDeviceCount

Gets the number of input devices currently connected.

Declaration
int InputDeviceCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

InputDevices

Gets an enumerable collection of IVRInputDevice objects currently connected.

Declaration
IEnumerable<IVRInputDevice> InputDevices { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IVRInputDevice>
| Improve this Doc View Source

Name

Gets the name of the device.

Declaration
string Name { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PrimaryInputDevice

Gets the primary input device, if connected and available.

Declaration
IVRInputDevice PrimaryInputDevice { get; }
Property Value
Type Description
IVRInputDevice
| Improve this Doc View Source

SecondaryInputDevice

Gets the secondary input device, if connected and available.

Declaration
IVRInputDevice SecondaryInputDevice { get; }
Property Value
Type Description
IVRInputDevice

Methods

| Improve this Doc View Source

HasCapabilities(VRDeviceCapability)

Indicates if the device has a specific set of capabilities. This method returns true only if ALL values within the capabilities bitmask are available on the device.

Declaration
bool HasCapabilities(VRDeviceCapability capabilities)
Parameters
Type Name Description
VRDeviceCapability capabilities

The capabilities to check. This value is a bitmask of VRDeviceCapability values.
Returns
Type Description
System.Boolean

A boolean indicating if the device has ALL the capabilities specified by the capabilities bitmask.
| Improve this Doc View Source

SetupAvatar(IVRAvatar)

[Internal use] Sets up an IVRAvatar instance for this device. You should not have to call this manually.

Declaration
void SetupAvatar(IVRAvatar avatar)
Parameters
Type Name Description
IVRAvatar avatar

The IVRAvatar instance to bind to the device.
| Improve this Doc View Source

Update()

[Internal use] Updates the state of the device. You do not have to call this manually.

Declaration
void Update()

Events

| Improve this Doc View Source

InputDeviceConnected

Raised when a IVRInputDevice is connected.

Declaration
event VRInputDeviceEventHandler InputDeviceConnected
Event Type
Type Description
VRInputDeviceEventHandler
| Improve this Doc View Source

InputDeviceDisconnected

Raised when a IVRInputDevice is disconnected.

Declaration
event VRInputDeviceEventHandler InputDeviceDisconnected
Event Type
Type Description
VRInputDeviceEventHandler
| Improve this Doc View Source

PrimaryInputDeviceChanged

Raised when the primary IVRInputDevice has changed.

Declaration
event VRDeviceEventHandler PrimaryInputDeviceChanged
Event Type
Type Description
VRDeviceEventHandler

Extension Methods