Class VRDevice

The top level class the manages the VRDevice infrastructure.

Inheritance
System.Object
VRDevice
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Liminal.SDK.VR
Assembly: Liminal.SDK.dll
Syntax
public static class VRDevice

Properties

| Improve this Doc View Source

Device

Gets the current IVRDevice. Returns null if there are no active devices.

Declaration
public static IVRDevice Device { get; }
Property Value
Type Description
IVRDevice
| Improve this Doc View Source

DeviceName

Gets the name of the connected IVRDevice. Returns null if no devices are connected.

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

HasDevice

Indicates if an IVRDevice has been assigned.

Declaration
public static bool HasDevice { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsInitialized

Indicates if the the VRDevice framework has been initialized.

Declaration
public static bool IsInitialized { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsUserPresent

Determines the presence state of the user. Not all VR devices support this feature and may return a value of UnityEngine.XR.UserPresenceState.Unsupported.

Declaration
public static UserPresenceState IsUserPresent { get; }
Property Value
Type Description
UnityEngine.XR.UserPresenceState
| Improve this Doc View Source

RefreshRate

Gets the refresh rate of the connected VR device from Unity's XRDevice.

Declaration
public static float RefreshRate { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

XRModelName

Gets the model name of the connected from Unity's XRDevice.

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

XRTrackingSpaceType

Gets the tracking space type from Unity's XRDevice. Liminal recommends using the HasCapabilities(VRDeviceCapability) to determine tracking capabilities of the connected device.

Declaration
public static TrackingSpaceType XRTrackingSpaceType { get; }
Property Value
Type Description
UnityEngine.XR.TrackingSpaceType

Methods

| Improve this Doc View Source

Initialize(IVRDevice)

Initializes the VRDevice framework for the specified IVRDevice instance.

Declaration
public static void Initialize(IVRDevice device)
Parameters
Type Name Description
IVRDevice device

The IVRDevice to initialize.
| Improve this Doc View Source

LoadXRDevice(String)

Loads the specified VR device into Unity's XR support system.

Declaration
public static IEnumerator LoadXRDevice(string device)
Parameters
Type Name Description
System.String device
Returns
Type Description
System.Collections.IEnumerator

The loading task.

Events

| Improve this Doc View Source

Initialized

Raised when the VRDevice framework has completed initialization.

Declaration
public static event Action Initialized
Event Type
Type Description
System.Action