vr Namespace Reference

Classes
struct	HmdMatrix34_t
struct	HmdMatrix44_t
struct	HmdVector3_t
struct	HmdVector4_t
struct	HmdVector3d_t
struct	HmdVector2_t
struct	HmdQuaternion_t
struct	HmdColor_t
struct	HmdQuad_t
struct	HmdRect2_t
struct	DistortionCoordinates_t
struct	Texture_t
struct	TrackedDevicePose_t
struct	VRTextureBounds_t
struct	VRTextureWithPose_t
struct	VRTextureDepthInfo_t
struct	VRTextureWithDepth_t
struct	VRTextureWithPoseAndDepth_t
struct	VRVulkanTextureData_t
struct	D3D12TextureData_t
struct	VREvent_Controller_t
struct	VREvent_Mouse_t
struct	VREvent_Scroll_t
struct	VREvent_TouchPadMove_t
struct	VREvent_Notification_t
struct	VREvent_Process_t
struct	VREvent_Overlay_t
struct	VREvent_Status_t
struct	VREvent_Keyboard_t
struct	VREvent_Ipd_t
struct	VREvent_Chaperone_t
struct	VREvent_Reserved_t
struct	VREvent_PerformanceTest_t
struct	VREvent_SeatedZeroPoseReset_t
struct	VREvent_Screenshot_t
struct	VREvent_ScreenshotProgress_t
struct	VREvent_ApplicationLaunch_t
struct	VREvent_EditingCameraSurface_t
struct	VREvent_MessageOverlay_t
struct	VREvent_Property_t
struct	VREvent_DualAnalog_t
struct	VREvent_HapticVibration_t
union	VREvent_Data_t
struct	VREvent_t
struct	HiddenAreaMesh_t
struct	VRControllerAxis_t
struct	VRControllerState001_t
struct	Compositor_OverlaySettings
struct	CameraVideoStreamFrameHeader_t
struct	DriverDirectMode_FrameTiming
struct	VR_IVRSystem_FnTable
class	IVRSystem
struct	AppOverrideKeys_t
struct	VR_IVRApplications_FnTable
class	IVRApplications
struct	VR_IVRSettings_FnTable
class	IVRSettings
struct	VR_IVRChaperone_FnTable
class	IVRChaperone
struct	VR_IVRChaperoneSetup_FnTable
class	IVRChaperoneSetup
struct	Compositor_FrameTiming
struct	Compositor_CumulativeStats
struct	VR_IVRCompositor_FnTable
class	IVRCompositor
struct	NotificationBitmap_t
struct	VR_IVRNotifications_FnTable
class	IVRNotifications
struct	VROverlayIntersectionParams_t
struct	VROverlayIntersectionResults_t
struct	IntersectionMaskRectangle_t
struct	IntersectionMaskCircle_t
union	VROverlayIntersectionMaskPrimitive_Data_t
struct	VROverlayIntersectionMaskPrimitive_t
struct	VR_IVROverlay_FnTable
class	IVROverlay
struct	RenderModel_ComponentState_t
struct	RenderModel_Vertex_t
struct	RenderModel_TextureMap_t
struct	RenderModel_t
struct	RenderModel_ControllerMode_State_t
struct	VR_IVRRenderModels_FnTable
class	IVRRenderModels
struct	VR_IVRExtendedDisplay_FnTable
class	IVRExtendedDisplay
struct	VR_IVRTrackedCamera_FnTable
class	IVRTrackedCamera
struct	VR_IVRScreenshots_FnTable
class	IVRScreenshots
struct	VR_IVRResources_FnTable
class	IVRResources
struct	VR_IVRDriverManager_FnTable
class	IVRDriverManager
class	COpenVRContext

Typedefs
typedef void *	glSharedTextureHandle_t
typedef int32_t	glInt_t
typedef uint32_t	glUInt_t
typedef uint64_t	SharedTextureHandle_t
typedef uint32_t	DriverId_t
typedef uint32_t	TrackedDeviceIndex_t
typedef uint64_t	PropertyContainerHandle_t
typedef uint32_t	PropertyTypeTag_t
typedef VRControllerState001_t	VRControllerState_t
typedef uint64_t	VROverlayHandle_t
typedef uint64_t	TrackedCameraHandle_t
typedef uint32_t	ScreenshotHandle_t
typedef uint32_t	VRNotificationId
typedef uint32_t	VRComponentProperties
typedef int32_t	TextureID_t
typedef EVRInitError	HmdError
typedef EVREye	Hmd_Eye
typedef EColorSpace	ColorSpace
typedef ETrackingResult	HmdTrackingResult
typedef ETrackedDeviceClass	TrackedDeviceClass
typedef ETrackingUniverseOrigin	TrackingUniverseOrigin
typedef ETrackedDeviceProperty	TrackedDeviceProperty
typedef ETrackedPropertyError	TrackedPropertyError
typedef EVRSubmitFlags	VRSubmitFlags_t
typedef EVRState	VRState_t
typedef ECollisionBoundsStyle	CollisionBoundsStyle_t
typedef EVROverlayError	VROverlayError
typedef EVRFirmwareError	VRFirmwareError
typedef EVRCompositorError	VRCompositorError
typedef EVRScreenshotError	VRScreenshotsError

Enumerations
enum	EVREye { Eye_Left = 0 , Eye_Right = 1 }
enum	ETextureType {   TextureType_DirectX = 0 , TextureType_OpenGL = 1 , TextureType_Vulkan = 2 , TextureType_IOSurface = 3 ,   TextureType_DirectX12 = 4 }
enum	EColorSpace { ColorSpace_Auto = 0 , ColorSpace_Gamma = 1 , ColorSpace_Linear = 2 }
enum	ETrackingResult {   TrackingResult_Uninitialized = 1 , TrackingResult_Calibrating_InProgress = 100 , TrackingResult_Calibrating_OutOfRange = 101 , TrackingResult_Running_OK = 200 ,   TrackingResult_Running_OutOfRange = 201 }
enum	ETrackedDeviceClass {   TrackedDeviceClass_Invalid = 0 , TrackedDeviceClass_HMD = 1 , TrackedDeviceClass_Controller = 2 , TrackedDeviceClass_GenericTracker = 3 ,   TrackedDeviceClass_TrackingReference = 4 , TrackedDeviceClass_DisplayRedirect = 5 }
enum	ETrackedControllerRole { TrackedControllerRole_Invalid = 0 , TrackedControllerRole_LeftHand = 1 , TrackedControllerRole_RightHand = 2 }
enum	ETrackingUniverseOrigin { TrackingUniverseSeated = 0 , TrackingUniverseStanding = 1 , TrackingUniverseRawAndUncalibrated = 2 }
enum	ETrackedDeviceProperty {   Prop_Invalid = 0 , Prop_TrackingSystemName_String = 1000 , Prop_ModelNumber_String = 1001 , Prop_SerialNumber_String = 1002 ,   Prop_RenderModelName_String = 1003 , Prop_WillDriftInYaw_Bool = 1004 , Prop_ManufacturerName_String = 1005 , Prop_TrackingFirmwareVersion_String = 1006 ,   Prop_HardwareRevision_String = 1007 , Prop_AllWirelessDongleDescriptions_String = 1008 , Prop_ConnectedWirelessDongle_String = 1009 , Prop_DeviceIsWireless_Bool = 1010 ,   Prop_DeviceIsCharging_Bool = 1011 , Prop_DeviceBatteryPercentage_Float = 1012 , Prop_StatusDisplayTransform_Matrix34 = 1013 , Prop_Firmware_UpdateAvailable_Bool = 1014 ,   Prop_Firmware_ManualUpdate_Bool = 1015 , Prop_Firmware_ManualUpdateURL_String = 1016 , Prop_HardwareRevision_Uint64 = 1017 , Prop_FirmwareVersion_Uint64 = 1018 ,   Prop_FPGAVersion_Uint64 = 1019 , Prop_VRCVersion_Uint64 = 1020 , Prop_RadioVersion_Uint64 = 1021 , Prop_DongleVersion_Uint64 = 1022 ,   Prop_BlockServerShutdown_Bool = 1023 , Prop_CanUnifyCoordinateSystemWithHmd_Bool = 1024 , Prop_ContainsProximitySensor_Bool = 1025 , Prop_DeviceProvidesBatteryStatus_Bool = 1026 ,   Prop_DeviceCanPowerOff_Bool = 1027 , Prop_Firmware_ProgrammingTarget_String = 1028 , Prop_DeviceClass_Int32 = 1029 , Prop_HasCamera_Bool = 1030 ,   Prop_DriverVersion_String = 1031 , Prop_Firmware_ForceUpdateRequired_Bool = 1032 , Prop_ViveSystemButtonFixRequired_Bool = 1033 , Prop_ParentDriver_Uint64 = 1034 ,   Prop_ResourceRoot_String = 1035 , Prop_RegisteredDeviceType_String = 1036 , Prop_InputProfilePath_String = 1037 , Prop_ReportsTimeSinceVSync_Bool = 2000 ,   Prop_SecondsFromVsyncToPhotons_Float = 2001 , Prop_DisplayFrequency_Float = 2002 , Prop_UserIpdMeters_Float = 2003 , Prop_CurrentUniverseId_Uint64 = 2004 ,   Prop_PreviousUniverseId_Uint64 = 2005 , Prop_DisplayFirmwareVersion_Uint64 = 2006 , Prop_IsOnDesktop_Bool = 2007 , Prop_DisplayMCType_Int32 = 2008 ,   Prop_DisplayMCOffset_Float = 2009 , Prop_DisplayMCScale_Float = 2010 , Prop_EdidVendorID_Int32 = 2011 , Prop_DisplayMCImageLeft_String = 2012 ,   Prop_DisplayMCImageRight_String = 2013 , Prop_DisplayGCBlackClamp_Float = 2014 , Prop_EdidProductID_Int32 = 2015 , Prop_CameraToHeadTransform_Matrix34 = 2016 ,   Prop_DisplayGCType_Int32 = 2017 , Prop_DisplayGCOffset_Float = 2018 , Prop_DisplayGCScale_Float = 2019 , Prop_DisplayGCPrescale_Float = 2020 ,   Prop_DisplayGCImage_String = 2021 , Prop_LensCenterLeftU_Float = 2022 , Prop_LensCenterLeftV_Float = 2023 , Prop_LensCenterRightU_Float = 2024 ,   Prop_LensCenterRightV_Float = 2025 , Prop_UserHeadToEyeDepthMeters_Float = 2026 , Prop_CameraFirmwareVersion_Uint64 = 2027 , Prop_CameraFirmwareDescription_String = 2028 ,   Prop_DisplayFPGAVersion_Uint64 = 2029 , Prop_DisplayBootloaderVersion_Uint64 = 2030 , Prop_DisplayHardwareVersion_Uint64 = 2031 , Prop_AudioFirmwareVersion_Uint64 = 2032 ,   Prop_CameraCompatibilityMode_Int32 = 2033 , Prop_ScreenshotHorizontalFieldOfViewDegrees_Float = 2034 , Prop_ScreenshotVerticalFieldOfViewDegrees_Float = 2035 , Prop_DisplaySuppressed_Bool = 2036 ,   Prop_DisplayAllowNightMode_Bool = 2037 , Prop_DisplayMCImageWidth_Int32 = 2038 , Prop_DisplayMCImageHeight_Int32 = 2039 , Prop_DisplayMCImageNumChannels_Int32 = 2040 ,   Prop_DisplayMCImageData_Binary = 2041 , Prop_SecondsFromPhotonsToVblank_Float = 2042 , Prop_DriverDirectModeSendsVsyncEvents_Bool = 2043 , Prop_DisplayDebugMode_Bool = 2044 ,   Prop_GraphicsAdapterLuid_Uint64 = 2045 , Prop_DriverProvidedChaperonePath_String = 2048 , Prop_ExpectedTrackingReferenceCount_Int32 = 2049 , Prop_ExpectedControllerCount_Int32 = 2050 ,   Prop_NamedIconPathControllerLeftDeviceOff_String = 2051 , Prop_NamedIconPathControllerRightDeviceOff_String = 2052 , Prop_NamedIconPathTrackingReferenceDeviceOff_String = 2053 , Prop_DoNotApplyPrediction_Bool = 2054 ,   Prop_CameraToHeadTransforms_Matrix34_Array = 2055 , Prop_DriverIsDrawingControllers_Bool = 2057 , Prop_DriverRequestsApplicationPause_Bool = 2058 , Prop_DriverRequestsReducedRendering_Bool = 2059 ,   Prop_AttachedDeviceId_String = 3000 , Prop_SupportedButtons_Uint64 = 3001 , Prop_Axis0Type_Int32 = 3002 , Prop_Axis1Type_Int32 = 3003 ,   Prop_Axis2Type_Int32 = 3004 , Prop_Axis3Type_Int32 = 3005 , Prop_Axis4Type_Int32 = 3006 , Prop_ControllerRoleHint_Int32 = 3007 ,   Prop_FieldOfViewLeftDegrees_Float = 4000 , Prop_FieldOfViewRightDegrees_Float = 4001 , Prop_FieldOfViewTopDegrees_Float = 4002 , Prop_FieldOfViewBottomDegrees_Float = 4003 ,   Prop_TrackingRangeMinimumMeters_Float = 4004 , Prop_TrackingRangeMaximumMeters_Float = 4005 , Prop_ModeLabel_String = 4006 , Prop_IconPathName_String = 5000 ,   Prop_NamedIconPathDeviceOff_String = 5001 , Prop_NamedIconPathDeviceSearching_String = 5002 , Prop_NamedIconPathDeviceSearchingAlert_String = 5003 , Prop_NamedIconPathDeviceReady_String = 5004 ,   Prop_NamedIconPathDeviceReadyAlert_String = 5005 , Prop_NamedIconPathDeviceNotReady_String = 5006 , Prop_NamedIconPathDeviceStandby_String = 5007 , Prop_NamedIconPathDeviceAlertLow_String = 5008 ,   Prop_DisplayHiddenArea_Binary_Start = 5100 , Prop_DisplayHiddenArea_Binary_End = 5150 , Prop_ParentContainer = 5151 , Prop_UserConfigPath_String = 6000 ,   Prop_InstallPath_String = 6001 , Prop_HasDisplayComponent_Bool = 6002 , Prop_HasControllerComponent_Bool = 6003 , Prop_HasCameraComponent_Bool = 6004 ,   Prop_HasDriverDirectModeComponent_Bool = 6005 , Prop_HasVirtualDisplayComponent_Bool = 6006 , Prop_ControllerType_String = 7000 , Prop_LegacyInputProfile_String = 7001 ,   Prop_VendorSpecific_Reserved_Start = 10000 , Prop_VendorSpecific_Reserved_End = 10999 , Prop_TrackedDeviceProperty_Max = 1000000 }
enum	ETrackedPropertyError {   TrackedProp_Success = 0 , TrackedProp_WrongDataType = 1 , TrackedProp_WrongDeviceClass = 2 , TrackedProp_BufferTooSmall = 3 ,   TrackedProp_UnknownProperty = 4 , TrackedProp_InvalidDevice = 5 , TrackedProp_CouldNotContactServer = 6 , TrackedProp_ValueNotProvidedByDevice = 7 ,   TrackedProp_StringExceedsMaximumLength = 8 , TrackedProp_NotYetAvailable = 9 , TrackedProp_PermissionDenied = 10 , TrackedProp_InvalidOperation = 11 ,   TrackedProp_CannotWriteToWildcards = 12 }
enum	EVRSubmitFlags {   Submit_Default = 0x00 , Submit_LensDistortionAlreadyApplied = 0x01 , Submit_GlRenderBuffer = 0x02 , Submit_Reserved = 0x04 ,   Submit_TextureWithPose = 0x08 , Submit_TextureWithDepth = 0x10 }
enum	EVRState {   VRState_Undefined = -1 , VRState_Off = 0 , VRState_Searching = 1 , VRState_Searching_Alert = 2 ,   VRState_Ready = 3 , VRState_Ready_Alert = 4 , VRState_NotReady = 5 , VRState_Standby = 6 ,   VRState_Ready_Alert_Low = 7 }
enum	EVREventType {   VREvent_None = 0 , VREvent_TrackedDeviceActivated = 100 , VREvent_TrackedDeviceDeactivated = 101 , VREvent_TrackedDeviceUpdated = 102 ,   VREvent_TrackedDeviceUserInteractionStarted = 103 , VREvent_TrackedDeviceUserInteractionEnded = 104 , VREvent_IpdChanged = 105 , VREvent_EnterStandbyMode = 106 ,   VREvent_LeaveStandbyMode = 107 , VREvent_TrackedDeviceRoleChanged = 108 , VREvent_WatchdogWakeUpRequested = 109 , VREvent_LensDistortionChanged = 110 ,   VREvent_PropertyChanged = 111 , VREvent_WirelessDisconnect = 112 , VREvent_WirelessReconnect = 113 , VREvent_ButtonPress = 200 ,   VREvent_ButtonUnpress = 201 , VREvent_ButtonTouch = 202 , VREvent_ButtonUntouch = 203 , VREvent_DualAnalog_Press = 250 ,   VREvent_DualAnalog_Unpress = 251 , VREvent_DualAnalog_Touch = 252 , VREvent_DualAnalog_Untouch = 253 , VREvent_DualAnalog_Move = 254 ,   VREvent_DualAnalog_ModeSwitch1 = 255 , VREvent_DualAnalog_ModeSwitch2 = 256 , VREvent_DualAnalog_Cancel = 257 , VREvent_MouseMove = 300 ,   VREvent_MouseButtonDown = 301 , VREvent_MouseButtonUp = 302 , VREvent_FocusEnter = 303 , VREvent_FocusLeave = 304 ,   VREvent_Scroll = 305 , VREvent_TouchPadMove = 306 , VREvent_OverlayFocusChanged = 307 , VREvent_InputFocusCaptured = 400 ,   VREvent_InputFocusReleased = 401 , VREvent_SceneFocusLost = 402 , VREvent_SceneFocusGained = 403 , VREvent_SceneApplicationChanged = 404 ,   VREvent_SceneFocusChanged = 405 , VREvent_InputFocusChanged = 406 , VREvent_SceneApplicationSecondaryRenderingStarted = 407 , VREvent_HideRenderModels = 410 ,   VREvent_ShowRenderModels = 411 , VREvent_ConsoleOpened = 420 , VREvent_ConsoleClosed = 421 , VREvent_OverlayShown = 500 ,   VREvent_OverlayHidden = 501 , VREvent_DashboardActivated = 502 , VREvent_DashboardDeactivated = 503 , VREvent_DashboardThumbSelected = 504 ,   VREvent_DashboardRequested = 505 , VREvent_ResetDashboard = 506 , VREvent_RenderToast = 507 , VREvent_ImageLoaded = 508 ,   VREvent_ShowKeyboard = 509 , VREvent_HideKeyboard = 510 , VREvent_OverlayGamepadFocusGained = 511 , VREvent_OverlayGamepadFocusLost = 512 ,   VREvent_OverlaySharedTextureChanged = 513 , VREvent_DashboardGuideButtonDown = 514 , VREvent_DashboardGuideButtonUp = 515 , VREvent_ScreenshotTriggered = 516 ,   VREvent_ImageFailed = 517 , VREvent_DashboardOverlayCreated = 518 , VREvent_RequestScreenshot = 520 , VREvent_ScreenshotTaken = 521 ,   VREvent_ScreenshotFailed = 522 , VREvent_SubmitScreenshotToDashboard = 523 , VREvent_ScreenshotProgressToDashboard = 524 , VREvent_PrimaryDashboardDeviceChanged = 525 ,   VREvent_Notification_Shown = 600 , VREvent_Notification_Hidden = 601 , VREvent_Notification_BeginInteraction = 602 , VREvent_Notification_Destroyed = 603 ,   VREvent_Quit = 700 , VREvent_ProcessQuit = 701 , VREvent_QuitAborted_UserPrompt = 702 , VREvent_QuitAcknowledged = 703 ,   VREvent_DriverRequestedQuit = 704 , VREvent_ChaperoneDataHasChanged = 800 , VREvent_ChaperoneUniverseHasChanged = 801 , VREvent_ChaperoneTempDataHasChanged = 802 ,   VREvent_ChaperoneSettingsHaveChanged = 803 , VREvent_SeatedZeroPoseReset = 804 , VREvent_AudioSettingsHaveChanged = 820 , VREvent_BackgroundSettingHasChanged = 850 ,   VREvent_CameraSettingsHaveChanged = 851 , VREvent_ReprojectionSettingHasChanged = 852 , VREvent_ModelSkinSettingsHaveChanged = 853 , VREvent_EnvironmentSettingsHaveChanged = 854 ,   VREvent_PowerSettingsHaveChanged = 855 , VREvent_EnableHomeAppSettingsHaveChanged = 856 , VREvent_SteamVRSectionSettingChanged = 857 , VREvent_LighthouseSectionSettingChanged = 858 ,   VREvent_NullSectionSettingChanged = 859 , VREvent_UserInterfaceSectionSettingChanged = 860 , VREvent_NotificationsSectionSettingChanged = 861 , VREvent_KeyboardSectionSettingChanged = 862 ,   VREvent_PerfSectionSettingChanged = 863 , VREvent_DashboardSectionSettingChanged = 864 , VREvent_WebInterfaceSectionSettingChanged = 865 , VREvent_StatusUpdate = 900 ,   VREvent_WebInterface_InstallDriverCompleted = 950 , VREvent_MCImageUpdated = 1000 , VREvent_FirmwareUpdateStarted = 1100 , VREvent_FirmwareUpdateFinished = 1101 ,   VREvent_KeyboardClosed = 1200 , VREvent_KeyboardCharInput = 1201 , VREvent_KeyboardDone = 1202 , VREvent_ApplicationTransitionStarted = 1300 ,   VREvent_ApplicationTransitionAborted = 1301 , VREvent_ApplicationTransitionNewAppStarted = 1302 , VREvent_ApplicationListUpdated = 1303 , VREvent_ApplicationMimeTypeLoad = 1304 ,   VREvent_ApplicationTransitionNewAppLaunchComplete = 1305 , VREvent_ProcessConnected = 1306 , VREvent_ProcessDisconnected = 1307 , VREvent_Compositor_MirrorWindowShown = 1400 ,   VREvent_Compositor_MirrorWindowHidden = 1401 , VREvent_Compositor_ChaperoneBoundsShown = 1410 , VREvent_Compositor_ChaperoneBoundsHidden = 1411 , VREvent_TrackedCamera_StartVideoStream = 1500 ,   VREvent_TrackedCamera_StopVideoStream = 1501 , VREvent_TrackedCamera_PauseVideoStream = 1502 , VREvent_TrackedCamera_ResumeVideoStream = 1503 , VREvent_TrackedCamera_EditingSurface = 1550 ,   VREvent_PerformanceTest_EnableCapture = 1600 , VREvent_PerformanceTest_DisableCapture = 1601 , VREvent_PerformanceTest_FidelityLevel = 1602 , VREvent_MessageOverlay_Closed = 1650 ,   VREvent_MessageOverlayCloseRequested = 1651 , VREvent_Input_HapticVibration = 1700 , VREvent_VendorSpecific_Reserved_Start = 10000 , VREvent_VendorSpecific_Reserved_End = 19999 }
enum	EDeviceActivityLevel {   k_EDeviceActivityLevel_Unknown = -1 , k_EDeviceActivityLevel_Idle = 0 , k_EDeviceActivityLevel_UserInteraction = 1 , k_EDeviceActivityLevel_UserInteraction_Timeout = 2 ,   k_EDeviceActivityLevel_Standby = 3 }
enum	EVRButtonId {   k_EButton_System = 0 , k_EButton_ApplicationMenu = 1 , k_EButton_Grip = 2 , k_EButton_DPad_Left = 3 ,   k_EButton_DPad_Up = 4 , k_EButton_DPad_Right = 5 , k_EButton_DPad_Down = 6 , k_EButton_A = 7 ,   k_EButton_ProximitySensor = 31 , k_EButton_Axis0 = 32 , k_EButton_Axis1 = 33 , k_EButton_Axis2 = 34 ,   k_EButton_Axis3 = 35 , k_EButton_Axis4 = 36 , k_EButton_SteamVR_Touchpad = k_EButton_Axis0 , k_EButton_SteamVR_Trigger = k_EButton_Axis1 ,   k_EButton_Dashboard_Back = k_EButton_Grip , k_EButton_Max = 64 }
enum	EVRMouseButton { VRMouseButton_Left = 0x0001 , VRMouseButton_Right = 0x0002 , VRMouseButton_Middle = 0x0004 }
enum	EDualAnalogWhich { k_EDualAnalog_Left = 0 , k_EDualAnalog_Right = 1 }
enum	EVRInputError {   VRInputError_None = 0 , VRInputError_NameNotFound = 1 , VRInputError_WrongType = 2 , VRInputError_InvalidHandle = 3 ,   VRInputError_InvalidParam = 4 , VRInputError_NoSteam = 5 , VRInputError_MaxCapacityReached = 6 , VRInputError_IPCError = 7 ,   VRInputError_NoActiveActionSet = 8 , VRInputError_InvalidDevice = 9 }
enum	EHiddenAreaMeshType { k_eHiddenAreaMesh_Standard = 0 , k_eHiddenAreaMesh_Inverse = 1 , k_eHiddenAreaMesh_LineLoop = 2 , k_eHiddenAreaMesh_Max = 3 }
enum	EVRControllerAxisType { k_eControllerAxis_None = 0 , k_eControllerAxis_TrackPad = 1 , k_eControllerAxis_Joystick = 2 , k_eControllerAxis_Trigger = 3 }
enum	EVRControllerEventOutputType { ControllerEventOutput_OSEvents = 0 , ControllerEventOutput_VREvents = 1 }
enum	ECollisionBoundsStyle {   COLLISION_BOUNDS_STYLE_BEGINNER = 0 , COLLISION_BOUNDS_STYLE_INTERMEDIATE , COLLISION_BOUNDS_STYLE_SQUARES , COLLISION_BOUNDS_STYLE_ADVANCED ,   COLLISION_BOUNDS_STYLE_NONE , COLLISION_BOUNDS_STYLE_COUNT }
enum	EVROverlayError {   VROverlayError_None = 0 , VROverlayError_UnknownOverlay = 10 , VROverlayError_InvalidHandle = 11 , VROverlayError_PermissionDenied = 12 ,   VROverlayError_OverlayLimitExceeded = 13 , VROverlayError_WrongVisibilityType = 14 , VROverlayError_KeyTooLong = 15 , VROverlayError_NameTooLong = 16 ,   VROverlayError_KeyInUse = 17 , VROverlayError_WrongTransformType = 18 , VROverlayError_InvalidTrackedDevice = 19 , VROverlayError_InvalidParameter = 20 ,   VROverlayError_ThumbnailCantBeDestroyed = 21 , VROverlayError_ArrayTooSmall = 22 , VROverlayError_RequestFailed = 23 , VROverlayError_InvalidTexture = 24 ,   VROverlayError_UnableToLoadFile = 25 , VROverlayError_KeyboardAlreadyInUse = 26 , VROverlayError_NoNeighbor = 27 , VROverlayError_TooManyMaskPrimitives = 29 ,   VROverlayError_BadMaskPrimitive = 30 , VROverlayError_TextureAlreadyLocked = 31 , VROverlayError_TextureLockCapacityReached = 32 , VROverlayError_TextureNotLocked = 33 }
enum	EVRApplicationType {   VRApplication_Other = 0 , VRApplication_Scene = 1 , VRApplication_Overlay = 2 , VRApplication_Background = 3 ,   VRApplication_Utility = 4 , VRApplication_VRMonitor = 5 , VRApplication_SteamWatchdog = 6 , VRApplication_Bootstrapper = 7 ,   VRApplication_Max }
enum	EVRFirmwareError { VRFirmwareError_None = 0 , VRFirmwareError_Success = 1 , VRFirmwareError_Fail = 2 }
enum	EVRNotificationError {   VRNotificationError_OK = 0 , VRNotificationError_InvalidNotificationId = 100 , VRNotificationError_NotificationQueueFull = 101 , VRNotificationError_InvalidOverlayHandle = 102 ,   VRNotificationError_SystemWithUserValueAlreadyExists = 103 }
enum	EVRInitError {   VRInitError_None = 0 , VRInitError_Unknown = 1 , VRInitError_Init_InstallationNotFound = 100 , VRInitError_Init_InstallationCorrupt = 101 ,   VRInitError_Init_VRClientDLLNotFound = 102 , VRInitError_Init_FileNotFound = 103 , VRInitError_Init_FactoryNotFound = 104 , VRInitError_Init_InterfaceNotFound = 105 ,   VRInitError_Init_InvalidInterface = 106 , VRInitError_Init_UserConfigDirectoryInvalid = 107 , VRInitError_Init_HmdNotFound = 108 , VRInitError_Init_NotInitialized = 109 ,   VRInitError_Init_PathRegistryNotFound = 110 , VRInitError_Init_NoConfigPath = 111 , VRInitError_Init_NoLogPath = 112 , VRInitError_Init_PathRegistryNotWritable = 113 ,   VRInitError_Init_AppInfoInitFailed = 114 , VRInitError_Init_Retry = 115 , VRInitError_Init_InitCanceledByUser = 116 , VRInitError_Init_AnotherAppLaunching = 117 ,   VRInitError_Init_SettingsInitFailed = 118 , VRInitError_Init_ShuttingDown = 119 , VRInitError_Init_TooManyObjects = 120 , VRInitError_Init_NoServerForBackgroundApp = 121 ,   VRInitError_Init_NotSupportedWithCompositor = 122 , VRInitError_Init_NotAvailableToUtilityApps = 123 , VRInitError_Init_Internal = 124 , VRInitError_Init_HmdDriverIdIsNone = 125 ,   VRInitError_Init_HmdNotFoundPresenceFailed = 126 , VRInitError_Init_VRMonitorNotFound = 127 , VRInitError_Init_VRMonitorStartupFailed = 128 , VRInitError_Init_LowPowerWatchdogNotSupported = 129 ,   VRInitError_Init_InvalidApplicationType = 130 , VRInitError_Init_NotAvailableToWatchdogApps = 131 , VRInitError_Init_WatchdogDisabledInSettings = 132 , VRInitError_Init_VRDashboardNotFound = 133 ,   VRInitError_Init_VRDashboardStartupFailed = 134 , VRInitError_Init_VRHomeNotFound = 135 , VRInitError_Init_VRHomeStartupFailed = 136 , VRInitError_Init_RebootingBusy = 137 ,   VRInitError_Init_FirmwareUpdateBusy = 138 , VRInitError_Init_FirmwareRecoveryBusy = 139 , VRInitError_Init_USBServiceBusy = 140 , VRInitError_Driver_Failed = 200 ,   VRInitError_Driver_Unknown = 201 , VRInitError_Driver_HmdUnknown = 202 , VRInitError_Driver_NotLoaded = 203 , VRInitError_Driver_RuntimeOutOfDate = 204 ,   VRInitError_Driver_HmdInUse = 205 , VRInitError_Driver_NotCalibrated = 206 , VRInitError_Driver_CalibrationInvalid = 207 , VRInitError_Driver_HmdDisplayNotFound = 208 ,   VRInitError_Driver_TrackedDeviceInterfaceUnknown = 209 , VRInitError_Driver_HmdDriverIdOutOfBounds = 211 , VRInitError_Driver_HmdDisplayMirrored = 212 , VRInitError_IPC_ServerInitFailed = 300 ,   VRInitError_IPC_ConnectFailed = 301 , VRInitError_IPC_SharedStateInitFailed = 302 , VRInitError_IPC_CompositorInitFailed = 303 , VRInitError_IPC_MutexInitFailed = 304 ,   VRInitError_IPC_Failed = 305 , VRInitError_IPC_CompositorConnectFailed = 306 , VRInitError_IPC_CompositorInvalidConnectResponse = 307 , VRInitError_IPC_ConnectFailedAfterMultipleAttempts = 308 ,   VRInitError_Compositor_Failed = 400 , VRInitError_Compositor_D3D11HardwareRequired = 401 , VRInitError_Compositor_FirmwareRequiresUpdate = 402 , VRInitError_Compositor_OverlayInitFailed = 403 ,   VRInitError_Compositor_ScreenshotsInitFailed = 404 , VRInitError_Compositor_UnableToCreateDevice = 405 , VRInitError_VendorSpecific_UnableToConnectToOculusRuntime = 1000 , VRInitError_VendorSpecific_WindowsNotInDevMode = 1001 ,   VRInitError_VendorSpecific_HmdFound_CantOpenDevice = 1101 , VRInitError_VendorSpecific_HmdFound_UnableToRequestConfigStart = 1102 , VRInitError_VendorSpecific_HmdFound_NoStoredConfig = 1103 , VRInitError_VendorSpecific_HmdFound_ConfigTooBig = 1104 ,   VRInitError_VendorSpecific_HmdFound_ConfigTooSmall = 1105 , VRInitError_VendorSpecific_HmdFound_UnableToInitZLib = 1106 , VRInitError_VendorSpecific_HmdFound_CantReadFirmwareVersion = 1107 , VRInitError_VendorSpecific_HmdFound_UnableToSendUserDataStart = 1108 ,   VRInitError_VendorSpecific_HmdFound_UnableToGetUserDataStart = 1109 , VRInitError_VendorSpecific_HmdFound_UnableToGetUserDataNext = 1110 , VRInitError_VendorSpecific_HmdFound_UserDataAddressRange = 1111 , VRInitError_VendorSpecific_HmdFound_UserDataError = 1112 ,   VRInitError_VendorSpecific_HmdFound_ConfigFailedSanityCheck = 1113 , VRInitError_Steam_SteamInstallationNotFound = 2000 }
enum	EVRScreenshotType {   VRScreenshotType_None = 0 , VRScreenshotType_Mono = 1 , VRScreenshotType_Stereo = 2 , VRScreenshotType_Cubemap = 3 ,   VRScreenshotType_MonoPanorama = 4 , VRScreenshotType_StereoPanorama = 5 }
enum	EVRScreenshotPropertyFilenames { VRScreenshotPropertyFilenames_Preview = 0 , VRScreenshotPropertyFilenames_VR = 1 }
enum	EVRTrackedCameraError {   VRTrackedCameraError_None = 0 , VRTrackedCameraError_OperationFailed = 100 , VRTrackedCameraError_InvalidHandle = 101 , VRTrackedCameraError_InvalidFrameHeaderVersion = 102 ,   VRTrackedCameraError_OutOfHandles = 103 , VRTrackedCameraError_IPCFailure = 104 , VRTrackedCameraError_NotSupportedForThisDevice = 105 , VRTrackedCameraError_SharedMemoryFailure = 106 ,   VRTrackedCameraError_FrameBufferingFailure = 107 , VRTrackedCameraError_StreamSetupFailure = 108 , VRTrackedCameraError_InvalidGLTextureId = 109 , VRTrackedCameraError_InvalidSharedTextureHandle = 110 ,   VRTrackedCameraError_FailedToGetGLTextureId = 111 , VRTrackedCameraError_SharedTextureFailure = 112 , VRTrackedCameraError_NoFrameAvailable = 113 , VRTrackedCameraError_InvalidArgument = 114 ,   VRTrackedCameraError_InvalidFrameBufferSize = 115 }
enum	EVRTrackedCameraFrameType { VRTrackedCameraFrameType_Distorted = 0 , VRTrackedCameraFrameType_Undistorted , VRTrackedCameraFrameType_MaximumUndistorted , MAX_CAMERA_FRAME_TYPES }
enum	EVRApplicationError {   VRApplicationError_None = 0 , VRApplicationError_AppKeyAlreadyExists = 100 , VRApplicationError_NoManifest = 101 , VRApplicationError_NoApplication = 102 ,   VRApplicationError_InvalidIndex = 103 , VRApplicationError_UnknownApplication = 104 , VRApplicationError_IPCFailed = 105 , VRApplicationError_ApplicationAlreadyRunning = 106 ,   VRApplicationError_InvalidManifest = 107 , VRApplicationError_InvalidApplication = 108 , VRApplicationError_LaunchFailed = 109 , VRApplicationError_ApplicationAlreadyStarting = 110 ,   VRApplicationError_LaunchInProgress = 111 , VRApplicationError_OldApplicationQuitting = 112 , VRApplicationError_TransitionAborted = 113 , VRApplicationError_IsTemplate = 114 ,   VRApplicationError_SteamVRIsExiting = 115 , VRApplicationError_BufferTooSmall = 200 , VRApplicationError_PropertyNotSet = 201 , VRApplicationError_UnknownProperty = 202 ,   VRApplicationError_InvalidParameter = 203 }
enum	EVRApplicationProperty {   VRApplicationProperty_Name_String = 0 , VRApplicationProperty_LaunchType_String = 11 , VRApplicationProperty_WorkingDirectory_String = 12 , VRApplicationProperty_BinaryPath_String = 13 ,   VRApplicationProperty_Arguments_String = 14 , VRApplicationProperty_URL_String = 15 , VRApplicationProperty_Description_String = 50 , VRApplicationProperty_NewsURL_String = 51 ,   VRApplicationProperty_ImagePath_String = 52 , VRApplicationProperty_Source_String = 53 , VRApplicationProperty_ActionManifestURL_String = 54 , VRApplicationProperty_IsDashboardOverlay_Bool = 60 ,   VRApplicationProperty_IsTemplate_Bool = 61 , VRApplicationProperty_IsInstanced_Bool = 62 , VRApplicationProperty_IsInternal_Bool = 63 , VRApplicationProperty_WantsCompositorPauseInStandby_Bool = 64 ,   VRApplicationProperty_LastLaunchTime_Uint64 = 70 }
enum	EVRApplicationTransitionState { VRApplicationTransition_None = 0 , VRApplicationTransition_OldAppQuitSent = 10 , VRApplicationTransition_WaitingForExternalLaunch = 11 , VRApplicationTransition_NewAppLaunched = 20 }
enum	EVRSettingsError {   VRSettingsError_None = 0 , VRSettingsError_IPCFailed = 1 , VRSettingsError_WriteFailed = 2 , VRSettingsError_ReadFailed = 3 ,   VRSettingsError_JsonParseFailed = 4 , VRSettingsError_UnsetSettingHasNoDefault = 5 }
enum	ChaperoneCalibrationState {   ChaperoneCalibrationState_OK = 1 , ChaperoneCalibrationState_Warning = 100 , ChaperoneCalibrationState_Warning_BaseStationMayHaveMoved = 101 , ChaperoneCalibrationState_Warning_BaseStationRemoved = 102 ,   ChaperoneCalibrationState_Warning_SeatedBoundsInvalid = 103 , ChaperoneCalibrationState_Error = 200 , ChaperoneCalibrationState_Error_BaseStationUninitialized = 201 , ChaperoneCalibrationState_Error_BaseStationConflict = 202 ,   ChaperoneCalibrationState_Error_PlayAreaInvalid = 203 , ChaperoneCalibrationState_Error_CollisionBoundsInvalid = 204 }
enum	EChaperoneConfigFile { EChaperoneConfigFile_Live = 1 , EChaperoneConfigFile_Temp = 2 }
enum	EChaperoneImportFlags { EChaperoneImport_BoundsOnly = 0x0001 }
enum	EVRCompositorError {   VRCompositorError_None = 0 , VRCompositorError_RequestFailed = 1 , VRCompositorError_IncompatibleVersion = 100 , VRCompositorError_DoNotHaveFocus = 101 ,   VRCompositorError_InvalidTexture = 102 , VRCompositorError_IsNotSceneApplication = 103 , VRCompositorError_TextureIsOnWrongDevice = 104 , VRCompositorError_TextureUsesUnsupportedFormat = 105 ,   VRCompositorError_SharedTexturesNotSupported = 106 , VRCompositorError_IndexOutOfRange = 107 , VRCompositorError_AlreadySubmitted = 108 , VRCompositorError_InvalidBounds = 109 }
enum	EVRCompositorTimingMode { VRCompositorTimingMode_Implicit = 0 , VRCompositorTimingMode_Explicit_RuntimePerformsPostPresentHandoff = 1 , VRCompositorTimingMode_Explicit_ApplicationPerformsPostPresentHandoff = 2 }
enum	EVRNotificationType { EVRNotificationType_Transient = 0 , EVRNotificationType_Persistent = 1 , EVRNotificationType_Transient_SystemWithUserValue = 2 }
enum	EVRNotificationStyle {   EVRNotificationStyle_None = 0 , EVRNotificationStyle_Application = 100 , EVRNotificationStyle_Contact_Disabled = 200 , EVRNotificationStyle_Contact_Enabled = 201 ,   EVRNotificationStyle_Contact_Active = 202 }
enum	VROverlayInputMethod { VROverlayInputMethod_None = 0 , VROverlayInputMethod_Mouse = 1 , VROverlayInputMethod_DualAnalog = 2 }
enum	VROverlayTransformType { VROverlayTransform_Absolute = 0 , VROverlayTransform_TrackedDeviceRelative = 1 , VROverlayTransform_SystemOverlay = 2 , VROverlayTransform_TrackedComponent = 3 }
enum	VROverlayFlags {   VROverlayFlags_None = 0 , VROverlayFlags_Curved = 1 , VROverlayFlags_RGSS4X = 2 , VROverlayFlags_NoDashboardTab = 3 ,   VROverlayFlags_AcceptsGamepadEvents = 4 , VROverlayFlags_ShowGamepadFocus = 5 , VROverlayFlags_SendVRScrollEvents = 6 , VROverlayFlags_SendVRTouchpadEvents = 7 ,   VROverlayFlags_ShowTouchPadScrollWheel = 8 , VROverlayFlags_TransferOwnershipToInternalProcess = 9 , VROverlayFlags_SideBySide_Parallel = 10 , VROverlayFlags_SideBySide_Crossed = 11 ,   VROverlayFlags_Panorama = 12 , VROverlayFlags_StereoPanorama = 13 , VROverlayFlags_SortWithNonSceneOverlays = 14 , VROverlayFlags_VisibleInDashboard = 15 }
enum	VRMessageOverlayResponse {   VRMessageOverlayResponse_ButtonPress_0 = 0 , VRMessageOverlayResponse_ButtonPress_1 = 1 , VRMessageOverlayResponse_ButtonPress_2 = 2 , VRMessageOverlayResponse_ButtonPress_3 = 3 ,   VRMessageOverlayResponse_CouldntFindSystemOverlay = 4 , VRMessageOverlayResponse_CouldntFindOrCreateClientOverlay = 5 , VRMessageOverlayResponse_ApplicationQuit = 6 }
enum	EGamepadTextInputMode { k_EGamepadTextInputModeNormal = 0 , k_EGamepadTextInputModePassword = 1 , k_EGamepadTextInputModeSubmit = 2 }
enum	EGamepadTextInputLineMode { k_EGamepadTextInputLineModeSingleLine = 0 , k_EGamepadTextInputLineModeMultipleLines = 1 }
enum	EOverlayDirection {   OverlayDirection_Up = 0 , OverlayDirection_Down = 1 , OverlayDirection_Left = 2 , OverlayDirection_Right = 3 ,   OverlayDirection_Count = 4 }
enum	EVROverlayIntersectionMaskPrimitiveType { OverlayIntersectionPrimitiveType_Rectangle , OverlayIntersectionPrimitiveType_Circle }
enum	EVRRenderModelError {   VRRenderModelError_None = 0 , VRRenderModelError_Loading = 100 , VRRenderModelError_NotSupported = 200 , VRRenderModelError_InvalidArg = 300 ,   VRRenderModelError_InvalidModel = 301 , VRRenderModelError_NoShapes = 302 , VRRenderModelError_MultipleShapes = 303 , VRRenderModelError_TooManyVertices = 304 ,   VRRenderModelError_MultipleTextures = 305 , VRRenderModelError_BufferTooSmall = 306 , VRRenderModelError_NotEnoughNormals = 307 , VRRenderModelError_NotEnoughTexCoords = 308 ,   VRRenderModelError_InvalidTexture = 400 }
enum	EVRComponentProperty {   VRComponentProperty_IsStatic = (1 << 0) , VRComponentProperty_IsVisible = (1 << 1) , VRComponentProperty_IsTouched = (1 << 2) , VRComponentProperty_IsPressed = (1 << 3) ,   VRComponentProperty_IsScrolled = (1 << 4) }
enum	EVRScreenshotError {   VRScreenshotError_None = 0 , VRScreenshotError_RequestFailed = 1 , VRScreenshotError_IncompatibleVersion = 100 , VRScreenshotError_NotFound = 101 ,   VRScreenshotError_BufferTooSmall = 102 , VRScreenshotError_ScreenshotAlreadyInProgress = 108 }

Functions
uint64_t	ButtonMaskFromId (EVRButtonId id)
IVRSystem *	VR_Init (EVRInitError *peError, EVRApplicationType eApplicationType, const char *pStartupInfo=nullptr)
void	VR_Shutdown ()
VR_INTERFACE bool VR_CALLTYPE	VR_IsHmdPresent ()
VR_INTERFACE bool VR_CALLTYPE	VR_IsRuntimeInstalled ()
VR_INTERFACE const char *VR_CALLTYPE	VR_RuntimePath ()
VR_INTERFACE const char *VR_CALLTYPE	VR_GetVRInitErrorAsSymbol (EVRInitError error)
VR_INTERFACE const char *VR_CALLTYPE	VR_GetVRInitErrorAsEnglishDescription (EVRInitError error)
VR_INTERFACE void *VR_CALLTYPE	VR_GetGenericInterface (const char *pchInterfaceVersion, EVRInitError *peError)
VR_INTERFACE bool VR_CALLTYPE	VR_IsInterfaceVersionValid (const char *pchInterfaceVersion)
VR_INTERFACE uint32_t VR_CALLTYPE	VR_GetInitToken ()
uint32_t &	VRToken ()
COpenVRContext &	OpenVRInternal_ModuleContext ()
IVRSystem *VR_CALLTYPE	VRSystem ()
IVRChaperone *VR_CALLTYPE	VRChaperone ()
IVRChaperoneSetup *VR_CALLTYPE	VRChaperoneSetup ()
IVRCompositor *VR_CALLTYPE	VRCompositor ()
IVROverlay *VR_CALLTYPE	VROverlay ()
IVRScreenshots *VR_CALLTYPE	VRScreenshots ()
IVRRenderModels *VR_CALLTYPE	VRRenderModels ()
IVRApplications *VR_CALLTYPE	VRApplications ()
IVRSettings *VR_CALLTYPE	VRSettings ()
IVRResources *VR_CALLTYPE	VRResources ()
IVRExtendedDisplay *VR_CALLTYPE	VRExtendedDisplay ()
IVRTrackedCamera *VR_CALLTYPE	VRTrackedCamera ()
IVRDriverManager *VR_CALLTYPE	VRDriverManager ()
VR_INTERFACE uint32_t VR_CALLTYPE	VR_InitInternal2 (EVRInitError *peError, EVRApplicationType eApplicationType, const char *pStartupInfo)
VR_INTERFACE void VR_CALLTYPE	VR_ShutdownInternal ()

Variables
const uint32_t	VRCompositor_ReprojectionReason_Cpu = 0x01
const uint32_t	VRCompositor_ReprojectionReason_Gpu = 0x02
const uint32_t	VRCompositor_ReprojectionAsync = 0x04
const TextureID_t	INVALID_TEXTURE_ID = -1

Typedef Documentation

CollisionBoundsStyle_t

typedef ECollisionBoundsStyle vr::CollisionBoundsStyle_t

ColorSpace

typedef EColorSpace vr::ColorSpace

DriverId_t

typedef uint32_t vr::DriverId_t

glInt_t

typedef int32_t vr::glInt_t

glSharedTextureHandle_t

typedef void* vr::glSharedTextureHandle_t

glUInt_t

typedef uint32_t vr::glUInt_t

Hmd_Eye

typedef EVREye vr::Hmd_Eye

HmdError

typedef EVRInitError vr::HmdError

HmdTrackingResult

typedef ETrackingResult vr::HmdTrackingResult

PropertyContainerHandle_t

typedef uint64_t vr::PropertyContainerHandle_t

PropertyTypeTag_t

typedef uint32_t vr::PropertyTypeTag_t

ScreenshotHandle_t

typedef uint32_t vr::ScreenshotHandle_t

SharedTextureHandle_t

typedef uint64_t vr::SharedTextureHandle_t

TextureID_t

typedef int32_t vr::TextureID_t

Session unique texture identifier. Rendermodels which share the same texture will have the same id. IDs <0 denote the texture is not present

TrackedCameraHandle_t

typedef uint64_t vr::TrackedCameraHandle_t

TrackedDeviceClass

typedef ETrackedDeviceClass vr::TrackedDeviceClass

TrackedDeviceIndex_t

typedef uint32_t vr::TrackedDeviceIndex_t

Used to pass device IDs to API calls

TrackedDeviceProperty

typedef ETrackedDeviceProperty vr::TrackedDeviceProperty

TrackedPropertyError

typedef ETrackedPropertyError vr::TrackedPropertyError

TrackingUniverseOrigin

typedef ETrackingUniverseOrigin vr::TrackingUniverseOrigin

VRComponentProperties

typedef uint32_t vr::VRComponentProperties

VRCompositorError

typedef EVRCompositorError vr::VRCompositorError

VRControllerState_t

typedef VRControllerState001_t vr::VRControllerState_t

VRFirmwareError

typedef EVRFirmwareError vr::VRFirmwareError

VRNotificationId

typedef uint32_t vr::VRNotificationId

VROverlayError

typedef EVROverlayError vr::VROverlayError

VROverlayHandle_t

typedef uint64_t vr::VROverlayHandle_t

used to refer to a single VR overlay

VRScreenshotsError

typedef EVRScreenshotError vr::VRScreenshotsError

VRState_t

typedef EVRState vr::VRState_t

VRSubmitFlags_t

typedef EVRSubmitFlags vr::VRSubmitFlags_t

Enumeration Type Documentation

ChaperoneCalibrationState

enum vr::ChaperoneCalibrationState

Enumerator
ChaperoneCalibrationState_OK
ChaperoneCalibrationState_Warning
ChaperoneCalibrationState_Warning_BaseStationMayHaveMoved
ChaperoneCalibrationState_Warning_BaseStationRemoved
ChaperoneCalibrationState_Warning_SeatedBoundsInvalid
ChaperoneCalibrationState_Error
ChaperoneCalibrationState_Error_BaseStationUninitialized
ChaperoneCalibrationState_Error_BaseStationConflict
ChaperoneCalibrationState_Error_PlayAreaInvalid
ChaperoneCalibrationState_Error_CollisionBoundsInvalid

EChaperoneConfigFile

enum vr::EChaperoneConfigFile

Enumerator
EChaperoneConfigFile_Live
EChaperoneConfigFile_Temp

EChaperoneImportFlags

enum vr::EChaperoneImportFlags

Enumerator
EChaperoneImport_BoundsOnly

ECollisionBoundsStyle

enum vr::ECollisionBoundsStyle

Collision Bounds Style

Enumerator
COLLISION_BOUNDS_STYLE_BEGINNER
COLLISION_BOUNDS_STYLE_INTERMEDIATE
COLLISION_BOUNDS_STYLE_SQUARES
COLLISION_BOUNDS_STYLE_ADVANCED
COLLISION_BOUNDS_STYLE_NONE
COLLISION_BOUNDS_STYLE_COUNT

EColorSpace

enum vr::EColorSpace

Enumerator
ColorSpace_Auto
ColorSpace_Gamma
ColorSpace_Linear

EDeviceActivityLevel

enum vr::EDeviceActivityLevel

Level of Hmd activity

Enumerator
k_EDeviceActivityLevel_Unknown
k_EDeviceActivityLevel_Idle
k_EDeviceActivityLevel_UserInteraction
k_EDeviceActivityLevel_UserInteraction_Timeout
k_EDeviceActivityLevel_Standby

EDualAnalogWhich

enum vr::EDualAnalogWhich

Enumerator
k_EDualAnalog_Left
k_EDualAnalog_Right

EGamepadTextInputLineMode

enum vr::EGamepadTextInputLineMode

Enumerator
k_EGamepadTextInputLineModeSingleLine
k_EGamepadTextInputLineModeMultipleLines

EGamepadTextInputMode

enum vr::EGamepadTextInputMode

Enumerator
k_EGamepadTextInputModeNormal
k_EGamepadTextInputModePassword
k_EGamepadTextInputModeSubmit

EHiddenAreaMeshType

enum vr::EHiddenAreaMeshType

Enumerator
k_eHiddenAreaMesh_Standard
k_eHiddenAreaMesh_Inverse
k_eHiddenAreaMesh_LineLoop
k_eHiddenAreaMesh_Max

EOverlayDirection

enum vr::EOverlayDirection

Directions for changing focus between overlays with the gamepad

Enumerator
OverlayDirection_Up
OverlayDirection_Down
OverlayDirection_Left
OverlayDirection_Right
OverlayDirection_Count

ETextureType

enum vr::ETextureType

Enumerator
TextureType_DirectX
TextureType_OpenGL
TextureType_Vulkan
TextureType_IOSurface
TextureType_DirectX12

ETrackedControllerRole

enum vr::ETrackedControllerRole

Describes what specific role associated with a tracked device

Enumerator
TrackedControllerRole_Invalid
TrackedControllerRole_LeftHand
TrackedControllerRole_RightHand

ETrackedDeviceClass

enum vr::ETrackedDeviceClass

Describes what kind of object is being tracked at a given ID

Enumerator
TrackedDeviceClass_Invalid
TrackedDeviceClass_HMD
TrackedDeviceClass_Controller
TrackedDeviceClass_GenericTracker
TrackedDeviceClass_TrackingReference
TrackedDeviceClass_DisplayRedirect

ETrackedDeviceProperty

enum vr::ETrackedDeviceProperty

Each entry in this enum represents a property that can be retrieved about a tracked device. Many fields are only valid for one ETrackedDeviceClass.

Enumerator
Prop_Invalid
Prop_TrackingSystemName_String
Prop_ModelNumber_String
Prop_SerialNumber_String
Prop_RenderModelName_String
Prop_WillDriftInYaw_Bool
Prop_ManufacturerName_String
Prop_TrackingFirmwareVersion_String
Prop_HardwareRevision_String
Prop_AllWirelessDongleDescriptions_String
Prop_ConnectedWirelessDongle_String
Prop_DeviceIsWireless_Bool
Prop_DeviceIsCharging_Bool
Prop_DeviceBatteryPercentage_Float
Prop_StatusDisplayTransform_Matrix34
Prop_Firmware_UpdateAvailable_Bool
Prop_Firmware_ManualUpdate_Bool
Prop_Firmware_ManualUpdateURL_String
Prop_HardwareRevision_Uint64
Prop_FirmwareVersion_Uint64
Prop_FPGAVersion_Uint64
Prop_VRCVersion_Uint64
Prop_RadioVersion_Uint64
Prop_DongleVersion_Uint64
Prop_BlockServerShutdown_Bool
Prop_CanUnifyCoordinateSystemWithHmd_Bool
Prop_ContainsProximitySensor_Bool
Prop_DeviceProvidesBatteryStatus_Bool
Prop_DeviceCanPowerOff_Bool
Prop_Firmware_ProgrammingTarget_String
Prop_DeviceClass_Int32
Prop_HasCamera_Bool
Prop_DriverVersion_String
Prop_Firmware_ForceUpdateRequired_Bool
Prop_ViveSystemButtonFixRequired_Bool
Prop_ParentDriver_Uint64
Prop_ResourceRoot_String
Prop_RegisteredDeviceType_String
Prop_InputProfilePath_String
Prop_ReportsTimeSinceVSync_Bool
Prop_SecondsFromVsyncToPhotons_Float
Prop_DisplayFrequency_Float
Prop_UserIpdMeters_Float
Prop_CurrentUniverseId_Uint64
Prop_PreviousUniverseId_Uint64
Prop_DisplayFirmwareVersion_Uint64
Prop_IsOnDesktop_Bool
Prop_DisplayMCType_Int32
Prop_DisplayMCOffset_Float
Prop_DisplayMCScale_Float
Prop_EdidVendorID_Int32
Prop_DisplayMCImageLeft_String
Prop_DisplayMCImageRight_String
Prop_DisplayGCBlackClamp_Float
Prop_EdidProductID_Int32
Prop_CameraToHeadTransform_Matrix34
Prop_DisplayGCType_Int32
Prop_DisplayGCOffset_Float
Prop_DisplayGCScale_Float
Prop_DisplayGCPrescale_Float
Prop_DisplayGCImage_String
Prop_LensCenterLeftU_Float
Prop_LensCenterLeftV_Float
Prop_LensCenterRightU_Float
Prop_LensCenterRightV_Float
Prop_UserHeadToEyeDepthMeters_Float
Prop_CameraFirmwareVersion_Uint64
Prop_CameraFirmwareDescription_String
Prop_DisplayFPGAVersion_Uint64
Prop_DisplayBootloaderVersion_Uint64
Prop_DisplayHardwareVersion_Uint64
Prop_AudioFirmwareVersion_Uint64
Prop_CameraCompatibilityMode_Int32
Prop_ScreenshotHorizontalFieldOfViewDegrees_Float
Prop_ScreenshotVerticalFieldOfViewDegrees_Float
Prop_DisplaySuppressed_Bool
Prop_DisplayAllowNightMode_Bool
Prop_DisplayMCImageWidth_Int32
Prop_DisplayMCImageHeight_Int32
Prop_DisplayMCImageNumChannels_Int32
Prop_DisplayMCImageData_Binary
Prop_SecondsFromPhotonsToVblank_Float
Prop_DriverDirectModeSendsVsyncEvents_Bool
Prop_DisplayDebugMode_Bool
Prop_GraphicsAdapterLuid_Uint64
Prop_DriverProvidedChaperonePath_String
Prop_ExpectedTrackingReferenceCount_Int32
Prop_ExpectedControllerCount_Int32
Prop_NamedIconPathControllerLeftDeviceOff_String
Prop_NamedIconPathControllerRightDeviceOff_String
Prop_NamedIconPathTrackingReferenceDeviceOff_String
Prop_DoNotApplyPrediction_Bool
Prop_CameraToHeadTransforms_Matrix34_Array
Prop_DriverIsDrawingControllers_Bool
Prop_DriverRequestsApplicationPause_Bool
Prop_DriverRequestsReducedRendering_Bool
Prop_AttachedDeviceId_String
Prop_SupportedButtons_Uint64
Prop_Axis0Type_Int32
Prop_Axis1Type_Int32
Prop_Axis2Type_Int32
Prop_Axis3Type_Int32
Prop_Axis4Type_Int32
Prop_ControllerRoleHint_Int32
Prop_FieldOfViewLeftDegrees_Float
Prop_FieldOfViewRightDegrees_Float
Prop_FieldOfViewTopDegrees_Float
Prop_FieldOfViewBottomDegrees_Float
Prop_TrackingRangeMinimumMeters_Float
Prop_TrackingRangeMaximumMeters_Float
Prop_ModeLabel_String
Prop_IconPathName_String
Prop_NamedIconPathDeviceOff_String
Prop_NamedIconPathDeviceSearching_String
Prop_NamedIconPathDeviceSearchingAlert_String
Prop_NamedIconPathDeviceReady_String
Prop_NamedIconPathDeviceReadyAlert_String
Prop_NamedIconPathDeviceNotReady_String
Prop_NamedIconPathDeviceStandby_String
Prop_NamedIconPathDeviceAlertLow_String
Prop_DisplayHiddenArea_Binary_Start
Prop_DisplayHiddenArea_Binary_End
Prop_ParentContainer
Prop_UserConfigPath_String
Prop_InstallPath_String
Prop_HasDisplayComponent_Bool
Prop_HasControllerComponent_Bool
Prop_HasCameraComponent_Bool
Prop_HasDriverDirectModeComponent_Bool
Prop_HasVirtualDisplayComponent_Bool
Prop_ControllerType_String
Prop_LegacyInputProfile_String
Prop_VendorSpecific_Reserved_Start
Prop_VendorSpecific_Reserved_End
Prop_TrackedDeviceProperty_Max

ETrackedPropertyError

enum vr::ETrackedPropertyError

Used to return errors that occur when reading properties.

Enumerator
TrackedProp_Success
TrackedProp_WrongDataType
TrackedProp_WrongDeviceClass
TrackedProp_BufferTooSmall
TrackedProp_UnknownProperty
TrackedProp_InvalidDevice
TrackedProp_CouldNotContactServer
TrackedProp_ValueNotProvidedByDevice
TrackedProp_StringExceedsMaximumLength
TrackedProp_NotYetAvailable
TrackedProp_PermissionDenied
TrackedProp_InvalidOperation
TrackedProp_CannotWriteToWildcards

ETrackingResult

enum vr::ETrackingResult

Enumerator
TrackingResult_Uninitialized
TrackingResult_Calibrating_InProgress
TrackingResult_Calibrating_OutOfRange
TrackingResult_Running_OK
TrackingResult_Running_OutOfRange

ETrackingUniverseOrigin

enum vr::ETrackingUniverseOrigin

Identifies which style of tracking origin the application wants to use for the poses it is requesting

Enumerator
TrackingUniverseSeated
TrackingUniverseStanding
TrackingUniverseRawAndUncalibrated

EVRApplicationError

enum vr::EVRApplicationError

Used for all errors reported by the IVRApplications interface

Enumerator
VRApplicationError_None
VRApplicationError_AppKeyAlreadyExists
VRApplicationError_NoManifest
VRApplicationError_NoApplication
VRApplicationError_InvalidIndex
VRApplicationError_UnknownApplication
VRApplicationError_IPCFailed
VRApplicationError_ApplicationAlreadyRunning
VRApplicationError_InvalidManifest
VRApplicationError_InvalidApplication
VRApplicationError_LaunchFailed
VRApplicationError_ApplicationAlreadyStarting
VRApplicationError_LaunchInProgress
VRApplicationError_OldApplicationQuitting
VRApplicationError_TransitionAborted
VRApplicationError_IsTemplate
VRApplicationError_SteamVRIsExiting
VRApplicationError_BufferTooSmall
VRApplicationError_PropertyNotSet
VRApplicationError_UnknownProperty
VRApplicationError_InvalidParameter

EVRApplicationProperty

enum vr::EVRApplicationProperty

these are the properties available on applications.

Enumerator
VRApplicationProperty_Name_String
VRApplicationProperty_LaunchType_String
VRApplicationProperty_WorkingDirectory_String
VRApplicationProperty_BinaryPath_String
VRApplicationProperty_Arguments_String
VRApplicationProperty_URL_String
VRApplicationProperty_Description_String
VRApplicationProperty_NewsURL_String
VRApplicationProperty_ImagePath_String
VRApplicationProperty_Source_String
VRApplicationProperty_ActionManifestURL_String
VRApplicationProperty_IsDashboardOverlay_Bool
VRApplicationProperty_IsTemplate_Bool
VRApplicationProperty_IsInstanced_Bool
VRApplicationProperty_IsInternal_Bool
VRApplicationProperty_WantsCompositorPauseInStandby_Bool
VRApplicationProperty_LastLaunchTime_Uint64

EVRApplicationTransitionState

enum vr::EVRApplicationTransitionState

These are states the scene application startup process will go through.

Enumerator
VRApplicationTransition_None
VRApplicationTransition_OldAppQuitSent
VRApplicationTransition_WaitingForExternalLaunch
VRApplicationTransition_NewAppLaunched

EVRApplicationType

enum vr::EVRApplicationType

enum values to pass in to VR_Init to identify whether the application will draw a 3D scene.

Enumerator
VRApplication_Other
VRApplication_Scene
VRApplication_Overlay
VRApplication_Background
VRApplication_Utility
VRApplication_VRMonitor
VRApplication_SteamWatchdog
VRApplication_Bootstrapper
VRApplication_Max

EVRButtonId

enum vr::EVRButtonId

VR controller button and axis IDs

Enumerator
k_EButton_System
k_EButton_ApplicationMenu
k_EButton_Grip
k_EButton_DPad_Left
k_EButton_DPad_Up
k_EButton_DPad_Right
k_EButton_DPad_Down
k_EButton_A
k_EButton_ProximitySensor
k_EButton_Axis0
k_EButton_Axis1
k_EButton_Axis2
k_EButton_Axis3
k_EButton_Axis4
k_EButton_SteamVR_Touchpad
k_EButton_SteamVR_Trigger
k_EButton_Dashboard_Back
k_EButton_Max

EVRComponentProperty

enum vr::EVRComponentProperty

Enumerator
VRComponentProperty_IsStatic
VRComponentProperty_IsVisible
VRComponentProperty_IsTouched
VRComponentProperty_IsPressed
VRComponentProperty_IsScrolled

EVRCompositorError

enum vr::EVRCompositorError

Errors that can occur with the VR compositor

Enumerator
VRCompositorError_None
VRCompositorError_RequestFailed
VRCompositorError_IncompatibleVersion
VRCompositorError_DoNotHaveFocus
VRCompositorError_InvalidTexture
VRCompositorError_IsNotSceneApplication
VRCompositorError_TextureIsOnWrongDevice
VRCompositorError_TextureUsesUnsupportedFormat
VRCompositorError_SharedTexturesNotSupported
VRCompositorError_IndexOutOfRange
VRCompositorError_AlreadySubmitted
VRCompositorError_InvalidBounds

EVRCompositorTimingMode

enum vr::EVRCompositorTimingMode

Timing mode passed to SetExplicitTimingMode(); see that function for documentation

Enumerator
VRCompositorTimingMode_Implicit
VRCompositorTimingMode_Explicit_RuntimePerformsPostPresentHandoff
VRCompositorTimingMode_Explicit_ApplicationPerformsPostPresentHandoff

EVRControllerAxisType

enum vr::EVRControllerAxisType

Identifies what kind of axis is on the controller at index n. Read this type with pVRSystem->Get( nControllerDeviceIndex, Prop_Axis0Type_Int32 + n );

Enumerator
k_eControllerAxis_None
k_eControllerAxis_TrackPad
k_eControllerAxis_Joystick
k_eControllerAxis_Trigger

EVRControllerEventOutputType

enum vr::EVRControllerEventOutputType

determines how to provide output to the application of various event processing functions.

Enumerator
ControllerEventOutput_OSEvents
ControllerEventOutput_VREvents

EVREventType

enum vr::EVREventType

The types of events that could be posted (and what the parameters mean for each event type)

Enumerator
VREvent_None
VREvent_TrackedDeviceActivated
VREvent_TrackedDeviceDeactivated
VREvent_TrackedDeviceUpdated
VREvent_TrackedDeviceUserInteractionStarted
VREvent_TrackedDeviceUserInteractionEnded
VREvent_IpdChanged
VREvent_EnterStandbyMode
VREvent_LeaveStandbyMode
VREvent_TrackedDeviceRoleChanged
VREvent_WatchdogWakeUpRequested
VREvent_LensDistortionChanged
VREvent_PropertyChanged
VREvent_WirelessDisconnect
VREvent_WirelessReconnect
VREvent_ButtonPress
VREvent_ButtonUnpress
VREvent_ButtonTouch
VREvent_ButtonUntouch
VREvent_DualAnalog_Press
VREvent_DualAnalog_Unpress
VREvent_DualAnalog_Touch
VREvent_DualAnalog_Untouch
VREvent_DualAnalog_Move
VREvent_DualAnalog_ModeSwitch1
VREvent_DualAnalog_ModeSwitch2
VREvent_DualAnalog_Cancel
VREvent_MouseMove
VREvent_MouseButtonDown
VREvent_MouseButtonUp
VREvent_FocusEnter
VREvent_FocusLeave
VREvent_Scroll
VREvent_TouchPadMove
VREvent_OverlayFocusChanged
VREvent_InputFocusCaptured
VREvent_InputFocusReleased
VREvent_SceneFocusLost
VREvent_SceneFocusGained
VREvent_SceneApplicationChanged
VREvent_SceneFocusChanged
VREvent_InputFocusChanged
VREvent_SceneApplicationSecondaryRenderingStarted
VREvent_HideRenderModels
VREvent_ShowRenderModels
VREvent_ConsoleOpened
VREvent_ConsoleClosed
VREvent_OverlayShown
VREvent_OverlayHidden
VREvent_DashboardActivated
VREvent_DashboardDeactivated
VREvent_DashboardThumbSelected
VREvent_DashboardRequested
VREvent_ResetDashboard
VREvent_RenderToast
VREvent_ImageLoaded
VREvent_ShowKeyboard
VREvent_HideKeyboard
VREvent_OverlayGamepadFocusGained
VREvent_OverlayGamepadFocusLost
VREvent_OverlaySharedTextureChanged
VREvent_DashboardGuideButtonDown
VREvent_DashboardGuideButtonUp
VREvent_ScreenshotTriggered
VREvent_ImageFailed
VREvent_DashboardOverlayCreated
VREvent_RequestScreenshot
VREvent_ScreenshotTaken
VREvent_ScreenshotFailed
VREvent_SubmitScreenshotToDashboard
VREvent_ScreenshotProgressToDashboard
VREvent_PrimaryDashboardDeviceChanged
VREvent_Notification_Shown
VREvent_Notification_Hidden
VREvent_Notification_BeginInteraction
VREvent_Notification_Destroyed
VREvent_Quit
VREvent_ProcessQuit
VREvent_QuitAborted_UserPrompt
VREvent_QuitAcknowledged
VREvent_DriverRequestedQuit
VREvent_ChaperoneDataHasChanged
VREvent_ChaperoneUniverseHasChanged
VREvent_ChaperoneTempDataHasChanged
VREvent_ChaperoneSettingsHaveChanged
VREvent_SeatedZeroPoseReset
VREvent_AudioSettingsHaveChanged
VREvent_BackgroundSettingHasChanged
VREvent_CameraSettingsHaveChanged
VREvent_ReprojectionSettingHasChanged
VREvent_ModelSkinSettingsHaveChanged
VREvent_EnvironmentSettingsHaveChanged
VREvent_PowerSettingsHaveChanged
VREvent_EnableHomeAppSettingsHaveChanged
VREvent_SteamVRSectionSettingChanged
VREvent_LighthouseSectionSettingChanged
VREvent_NullSectionSettingChanged
VREvent_UserInterfaceSectionSettingChanged
VREvent_NotificationsSectionSettingChanged
VREvent_KeyboardSectionSettingChanged
VREvent_PerfSectionSettingChanged
VREvent_DashboardSectionSettingChanged
VREvent_WebInterfaceSectionSettingChanged
VREvent_StatusUpdate
VREvent_WebInterface_InstallDriverCompleted
VREvent_MCImageUpdated
VREvent_FirmwareUpdateStarted
VREvent_FirmwareUpdateFinished
VREvent_KeyboardClosed
VREvent_KeyboardCharInput
VREvent_KeyboardDone
VREvent_ApplicationTransitionStarted
VREvent_ApplicationTransitionAborted
VREvent_ApplicationTransitionNewAppStarted
VREvent_ApplicationListUpdated
VREvent_ApplicationMimeTypeLoad
VREvent_ApplicationTransitionNewAppLaunchComplete
VREvent_ProcessConnected
VREvent_ProcessDisconnected
VREvent_Compositor_MirrorWindowShown
VREvent_Compositor_MirrorWindowHidden
VREvent_Compositor_ChaperoneBoundsShown
VREvent_Compositor_ChaperoneBoundsHidden
VREvent_TrackedCamera_StartVideoStream
VREvent_TrackedCamera_StopVideoStream
VREvent_TrackedCamera_PauseVideoStream
VREvent_TrackedCamera_ResumeVideoStream
VREvent_TrackedCamera_EditingSurface
VREvent_PerformanceTest_EnableCapture
VREvent_PerformanceTest_DisableCapture
VREvent_PerformanceTest_FidelityLevel
VREvent_MessageOverlay_Closed
VREvent_MessageOverlayCloseRequested
VREvent_Input_HapticVibration
VREvent_VendorSpecific_Reserved_Start
VREvent_VendorSpecific_Reserved_End

EVREye

enum vr::EVREye

Enumerator
Eye_Left
Eye_Right

EVRFirmwareError

enum vr::EVRFirmwareError

error codes for firmware

Enumerator
VRFirmwareError_None
VRFirmwareError_Success
VRFirmwareError_Fail

EVRInitError

enum vr::EVRInitError

error codes returned by Vr_Init

Enumerator
VRInitError_None
VRInitError_Unknown
VRInitError_Init_InstallationNotFound
VRInitError_Init_InstallationCorrupt
VRInitError_Init_VRClientDLLNotFound
VRInitError_Init_FileNotFound
VRInitError_Init_FactoryNotFound
VRInitError_Init_InterfaceNotFound
VRInitError_Init_InvalidInterface
VRInitError_Init_UserConfigDirectoryInvalid
VRInitError_Init_HmdNotFound
VRInitError_Init_NotInitialized
VRInitError_Init_PathRegistryNotFound
VRInitError_Init_NoConfigPath
VRInitError_Init_NoLogPath
VRInitError_Init_PathRegistryNotWritable
VRInitError_Init_AppInfoInitFailed
VRInitError_Init_Retry
VRInitError_Init_InitCanceledByUser
VRInitError_Init_AnotherAppLaunching
VRInitError_Init_SettingsInitFailed
VRInitError_Init_ShuttingDown
VRInitError_Init_TooManyObjects
VRInitError_Init_NoServerForBackgroundApp
VRInitError_Init_NotSupportedWithCompositor
VRInitError_Init_NotAvailableToUtilityApps
VRInitError_Init_Internal
VRInitError_Init_HmdDriverIdIsNone
VRInitError_Init_HmdNotFoundPresenceFailed
VRInitError_Init_VRMonitorNotFound
VRInitError_Init_VRMonitorStartupFailed
VRInitError_Init_LowPowerWatchdogNotSupported
VRInitError_Init_InvalidApplicationType
VRInitError_Init_NotAvailableToWatchdogApps
VRInitError_Init_WatchdogDisabledInSettings
VRInitError_Init_VRDashboardNotFound
VRInitError_Init_VRDashboardStartupFailed
VRInitError_Init_VRHomeNotFound
VRInitError_Init_VRHomeStartupFailed
VRInitError_Init_RebootingBusy
VRInitError_Init_FirmwareUpdateBusy
VRInitError_Init_FirmwareRecoveryBusy
VRInitError_Init_USBServiceBusy
VRInitError_Driver_Failed
VRInitError_Driver_Unknown
VRInitError_Driver_HmdUnknown
VRInitError_Driver_NotLoaded
VRInitError_Driver_RuntimeOutOfDate
VRInitError_Driver_HmdInUse
VRInitError_Driver_NotCalibrated
VRInitError_Driver_CalibrationInvalid
VRInitError_Driver_HmdDisplayNotFound
VRInitError_Driver_TrackedDeviceInterfaceUnknown
VRInitError_Driver_HmdDriverIdOutOfBounds
VRInitError_Driver_HmdDisplayMirrored
VRInitError_IPC_ServerInitFailed
VRInitError_IPC_ConnectFailed
VRInitError_IPC_SharedStateInitFailed
VRInitError_IPC_CompositorInitFailed
VRInitError_IPC_MutexInitFailed
VRInitError_IPC_Failed
VRInitError_IPC_CompositorConnectFailed
VRInitError_IPC_CompositorInvalidConnectResponse
VRInitError_IPC_ConnectFailedAfterMultipleAttempts
VRInitError_Compositor_Failed
VRInitError_Compositor_D3D11HardwareRequired
VRInitError_Compositor_FirmwareRequiresUpdate
VRInitError_Compositor_OverlayInitFailed
VRInitError_Compositor_ScreenshotsInitFailed
VRInitError_Compositor_UnableToCreateDevice
VRInitError_VendorSpecific_UnableToConnectToOculusRuntime
VRInitError_VendorSpecific_WindowsNotInDevMode
VRInitError_VendorSpecific_HmdFound_CantOpenDevice
VRInitError_VendorSpecific_HmdFound_UnableToRequestConfigStart
VRInitError_VendorSpecific_HmdFound_NoStoredConfig
VRInitError_VendorSpecific_HmdFound_ConfigTooBig
VRInitError_VendorSpecific_HmdFound_ConfigTooSmall
VRInitError_VendorSpecific_HmdFound_UnableToInitZLib
VRInitError_VendorSpecific_HmdFound_CantReadFirmwareVersion
VRInitError_VendorSpecific_HmdFound_UnableToSendUserDataStart
VRInitError_VendorSpecific_HmdFound_UnableToGetUserDataStart
VRInitError_VendorSpecific_HmdFound_UnableToGetUserDataNext
VRInitError_VendorSpecific_HmdFound_UserDataAddressRange
VRInitError_VendorSpecific_HmdFound_UserDataError
VRInitError_VendorSpecific_HmdFound_ConfigFailedSanityCheck
VRInitError_Steam_SteamInstallationNotFound

EVRInputError

enum vr::EVRInputError

Enumerator
VRInputError_None
VRInputError_NameNotFound
VRInputError_WrongType
VRInputError_InvalidHandle
VRInputError_InvalidParam
VRInputError_NoSteam
VRInputError_MaxCapacityReached
VRInputError_IPCError
VRInputError_NoActiveActionSet
VRInputError_InvalidDevice

EVRMouseButton

enum vr::EVRMouseButton

used for simulated mouse events in overlay space

Enumerator
VRMouseButton_Left
VRMouseButton_Right
VRMouseButton_Middle

EVRNotificationError

enum vr::EVRNotificationError

error codes for notifications

Enumerator
VRNotificationError_OK
VRNotificationError_InvalidNotificationId
VRNotificationError_NotificationQueueFull
VRNotificationError_InvalidOverlayHandle
VRNotificationError_SystemWithUserValueAlreadyExists

EVRNotificationStyle

enum vr::EVRNotificationStyle

Enumerator
EVRNotificationStyle_None	Creates a notification with minimal external styling.
EVRNotificationStyle_Application	Used for notifications about overlay-level status. In Steam this is used for events like downloads completing.
EVRNotificationStyle_Contact_Disabled	Used for notifications about contacts that are unknown or not available. In Steam this is used for friend invitations and offline friends.
EVRNotificationStyle_Contact_Enabled	Used for notifications about contacts that are available but inactive. In Steam this is used for friends that are online but not playing a game.
EVRNotificationStyle_Contact_Active	Used for notifications about contacts that are available and active. In Steam this is used for friends that are online and currently running a game.

EVRNotificationType

enum vr::EVRNotificationType

Be aware that the notification type is used as 'priority' to pick the next notification

Enumerator
EVRNotificationType_Transient	Transient notifications are automatically hidden after a period of time set by the user. They are used for things like information and chat messages that do not require user interaction.
EVRNotificationType_Persistent	Persistent notifications are shown to the user until they are hidden by calling RemoveNotification(). They are used for things like phone calls and alarms that require user interaction.
EVRNotificationType_Transient_SystemWithUserValue	System notifications are shown no matter what. It is expected, that the ulUserValue is used as ID. If there is already a system notification in the queue with that ID it is not accepted into the queue to prevent spamming with system notification

EVROverlayError

enum vr::EVROverlayError

Errors that can occur around VR overlays

Enumerator
VROverlayError_None
VROverlayError_UnknownOverlay
VROverlayError_InvalidHandle
VROverlayError_PermissionDenied
VROverlayError_OverlayLimitExceeded
VROverlayError_WrongVisibilityType
VROverlayError_KeyTooLong
VROverlayError_NameTooLong
VROverlayError_KeyInUse
VROverlayError_WrongTransformType
VROverlayError_InvalidTrackedDevice
VROverlayError_InvalidParameter
VROverlayError_ThumbnailCantBeDestroyed
VROverlayError_ArrayTooSmall
VROverlayError_RequestFailed
VROverlayError_InvalidTexture
VROverlayError_UnableToLoadFile
VROverlayError_KeyboardAlreadyInUse
VROverlayError_NoNeighbor
VROverlayError_TooManyMaskPrimitives
VROverlayError_BadMaskPrimitive
VROverlayError_TextureAlreadyLocked
VROverlayError_TextureLockCapacityReached
VROverlayError_TextureNotLocked

EVROverlayIntersectionMaskPrimitiveType

enum vr::EVROverlayIntersectionMaskPrimitiveType

Enumerator
OverlayIntersectionPrimitiveType_Rectangle
OverlayIntersectionPrimitiveType_Circle

EVRRenderModelError

enum vr::EVRRenderModelError

Errors that can occur with the VR compositor

Enumerator
VRRenderModelError_None
VRRenderModelError_Loading
VRRenderModelError_NotSupported
VRRenderModelError_InvalidArg
VRRenderModelError_InvalidModel
VRRenderModelError_NoShapes
VRRenderModelError_MultipleShapes
VRRenderModelError_TooManyVertices
VRRenderModelError_MultipleTextures
VRRenderModelError_BufferTooSmall
VRRenderModelError_NotEnoughNormals
VRRenderModelError_NotEnoughTexCoords
VRRenderModelError_InvalidTexture

EVRScreenshotError

enum vr::EVRScreenshotError

Errors that can occur with the VR compositor

Enumerator
VRScreenshotError_None
VRScreenshotError_RequestFailed
VRScreenshotError_IncompatibleVersion
VRScreenshotError_NotFound
VRScreenshotError_BufferTooSmall
VRScreenshotError_ScreenshotAlreadyInProgress

EVRScreenshotPropertyFilenames

enum vr::EVRScreenshotPropertyFilenames

Enumerator
VRScreenshotPropertyFilenames_Preview
VRScreenshotPropertyFilenames_VR

EVRScreenshotType

enum vr::EVRScreenshotType

Enumerator
VRScreenshotType_None
VRScreenshotType_Mono
VRScreenshotType_Stereo
VRScreenshotType_Cubemap
VRScreenshotType_MonoPanorama
VRScreenshotType_StereoPanorama

EVRSettingsError

enum vr::EVRSettingsError

Enumerator
VRSettingsError_None
VRSettingsError_IPCFailed
VRSettingsError_WriteFailed
VRSettingsError_ReadFailed
VRSettingsError_JsonParseFailed
VRSettingsError_UnsetSettingHasNoDefault

EVRState

enum vr::EVRState

Status of the overall system or tracked objects

Enumerator
VRState_Undefined
VRState_Off
VRState_Searching
VRState_Searching_Alert
VRState_Ready
VRState_Ready_Alert
VRState_NotReady
VRState_Standby
VRState_Ready_Alert_Low

EVRSubmitFlags

enum vr::EVRSubmitFlags

Allows the application to control how scene textures are used by the compositor when calling Submit.

Enumerator
Submit_Default
Submit_LensDistortionAlreadyApplied
Submit_GlRenderBuffer
Submit_Reserved
Submit_TextureWithPose
Submit_TextureWithDepth

EVRTrackedCameraError

enum vr::EVRTrackedCameraError

Enumerator
VRTrackedCameraError_None
VRTrackedCameraError_OperationFailed
VRTrackedCameraError_InvalidHandle
VRTrackedCameraError_InvalidFrameHeaderVersion
VRTrackedCameraError_OutOfHandles
VRTrackedCameraError_IPCFailure
VRTrackedCameraError_NotSupportedForThisDevice
VRTrackedCameraError_SharedMemoryFailure
VRTrackedCameraError_FrameBufferingFailure
VRTrackedCameraError_StreamSetupFailure
VRTrackedCameraError_InvalidGLTextureId
VRTrackedCameraError_InvalidSharedTextureHandle
VRTrackedCameraError_FailedToGetGLTextureId
VRTrackedCameraError_SharedTextureFailure
VRTrackedCameraError_NoFrameAvailable
VRTrackedCameraError_InvalidArgument
VRTrackedCameraError_InvalidFrameBufferSize

EVRTrackedCameraFrameType

enum vr::EVRTrackedCameraFrameType

Enumerator
VRTrackedCameraFrameType_Distorted
VRTrackedCameraFrameType_Undistorted
VRTrackedCameraFrameType_MaximumUndistorted
MAX_CAMERA_FRAME_TYPES

VRMessageOverlayResponse

enum vr::VRMessageOverlayResponse

Enumerator
VRMessageOverlayResponse_ButtonPress_0
VRMessageOverlayResponse_ButtonPress_1
VRMessageOverlayResponse_ButtonPress_2
VRMessageOverlayResponse_ButtonPress_3
VRMessageOverlayResponse_CouldntFindSystemOverlay
VRMessageOverlayResponse_CouldntFindOrCreateClientOverlay
VRMessageOverlayResponse_ApplicationQuit

VROverlayFlags

enum vr::VROverlayFlags

Overlay control settings

Enumerator
VROverlayFlags_None
VROverlayFlags_Curved
VROverlayFlags_RGSS4X
VROverlayFlags_NoDashboardTab
VROverlayFlags_AcceptsGamepadEvents
VROverlayFlags_ShowGamepadFocus
VROverlayFlags_SendVRScrollEvents
VROverlayFlags_SendVRTouchpadEvents
VROverlayFlags_ShowTouchPadScrollWheel
VROverlayFlags_TransferOwnershipToInternalProcess
VROverlayFlags_SideBySide_Parallel
VROverlayFlags_SideBySide_Crossed
VROverlayFlags_Panorama
VROverlayFlags_StereoPanorama
VROverlayFlags_SortWithNonSceneOverlays
VROverlayFlags_VisibleInDashboard

VROverlayInputMethod

enum vr::VROverlayInputMethod

Types of input supported by VR Overlays

Enumerator
VROverlayInputMethod_None
VROverlayInputMethod_Mouse
VROverlayInputMethod_DualAnalog

VROverlayTransformType

enum vr::VROverlayTransformType

Allows the caller to figure out which overlay transform getter to call.

Enumerator
VROverlayTransform_Absolute
VROverlayTransform_TrackedDeviceRelative
VROverlayTransform_SystemOverlay
VROverlayTransform_TrackedComponent

Function Documentation

ButtonMaskFromId()

uint64_t vr::ButtonMaskFromId ( EVRButtonId id )

inline

OpenVRInternal_ModuleContext()

COpenVRContext & vr::OpenVRInternal_ModuleContext ( )

inline

Here is the caller graph for this function:

VR_GetGenericInterface()

VR_INTERFACE void *VR_CALLTYPE vr::VR_GetGenericInterface	(	const char *	pchInterfaceVersion,
		EVRInitError *	peError )

Returns the interface of the specified version. This method must be called after VR_Init. The pointer returned is valid until VR_Shutdown is called.

Here is the caller graph for this function:

VR_GetInitToken()

VR_INTERFACE uint32_t VR_CALLTYPE vr::VR_GetInitToken

(

)

Returns a token that represents whether the VR interface handles need to be reloaded

Here is the caller graph for this function:

VR_GetVRInitErrorAsEnglishDescription()

VR_INTERFACE const char *VR_CALLTYPE vr::VR_GetVRInitErrorAsEnglishDescription

(

EVRInitError

error

)

Returns an English string for an EVRInitError. Applications should call VR_GetVRInitErrorAsSymbol instead and use that as a key to look up their own localized error message. This function may be called outside of VR_Init()/VR_Shutdown().

VR_GetVRInitErrorAsSymbol()

VR_INTERFACE const char *VR_CALLTYPE vr::VR_GetVRInitErrorAsSymbol

(

EVRInitError

error

)

Returns the name of the enum value for an EVRInitError. This function may be called outside of VR_Init()/VR_Shutdown().

VR_Init()

IVRSystem * vr::VR_Init ( EVRInitError * peError, EVRApplicationType eApplicationType, const char * pStartupInfo = nullptr )

inline

Finds the active installation of the VR API and initializes it. The provided path must be absolute or relative to the current working directory. These are the local install versions of the equivalent functions in steamvr.h and will work without a local Steam install.

This path is to the "root" of the VR API install. That's the directory with the "drivers" directory and a platform (i.e. "win32") directory in it, not the directory with the DLL itself.

pStartupInfo is reserved for future use.

Finds the active installation of vrclient.dll and initializes it

Here is the caller graph for this function:

VR_InitInternal2()

VR_INTERFACE uint32_t VR_CALLTYPE vr::VR_InitInternal2	(	EVRInitError *	peError,
		EVRApplicationType	eApplicationType,
		const char *	pStartupInfo )

Here is the caller graph for this function:

VR_IsHmdPresent()

VR_INTERFACE bool VR_CALLTYPE vr::VR_IsHmdPresent

(

)

Returns true if there is an HMD attached. This check is as lightweight as possible and can be called outside of VR_Init/VR_Shutdown. It should be used when an application wants to know if initializing VR is a possibility but isn't ready to take that step yet.

VR_IsInterfaceVersionValid()

VR_INTERFACE bool VR_CALLTYPE vr::VR_IsInterfaceVersionValid

(

const char *

pchInterfaceVersion

)

Returns whether the interface of the specified version exists.

Here is the caller graph for this function:

VR_IsRuntimeInstalled()

VR_INTERFACE bool VR_CALLTYPE vr::VR_IsRuntimeInstalled

(

)

Returns true if the OpenVR runtime is installed.

VR_RuntimePath()

VR_INTERFACE const char *VR_CALLTYPE vr::VR_RuntimePath

(

)

Returns where the OpenVR runtime is installed.

VR_Shutdown()

void vr::VR_Shutdown ( )

inline

unloads vrclient.dll. Any interface pointers from the interface are invalid after this point

VR_ShutdownInternal()

VR_INTERFACE void VR_CALLTYPE vr::VR_ShutdownInternal

(

)

Here is the caller graph for this function:

VRApplications()

IVRApplications *VR_CALLTYPE vr::VRApplications ( )

inline

VRChaperone()

IVRChaperone *VR_CALLTYPE vr::VRChaperone ( )

inline

VRChaperoneSetup()

IVRChaperoneSetup *VR_CALLTYPE vr::VRChaperoneSetup ( )

inline

VRCompositor()

IVRCompositor *VR_CALLTYPE vr::VRCompositor ( )

inline

Here is the caller graph for this function:

VRDriverManager()

IVRDriverManager *VR_CALLTYPE vr::VRDriverManager ( )

inline

VRExtendedDisplay()

IVRExtendedDisplay *VR_CALLTYPE vr::VRExtendedDisplay ( )

inline

VROverlay()

IVROverlay *VR_CALLTYPE vr::VROverlay ( )

inline

VRRenderModels()

IVRRenderModels *VR_CALLTYPE vr::VRRenderModels ( )

inline

VRResources()

IVRResources *VR_CALLTYPE vr::VRResources ( )

inline

VRScreenshots()

IVRScreenshots *VR_CALLTYPE vr::VRScreenshots ( )

inline

VRSettings()

IVRSettings *VR_CALLTYPE vr::VRSettings ( )

inline

VRSystem()

IVRSystem *VR_CALLTYPE vr::VRSystem ( )

inline

Here is the caller graph for this function:

VRToken()

uint32_t & vr::VRToken ( )

inline

Here is the caller graph for this function:

VRTrackedCamera()

IVRTrackedCamera *VR_CALLTYPE vr::VRTrackedCamera ( )

inline

Variable Documentation

INVALID_TEXTURE_ID

const TextureID_t vr::INVALID_TEXTURE_ID = -1

VRCompositor_ReprojectionAsync

const uint32_t vr::VRCompositor_ReprojectionAsync = 0x04

VRCompositor_ReprojectionReason_Cpu

const uint32_t vr::VRCompositor_ReprojectionReason_Cpu = 0x01

VRCompositor_ReprojectionReason_Gpu

const uint32_t vr::VRCompositor_ReprojectionReason_Gpu = 0x02