Show / Hide Table of Contents

    Class SteamVR

    Inheritance
    System.Object
    SteamVR
    Implements
    System.IDisposable
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Valve.VR
    Assembly: Assembly-CSharp.dll
    Syntax
    public class SteamVR : IDisposable

    Fields

    connected

    Declaration
    public static bool[] connected
    Field Value
    Type Description
    System.Boolean[]

    defaultAppKeyTemplate

    Declaration
    public const string defaultAppKeyTemplate = "application.generated.{0}"
    Field Value
    Type Description
    System.String

    defaultUnityAppKeyTemplate

    Declaration
    public const string defaultUnityAppKeyTemplate = "application.generated.unity.{0}.exe"
    Field Value
    Type Description
    System.String

    initializedState

    Declaration
    public static SteamVR.InitializedStates initializedState
    Field Value
    Type Description
    SteamVR.InitializedStates

    textureType

    Declaration
    public ETextureType textureType
    Field Value
    Type Description
    ETextureType

    Properties

    active

    Declaration
    public static bool active { get; }
    Property Value
    Type Description
    System.Boolean

    aspect

    Declaration
    public float aspect { get; }
    Property Value
    Type Description
    System.Single

    calibrating

    Declaration
    public static bool calibrating { get; }
    Property Value
    Type Description
    System.Boolean

    compositor

    Declaration
    public CVRCompositor compositor { get; }
    Property Value
    Type Description
    CVRCompositor

    enabled

    Declaration
    public static bool enabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    eyes

    Declaration
    public SteamVR_Utils.RigidTransform[] eyes { get; }
    Property Value
    Type Description
    SteamVR_Utils.RigidTransform[]

    fieldOfView

    Declaration
    public float fieldOfView { get; }
    Property Value
    Type Description
    System.Single

    hmd

    Declaration
    public CVRSystem hmd { get; }
    Property Value
    Type Description
    CVRSystem

    hmd_DisplayFrequency

    Declaration
    public float hmd_DisplayFrequency { get; }
    Property Value
    Type Description
    System.Single

    hmd_ModelNumber

    Declaration
    public string hmd_ModelNumber { get; }
    Property Value
    Type Description
    System.String

    hmd_SecondsFromVsyncToPhotons

    Declaration
    public float hmd_SecondsFromVsyncToPhotons { get; }
    Property Value
    Type Description
    System.Single

    hmd_SerialNumber

    Declaration
    public string hmd_SerialNumber { get; }
    Property Value
    Type Description
    System.String

    hmd_TrackingSystemName

    Declaration
    public string hmd_TrackingSystemName { get; }
    Property Value
    Type Description
    System.String

    initializing

    Declaration
    public static bool initializing { get; }
    Property Value
    Type Description
    System.Boolean

    instance

    Declaration
    public static SteamVR instance { get; }
    Property Value
    Type Description
    SteamVR

    outOfRange

    Declaration
    public static bool outOfRange { get; }
    Property Value
    Type Description
    System.Boolean

    overlay

    Declaration
    public CVROverlay overlay { get; }
    Property Value
    Type Description
    CVROverlay

    sceneHeight

    Declaration
    public float sceneHeight { get; }
    Property Value
    Type Description
    System.Single

    sceneWidth

    Declaration
    public float sceneWidth { get; }
    Property Value
    Type Description
    System.Single

    settings

    Declaration
    public static SteamVR_Settings settings { get; }
    Property Value
    Type Description
    SteamVR_Settings

    tanHalfFov

    Declaration
    public Vector2 tanHalfFov { get; }
    Property Value
    Type Description
    UnityEngine.Vector2

    textureBounds

    Declaration
    public VRTextureBounds_t[] textureBounds { get; }
    Property Value
    Type Description
    VRTextureBounds_t[]

    usingNativeSupport

    Declaration
    public static bool usingNativeSupport { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Dispose()

    Declaration
    public void Dispose()

    ExitTemporarySession()

    Declaration
    public static void ExitTemporarySession()

    Finalize()

    Declaration
    protected void Finalize()

    GenerateAppKey()

    Declaration
    public static string GenerateAppKey()
    Returns
    Type Description
    System.String

    GenerateCleanProductName()

    Declaration
    public static string GenerateCleanProductName()
    Returns
    Type Description
    System.String

    GetFloatProperty(ETrackedDeviceProperty, UInt32)

    Declaration
    public float GetFloatProperty(ETrackedDeviceProperty prop, uint deviceId = 0U)
    Parameters
    Type Name Description
    ETrackedDeviceProperty prop
    System.UInt32 deviceId
    Returns
    Type Description
    System.Single

    GetResourcesFolderPath(Boolean)

    Declaration
    public static string GetResourcesFolderPath(bool fromAssetsDirectory = false)
    Parameters
    Type Name Description
    System.Boolean fromAssetsDirectory
    Returns
    Type Description
    System.String

    GetStringProperty(ETrackedDeviceProperty, UInt32)

    Declaration
    public string GetStringProperty(ETrackedDeviceProperty prop, uint deviceId = 0U)
    Parameters
    Type Name Description
    ETrackedDeviceProperty prop
    System.UInt32 deviceId
    Returns
    Type Description
    System.String

    GetTrackedDeviceString(UInt32)

    Declaration
    public string GetTrackedDeviceString(uint deviceId)
    Parameters
    Type Name Description
    System.UInt32 deviceId
    Returns
    Type Description
    System.String

    Initialize(Boolean)

    Declaration
    public static void Initialize(bool forceUnityVRMode = false)
    Parameters
    Type Name Description
    System.Boolean forceUnityVRMode

    InitializeTemporarySession(Boolean)

    Declaration
    public static bool InitializeTemporarySession(bool initInput = false)
    Parameters
    Type Name Description
    System.Boolean initInput
    Returns
    Type Description
    System.Boolean

    SafeDispose()

    Declaration
    public static void SafeDispose()

    ShowBindingsForEditor()

    Declaration
    public static void ShowBindingsForEditor()

    Implements

    System.IDisposable
    In This Article
    • Fields
      • connected
      • defaultAppKeyTemplate
      • defaultUnityAppKeyTemplate
      • initializedState
      • textureType
    • Properties
      • active
      • aspect
      • calibrating
      • compositor
      • enabled
      • eyes
      • fieldOfView
      • hmd
      • hmd_DisplayFrequency
      • hmd_ModelNumber
      • hmd_SecondsFromVsyncToPhotons
      • hmd_SerialNumber
      • hmd_TrackingSystemName
      • initializing
      • instance
      • outOfRange
      • overlay
      • sceneHeight
      • sceneWidth
      • settings
      • tanHalfFov
      • textureBounds
      • usingNativeSupport
    • Methods
      • Dispose()
      • ExitTemporarySession()
      • Finalize()
      • GenerateAppKey()
      • GenerateCleanProductName()
      • GetFloatProperty(ETrackedDeviceProperty, UInt32)
      • GetResourcesFolderPath(Boolean)
      • GetStringProperty(ETrackedDeviceProperty, UInt32)
      • GetTrackedDeviceString(UInt32)
      • Initialize(Boolean)
      • InitializeTemporarySession(Boolean)
      • SafeDispose()
      • ShowBindingsForEditor()
    • Implements
    Back to top Copyright (c) Valve Corporation, All rights reserved.