vr Namespace Reference

Classes
class	COpenVRContext
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	VROverlayIntersectionParams_t
struct	VROverlayIntersectionResults_t
struct	IntersectionMaskRectangle_t
struct	IntersectionMaskCircle_t
union	VROverlayIntersectionMaskPrimitive_Data_t
struct	VROverlayIntersectionMaskPrimitive_t
class	IVROverlay
struct	DistortionCoordinates_t
struct	Texture_t
struct	VRTextureBounds_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

Typedefs
using	TrackedDeviceIndex_t = std::uint32_t
using	VROverlayHandle_t = std::uint64_t
using	PropertyContainerHandle_t = std::uint64_t
using	PropertyTypeTag_t = std::uint32_t

Enumerations
enum	VROverlayInputMethod { VROverlayInputMethod_None = 0 , VROverlayInputMethod_Mouse = 1 }
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	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	ETrackingUniverseOrigin { TrackingUniverseSeated = 0 , TrackingUniverseStanding = 1 , TrackingUniverseRawAndUncalibrated = 2 }
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	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_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_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_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_VendorSpecific_Reserved_Start = 10000 , Prop_VendorSpecific_Reserved_End = 10999 }
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 }
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 }

Functions
std::uint64_t	ButtonMaskFromId (EVRButtonId id)

Variables
static constexpr std::uint32_t	k_unVROverlayMaxKeyLength = 128
static constexpr std::uint32_t	k_unVROverlayMaxNameLength = 128
static constexpr std::uint32_t	k_unMaxOverlayCount = 64
static constexpr std::uint32_t	k_unMaxOverlayIntersectionMaskPrimitivesCount = 32
static constexpr PropertyContainerHandle_t	k_ulInvalidPropertyContainer = 0
static constexpr PropertyTypeTag_t	k_unInvalidPropertyTag = 0
static constexpr PropertyTypeTag_t	k_unFloatPropertyTag = 1
static constexpr PropertyTypeTag_t	k_unInt32PropertyTag = 2
static constexpr PropertyTypeTag_t	k_unUint64PropertyTag = 3
static constexpr PropertyTypeTag_t	k_unBoolPropertyTag = 4
static constexpr PropertyTypeTag_t	k_unStringPropertyTag = 5
static constexpr PropertyTypeTag_t	k_unHmdMatrix34PropertyTag = 20
static constexpr PropertyTypeTag_t	k_unHmdMatrix44PropertyTag = 21
static constexpr PropertyTypeTag_t	k_unHmdVector3PropertyTag = 22
static constexpr PropertyTypeTag_t	k_unHmdVector4PropertyTag = 23
static constexpr PropertyTypeTag_t	k_unHiddenAreaPropertyTag = 30
static constexpr PropertyTypeTag_t	k_unOpenVRInternalReserved_Start = 1000
static constexpr PropertyTypeTag_t	k_unOpenVRInternalReserved_End = 10000
static const uint32_t	k_unMaxPropertyStringSize = 32 * 1024

Typedef Documentation

PropertyContainerHandle_t

using vr::PropertyContainerHandle_t = typedef std::uint64_t

PropertyTypeTag_t

using vr::PropertyTypeTag_t = typedef std::uint32_t

TrackedDeviceIndex_t

using vr::TrackedDeviceIndex_t = typedef std::uint32_t

Used to pass device IDs to API calls

VROverlayHandle_t

using vr::VROverlayHandle_t = typedef std::uint64_t

used to refer to a single VR overlay

Enumeration Type Documentation

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

EOverlayDirection

enum vr::EOverlayDirection

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

ETrackedDeviceProperty

enum vr::ETrackedDeviceProperty

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_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_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_UserConfigPath_String
Prop_InstallPath_String
Prop_HasDisplayComponent_Bool
Prop_HasControllerComponent_Bool
Prop_HasCameraComponent_Bool
Prop_HasDriverDirectModeComponent_Bool
Prop_HasVirtualDisplayComponent_Bool
Prop_VendorSpecific_Reserved_Start
Prop_VendorSpecific_Reserved_End

ETrackedPropertyError

enum vr::ETrackedPropertyError

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

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

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

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

EVRMouseButton

enum vr::EVRMouseButton

used for simulated mouse events in overlay space

Enumerator
VRMouseButton_Left
VRMouseButton_Right
VRMouseButton_Middle

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

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

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

Enumerator
VROverlayInputMethod_None
VROverlayInputMethod_Mouse

VROverlayTransformType

enum vr::VROverlayTransformType

Enumerator
VROverlayTransform_Absolute
VROverlayTransform_TrackedDeviceRelative
VROverlayTransform_SystemOverlay
VROverlayTransform_TrackedComponent

Function Documentation

ButtonMaskFromId()

std::uint64_t vr::ButtonMaskFromId ( EVRButtonId  id )

inline

Variable Documentation

k_ulInvalidPropertyContainer

constexpr PropertyContainerHandle_t vr::k_ulInvalidPropertyContainer = 0

staticconstexpr

k_unBoolPropertyTag

constexpr PropertyTypeTag_t vr::k_unBoolPropertyTag = 4

staticconstexpr

k_unFloatPropertyTag

constexpr PropertyTypeTag_t vr::k_unFloatPropertyTag = 1

staticconstexpr

k_unHiddenAreaPropertyTag

constexpr PropertyTypeTag_t vr::k_unHiddenAreaPropertyTag = 30

staticconstexpr

k_unHmdMatrix34PropertyTag

constexpr PropertyTypeTag_t vr::k_unHmdMatrix34PropertyTag = 20

staticconstexpr

k_unHmdMatrix44PropertyTag

constexpr PropertyTypeTag_t vr::k_unHmdMatrix44PropertyTag = 21

staticconstexpr

k_unHmdVector3PropertyTag

constexpr PropertyTypeTag_t vr::k_unHmdVector3PropertyTag = 22

staticconstexpr

k_unHmdVector4PropertyTag

constexpr PropertyTypeTag_t vr::k_unHmdVector4PropertyTag = 23

staticconstexpr

k_unInt32PropertyTag

constexpr PropertyTypeTag_t vr::k_unInt32PropertyTag = 2

staticconstexpr

k_unInvalidPropertyTag

constexpr PropertyTypeTag_t vr::k_unInvalidPropertyTag = 0

staticconstexpr

k_unMaxOverlayCount

constexpr std::uint32_t vr::k_unMaxOverlayCount = 64

staticconstexpr

k_unMaxOverlayIntersectionMaskPrimitivesCount

constexpr std::uint32_t vr::k_unMaxOverlayIntersectionMaskPrimitivesCount = 32

staticconstexpr

k_unMaxPropertyStringSize

const uint32_t vr::k_unMaxPropertyStringSize = 32 * 1024

static

k_unOpenVRInternalReserved_End

constexpr PropertyTypeTag_t vr::k_unOpenVRInternalReserved_End = 10000

staticconstexpr

k_unOpenVRInternalReserved_Start

constexpr PropertyTypeTag_t vr::k_unOpenVRInternalReserved_Start = 1000

staticconstexpr

k_unStringPropertyTag

constexpr PropertyTypeTag_t vr::k_unStringPropertyTag = 5

staticconstexpr

k_unUint64PropertyTag

constexpr PropertyTypeTag_t vr::k_unUint64PropertyTag = 3

staticconstexpr

k_unVROverlayMaxKeyLength

constexpr std::uint32_t vr::k_unVROverlayMaxKeyLength = 128

staticconstexpr

k_unVROverlayMaxNameLength

constexpr std::uint32_t vr::k_unVROverlayMaxNameLength = 128

staticconstexpr