Class VR
- java.lang.Object
-
- org.lwjgl.openvr.VR
-
public class VR extends java.lang.Object
Because the OpenVR API causes the game to connect to any attached VR hardware, it is not initialized automatically. To initialize the API and get access to theIVRSystem
interface call theInitInternal
function and pass the returned token toOpenVR.create(int)
. To close down your connection to the hardware and release yourIVRSystem
interface, callShutdownInternal
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VR.Functions
Contains the function pointers loaded from the openvrSharedLibrary
.
-
Field Summary
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static org.lwjgl.system.SharedLibrary
getLibrary()
Returns the openvrSharedLibrary
.static long
nVR_GetGenericInterface(long pchInterfaceVersion, long peError)
Unsafe version of:GetGenericInterface
static long
nVR_GetVRInitErrorAsEnglishDescription(int error)
Unsafe version of:GetVRInitErrorAsEnglishDescription
static long
nVR_GetVRInitErrorAsSymbol(int error)
Unsafe version of:GetVRInitErrorAsSymbol
static int
nVR_InitInternal(long peError, int eType)
Unsafe version of:InitInternal
static boolean
nVR_IsInterfaceVersionValid(long pchInterfaceVersion)
Unsafe version of:IsInterfaceVersionValid
static long
nVR_RuntimePath()
Unsafe version of:RuntimePath
static long
VR_GetGenericInterface(java.lang.CharSequence pchInterfaceVersion, java.nio.IntBuffer peError)
Requests an interface by name from OpenVR.static long
VR_GetGenericInterface(java.nio.ByteBuffer pchInterfaceVersion, java.nio.IntBuffer peError)
Requests an interface by name from OpenVR.static int
VR_GetInitToken()
Returns a token that represents whether the VR interface handles need to be reloaded.static java.lang.String
VR_GetVRInitErrorAsEnglishDescription(int error)
Returns an english string for anEVRInitError
.static java.lang.String
VR_GetVRInitErrorAsSymbol(int error)
Returns theEVRInitError
enum value as a string.static int
VR_InitInternal(java.nio.IntBuffer peError, int eType)
Initializes the connection to the VR hardware.static boolean
VR_IsHmdPresent()
Returns true if the system believes that an HMD is present on the system.static boolean
VR_IsInterfaceVersionValid(java.lang.CharSequence pchInterfaceVersion)
Returns whether the interface of the specified version exists.static boolean
VR_IsInterfaceVersionValid(java.nio.ByteBuffer pchInterfaceVersion)
Returns whether the interface of the specified version exists.static boolean
VR_IsRuntimeInstalled()
Returns true if the OpenVR runtime is installed on the system.static java.lang.String
VR_RuntimePath()
Returns where the OpenVR runtime is installed.static void
VR_ShutdownInternal()
Shuts down the connection to the VR hardware and cleans up the OpenVR API.
-
-
-
Field Detail
-
k_nSteamVRVersionMajor, k_nSteamVRVersionMinor, k_nSteamVRVersionBuild
OpenVR version.
-
k_nDriverNone, k_unMaxDriverDebugResponseSize, k_unTrackedDeviceIndex_Hmd, k_unMaxTrackedDeviceCount, k_unTrackedDeviceIndexOther, k_unTrackedDeviceIndexInvalid, k_unInvalidPropertyTag, k_unFloatPropertyTag, k_unInt32PropertyTag, k_unUint64PropertyTag, k_unBoolPropertyTag, k_unStringPropertyTag, k_unErrorPropertyTag, k_unHmdMatrix34PropertyTag, k_unHmdMatrix44PropertyTag, k_unHmdVector3PropertyTag, k_unHmdVector4PropertyTag, k_unHmdVector2PropertyTag, k_unHmdQuadPropertyTag, k_unHiddenAreaPropertyTag, k_unPathHandleInfoTag, k_unActionPropertyTag, k_unInputValuePropertyTag, k_unWildcardPropertyTag, k_unHapticVibrationPropertyTag, k_unSkeletonPropertyTag, k_unSpatialAnchorPosePropertyTag, k_unJsonPropertyTag, k_unActiveActionSetPropertyTag, k_unOpenVRInternalReserved_Start, k_unOpenVRInternalReserved_End, k_unScreenshotHandleInvalid, k_unNotificationTextMaxSize, k_unMaxActionNameLength, k_unMaxActionSetNameLength, k_unMaxActionOriginCount, k_unMaxBoneNameLength, k_ulInvalidPropertyContainer, k_ulInvalidDriverHandle, k_ulOverlayHandleInvalid, k_ulInvalidActionHandle, k_ulInvalidActionSetHandle, k_ulInvalidInputValueHandle, k_ulInvalidIOBufferHandle, k_ulInvalidSpatialAnchorHandle
OpenVR constants.
-
k_unMaxPropertyStringSize
No string property will ever be longer than this length.
-
k_unMaxDistortionFunctionParameters
- See Also:
- Constant Field Values
-
k_unControllerStateAxisCount
The number of axes in the controller state.
-
k_unMaxApplicationKeyLength
The maximum length of an application key.
-
k_unVROverlayMaxKeyLength
The maximum length of an overlay key in bytes, counting the terminating null character.
-
k_unVROverlayMaxNameLength
The maximum length of an overlay name in bytes, counting the terminating null character.
-
k_unMaxOverlayCount
The maximum number of overlays that can exist in the system at one time.
-
k_unMaxOverlayIntersectionMaskPrimitivesCount
The maximum number of overlay intersection mask primitives per overlay.
-
k_unMaxSettingsKeyLength
The maximum length of a settings key.
-
IVRSystem_Version, IVRExtendedDisplay_Version, IVRTrackedCamera_Version, k_pch_MimeType_HomeApp, k_pch_MimeType_GameTheater, IVRApplications_Version, IVRChaperone_Version, IVRChaperoneSetup_Version, IVRCompositor_Version, IVROverlay_Version, k_pch_Controller_Component_GDC2015, k_pch_Controller_Component_Base, k_pch_Controller_Component_Tip, k_pch_Controller_Component_HandGrip, k_pch_Controller_Component_Status, IVRRenderModels_Version, IVRNotifications_Version, IVRSettings_Version, k_pch_SteamVR_Section, k_pch_SteamVR_RequireHmd_String, k_pch_SteamVR_ForcedDriverKey_String, k_pch_SteamVR_ForcedHmdKey_String, k_pch_SteamVR_DisplayDebug_Bool, k_pch_SteamVR_DebugProcessPipe_String, k_pch_SteamVR_DisplayDebugX_Int32, k_pch_SteamVR_DisplayDebugY_Int32, k_pch_SteamVR_SendSystemButtonToAllApps_Bool, k_pch_SteamVR_LogLevel_Int32, k_pch_SteamVR_IPD_Float, k_pch_SteamVR_Background_String, k_pch_SteamVR_BackgroundUseDomeProjection_Bool, k_pch_SteamVR_BackgroundCameraHeight_Float, k_pch_SteamVR_BackgroundDomeRadius_Float, k_pch_SteamVR_GridColor_String, k_pch_SteamVR_PlayAreaColor_String, k_pch_SteamVR_TrackingLossColor_String, k_pch_SteamVR_ShowStage_Bool, k_pch_SteamVR_ActivateMultipleDrivers_Bool, k_pch_SteamVR_UsingSpeakers_Bool, k_pch_SteamVR_SpeakersForwardYawOffsetDegrees_Float, k_pch_SteamVR_BaseStationPowerManagement_Int32, k_pch_SteamVR_ShowBaseStationPowerManagementTip_Int32, k_pch_SteamVR_NeverKillProcesses_Bool, k_pch_SteamVR_SupersampleScale_Float, k_pch_SteamVR_MaxRecommendedResolution_Int32, k_pch_SteamVR_MotionSmoothing_Bool, k_pch_SteamVR_MotionSmoothingOverride_Int32, k_pch_SteamVR_DisableAsyncReprojection_Bool, k_pch_SteamVR_ForceFadeOnBadTracking_Bool, k_pch_SteamVR_DefaultMirrorView_Int32, k_pch_SteamVR_ShowLegacyMirrorView_Bool, k_pch_SteamVR_MirrorViewVisibility_Bool, k_pch_SteamVR_MirrorViewDisplayMode_Int32, k_pch_SteamVR_MirrorViewEye_Int32, k_pch_SteamVR_MirrorViewGeometry_String, k_pch_SteamVR_MirrorViewGeometryMaximized_String, k_pch_SteamVR_PerfGraphVisibility_Bool, k_pch_SteamVR_StartMonitorFromAppLaunch, k_pch_SteamVR_StartCompositorFromAppLaunch_Bool, k_pch_SteamVR_StartDashboardFromAppLaunch_Bool, k_pch_SteamVR_StartOverlayAppsFromDashboard_Bool, k_pch_SteamVR_EnableHomeApp, k_pch_SteamVR_CycleBackgroundImageTimeSec_Int32, k_pch_SteamVR_RetailDemo_Bool, k_pch_SteamVR_IpdOffset_Float, k_pch_SteamVR_AllowSupersampleFiltering_Bool, k_pch_SteamVR_SupersampleManualOverride_Bool, k_pch_SteamVR_EnableLinuxVulkanAsync_Bool, k_pch_SteamVR_AllowDisplayLockedMode_Bool, k_pch_SteamVR_HaveStartedTutorialForNativeChaperoneDriver_Bool, k_pch_SteamVR_ForceWindows32bitVRMonitor, k_pch_SteamVR_DebugInputBinding, k_pch_SteamVR_DoNotFadeToGrid, k_pch_SteamVR_RenderCameraMode, k_pch_SteamVR_EnableSharedResourceJournaling, k_pch_SteamVR_EnableSafeMode, k_pch_SteamVR_PreferredRefreshRate, k_pch_SteamVR_LastVersionNotice, k_pch_SteamVR_LastVersionNoticeDate, k_pch_SteamVR_HmdDisplayColorGainR_Float, k_pch_SteamVR_HmdDisplayColorGainG_Float, k_pch_SteamVR_HmdDisplayColorGainB_Float, k_pch_SteamVR_CustomIconStyle_String, k_pch_SteamVR_CustomOffIconStyle_String, k_pch_SteamVR_CustomIconForceUpdate_String, k_pch_DirectMode_Section, k_pch_DirectMode_Enable_Bool, k_pch_DirectMode_Count_Int32, k_pch_DirectMode_EdidVid_Int32, k_pch_DirectMode_EdidPid_Int32, k_pch_Lighthouse_Section, k_pch_Lighthouse_DisableIMU_Bool, k_pch_Lighthouse_DisableIMUExceptHMD_Bool, k_pch_Lighthouse_UseDisambiguation_String, k_pch_Lighthouse_DisambiguationDebug_Int32, k_pch_Lighthouse_PrimaryBasestation_Int32, k_pch_Lighthouse_DBHistory_Bool, k_pch_Lighthouse_EnableBluetooth_Bool, k_pch_Lighthouse_PowerManagedBaseStations_String, k_pch_Lighthouse_PowerManagedBaseStations2_String, k_pch_Lighthouse_InactivityTimeoutForBaseStations_Int32, k_pch_Lighthouse_EnableImuFallback_Bool, k_pch_Null_Section, k_pch_Null_SerialNumber_String, k_pch_Null_ModelNumber_String, k_pch_Null_WindowX_Int32, k_pch_Null_WindowY_Int32, k_pch_Null_WindowWidth_Int32, k_pch_Null_WindowHeight_Int32, k_pch_Null_RenderWidth_Int32, k_pch_Null_RenderHeight_Int32, k_pch_Null_SecondsFromVsyncToPhotons_Float, k_pch_Null_DisplayFrequency_Float, k_pch_UserInterface_Section, k_pch_UserInterface_StatusAlwaysOnTop_Bool, k_pch_UserInterface_MinimizeToTray_Bool, k_pch_UserInterface_HidePopupsWhenStatusMinimized_Bool, k_pch_UserInterface_Screenshots_Bool, k_pch_UserInterface_ScreenshotType_Int, k_pch_Notifications_Section, k_pch_Notifications_DoNotDisturb_Bool, k_pch_Keyboard_Section, k_pch_Keyboard_TutorialCompletions, k_pch_Keyboard_ScaleX, k_pch_Keyboard_ScaleY, k_pch_Keyboard_OffsetLeftX, k_pch_Keyboard_OffsetRightX, k_pch_Keyboard_OffsetY, k_pch_Keyboard_Smoothing, k_pch_Perf_Section, k_pch_Perf_PerfGraphInHMD_Bool, k_pch_Perf_AllowTimingStore_Bool, k_pch_Perf_SaveTimingsOnExit_Bool, k_pch_Perf_TestData_Float, k_pch_Perf_GPUProfiling_Bool, k_pch_CollisionBounds_Section, k_pch_CollisionBounds_Style_Int32, k_pch_CollisionBounds_GroundPerimeterOn_Bool, k_pch_CollisionBounds_CenterMarkerOn_Bool, k_pch_CollisionBounds_PlaySpaceOn_Bool, k_pch_CollisionBounds_FadeDistance_Float, k_pch_CollisionBounds_ColorGammaR_Int32, k_pch_CollisionBounds_ColorGammaG_Int32, k_pch_CollisionBounds_ColorGammaB_Int32, k_pch_CollisionBounds_ColorGammaA_Int32, k_pch_CollisionBounds_EnableDriverImport, k_pch_Camera_Section, k_pch_Camera_EnableCamera_Bool, k_pch_Camera_EnableCameraInDashboard_Bool, k_pch_Camera_EnableCameraForCollisionBounds_Bool, k_pch_Camera_EnableCameraForRoomView_Bool, k_pch_Camera_BoundsColorGammaR_Int32, k_pch_Camera_BoundsColorGammaG_Int32, k_pch_Camera_BoundsColorGammaB_Int32, k_pch_Camera_BoundsColorGammaA_Int32, k_pch_Camera_BoundsStrength_Int32, k_pch_Camera_RoomViewMode_Int32, k_pch_audio_Section, k_pch_audio_SetOsDefaultPlaybackDevice_Bool, k_pch_audio_EnablePlaybackDeviceOverride_Bool, k_pch_audio_PlaybackDeviceOverride_String, k_pch_audio_PlaybackDeviceOverrideName_String, k_pch_audio_SetOsDefaultRecordingDevice_Bool, k_pch_audio_EnableRecordingDeviceOverride_Bool, k_pch_audio_RecordingDeviceOverride_String, k_pch_audio_RecordingDeviceOverrideName_String, k_pch_audio_EnablePlaybackMirror_Bool, k_pch_audio_PlaybackMirrorDevice_String, k_pch_audio_PlaybackMirrorDeviceName_String, k_pch_audio_OldPlaybackMirrorDevice_String, k_pch_audio_LastHmdPlaybackDeviceId_String, k_pch_audio_VIVEHDMIGain, k_pch_Power_Section, k_pch_Power_PowerOffOnExit_Bool, k_pch_Power_TurnOffScreensTimeout_Float, k_pch_Power_TurnOffControllersTimeout_Float, k_pch_Power_ReturnToWatchdogTimeout_Float, k_pch_Power_AutoLaunchSteamVROnButtonPress, k_pch_Power_PauseCompositorOnStandby_Bool, k_pch_Dashboard_Section, k_pch_Dashboard_EnableDashboard_Bool, k_pch_Dashboard_ArcadeMode_Bool, k_pch_Dashboard_UseWebKeyboard, k_pch_Dashboard_UseWebSettings, k_pch_Dashboard_Position, k_pch_Dashboard_DesktopScale, k_pch_Dashboard_DashboardScale, k_pch_modelskin_Section, k_pch_Driver_Enable_Bool, k_pch_Driver_LoadPriority_Int32, k_pch_WebInterface_Section, k_pch_VRWebHelper_Section, k_pch_VRWebHelper_DebuggerEnabled_Bool, k_pch_VRWebHelper_DebuggerPort_Int32, k_pch_TrackingOverride_Section, k_pch_App_BindingAutosaveURLSuffix_String, k_pch_App_BindingCurrentURLSuffix_String, k_pch_App_BindingPreviousURLSuffix_String, k_pch_App_NeedToUpdateAutosaveSuffix_Bool, k_pch_Trackers_Section, k_pch_DesktopUI_Section, k_pch_LastKnown_Section, k_pch_LastKnown_HMDManufacturer_String, k_pch_LastKnown_HMDModel_String, k_pch_DismissedWarnings_Section, k_pch_Input_Section, k_pch_Input_LeftThumbstickRotation_Float, k_pch_Input_RightThumbstickRotation_Float, k_pch_Input_ThumbstickDeadzone_Float, k_pch_GpuSpeed_Section, IVRScreenshots_Version, IVRResources_Version, IVRDriverManager_Version, IVRInput_Version, IVRIOBuffer_Version, IVRSpatialAnchors_Version, IVRDebug_Version
OpenVR constants.
-
ETextureType_TextureType_Invalid, ETextureType_TextureType_DirectX, ETextureType_TextureType_OpenGL, ETextureType_TextureType_Vulkan, ETextureType_TextureType_IOSurface, ETextureType_TextureType_DirectX12, ETextureType_TextureType_DXGISharedHandle, ETextureType_TextureType_Metal
ETextureType
Enum values:
ETextureType_TextureType_Invalid
- Handle has been invalidatedETextureType_TextureType_DirectX
- Handle is an ID3D11Texture.ETextureType_TextureType_OpenGL
- Handle is an OpenGL texture name or an OpenGL render buffer name, depending on submit flags.ETextureType_TextureType_Vulkan
- Handle is a pointer to aVRVulkanTextureData_t
structure.ETextureType_TextureType_IOSurface
- Handle is a macOS cross-process-sharableIOSurfaceRef
, deprecated in favor ofTextureType_Metal
on supported platformsETextureType_TextureType_DirectX12
- Handle is a pointer to aD3D12TextureData_t
structure.ETextureType_TextureType_DXGISharedHandle
- Handle is aHANDLE DXGI
share handle, only supported for Overlay render targets. This texture is used directly by our renderer, so only perform atomic (copyresource or resolve) on it.ETextureType_TextureType_Metal
- Handle is aMTLTexture
conforming to theMTLSharedTexture
protocol. Textures submitted toSubmit
which are of typeMTLTextureType2DArray
assume layer 0 is the left eye texture (EVREye_Eye_Left
), layer 1 is the right eye texture (EVREye_Eye_Right
).
-
EColorSpace_ColorSpace_Auto, EColorSpace_ColorSpace_Gamma, EColorSpace_ColorSpace_Linear
EColorSpace
Enum values:
EColorSpace_ColorSpace_Auto
- Assumes 'gamma' for 8-bit per component formats, otherwise 'linear'. This mirrors the DXGI formats which have _SRGB variants.EColorSpace_ColorSpace_Gamma
- Texture data can be displayed directly on the display without any conversion (a.k.a. display native format).EColorSpace_ColorSpace_Linear
- Same as gamma but has been converted to a linear representation using DXGI's sRGB conversion algorithm.
-
ETrackingResult_TrackingResult_Uninitialized, ETrackingResult_TrackingResult_Calibrating_InProgress, ETrackingResult_TrackingResult_Calibrating_OutOfRange, ETrackingResult_TrackingResult_Running_OK, ETrackingResult_TrackingResult_Running_OutOfRange, ETrackingResult_TrackingResult_Fallback_RotationOnly
ETrackingResult
Enum values:
-
ETrackedDeviceClass_TrackedDeviceClass_Invalid, ETrackedDeviceClass_TrackedDeviceClass_HMD, ETrackedDeviceClass_TrackedDeviceClass_Controller, ETrackedDeviceClass_TrackedDeviceClass_GenericTracker, ETrackedDeviceClass_TrackedDeviceClass_TrackingReference, ETrackedDeviceClass_TrackedDeviceClass_DisplayRedirect, ETrackedDeviceClass_TrackedDeviceClass_Max
ETrackedDeviceClass
: Describes what kind of object is being tracked at a given ID.Enum values:
ETrackedDeviceClass_TrackedDeviceClass_Invalid
- The ID was not valid.ETrackedDeviceClass_TrackedDeviceClass_HMD
- Head-Mounted Displays.ETrackedDeviceClass_TrackedDeviceClass_Controller
- Tracked controllers.ETrackedDeviceClass_TrackedDeviceClass_GenericTracker
- Generic trackers, similar to controllers.ETrackedDeviceClass_TrackedDeviceClass_TrackingReference
- Camera and base stations that serve as tracking reference points.ETrackedDeviceClass_TrackedDeviceClass_DisplayRedirect
- Accessories that aren't necessarily tracked themselves, but may redirect video output from other tracked devices.ETrackedDeviceClass_TrackedDeviceClass_Max
-
ETrackedControllerRole_TrackedControllerRole_Invalid, ETrackedControllerRole_TrackedControllerRole_LeftHand, ETrackedControllerRole_TrackedControllerRole_RightHand, ETrackedControllerRole_TrackedControllerRole_OptOut, ETrackedControllerRole_TrackedControllerRole_Treadmill, ETrackedControllerRole_TrackedControllerRole_Stylus, ETrackedControllerRole_TrackedControllerRole_Max
ETrackedControllerRole
: Describes what specific role associated with a tracked device.Enum values:
ETrackedControllerRole_TrackedControllerRole_Invalid
- Invalid value for controller type.ETrackedControllerRole_TrackedControllerRole_LeftHand
- Tracked device associated with the left hand.ETrackedControllerRole_TrackedControllerRole_RightHand
- Tracked device associated with the right hand.ETrackedControllerRole_TrackedControllerRole_OptOut
- Tracked device is opting out of left/right hand selection.ETrackedControllerRole_TrackedControllerRole_Treadmill
- Tracked device is a treadmill.ETrackedControllerRole_TrackedControllerRole_Stylus
- Tracked device is a stylus.ETrackedControllerRole_TrackedControllerRole_Max
-
ETrackingUniverseOrigin_TrackingUniverseSeated, ETrackingUniverseOrigin_TrackingUniverseStanding, ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated
ETrackingUniverseOrigin
: Identifies which style of tracking origin the application wants to use for the poses it is requesting.Enum values:
ETrackingUniverseOrigin_TrackingUniverseSeated
- Poses are provided relative to the seated zero pose.ETrackingUniverseOrigin_TrackingUniverseStanding
- Poses are provided relative to the safe bounds configured by the user.ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated
- Poses are provided in the coordinate system defined by the driver. It has Y up and is unified for devices of the same driver. You usually don't want this one.
-
EAdditionalRadioFeatures_AdditionalRadioFeatures_None, EAdditionalRadioFeatures_AdditionalRadioFeatures_HTCLinkBox, EAdditionalRadioFeatures_AdditionalRadioFeatures_InternalDongle, EAdditionalRadioFeatures_AdditionalRadioFeatures_ExternalDongle
-
ETrackedDeviceProperty_Prop_Invalid, ETrackedDeviceProperty_Prop_TrackingSystemName_String, ETrackedDeviceProperty_Prop_ModelNumber_String, ETrackedDeviceProperty_Prop_SerialNumber_String, ETrackedDeviceProperty_Prop_RenderModelName_String, ETrackedDeviceProperty_Prop_WillDriftInYaw_Bool, ETrackedDeviceProperty_Prop_ManufacturerName_String, ETrackedDeviceProperty_Prop_TrackingFirmwareVersion_String, ETrackedDeviceProperty_Prop_HardwareRevision_String, ETrackedDeviceProperty_Prop_AllWirelessDongleDescriptions_String, ETrackedDeviceProperty_Prop_ConnectedWirelessDongle_String, ETrackedDeviceProperty_Prop_DeviceIsWireless_Bool, ETrackedDeviceProperty_Prop_DeviceIsCharging_Bool, ETrackedDeviceProperty_Prop_DeviceBatteryPercentage_Float, ETrackedDeviceProperty_Prop_StatusDisplayTransform_Matrix34, ETrackedDeviceProperty_Prop_Firmware_UpdateAvailable_Bool, ETrackedDeviceProperty_Prop_Firmware_ManualUpdate_Bool, ETrackedDeviceProperty_Prop_Firmware_ManualUpdateURL_String, ETrackedDeviceProperty_Prop_HardwareRevision_Uint64, ETrackedDeviceProperty_Prop_FirmwareVersion_Uint64, ETrackedDeviceProperty_Prop_FPGAVersion_Uint64, ETrackedDeviceProperty_Prop_VRCVersion_Uint64, ETrackedDeviceProperty_Prop_RadioVersion_Uint64, ETrackedDeviceProperty_Prop_DongleVersion_Uint64, ETrackedDeviceProperty_Prop_BlockServerShutdown_Bool, ETrackedDeviceProperty_Prop_CanUnifyCoordinateSystemWithHmd_Bool, ETrackedDeviceProperty_Prop_ContainsProximitySensor_Bool, ETrackedDeviceProperty_Prop_DeviceProvidesBatteryStatus_Bool, ETrackedDeviceProperty_Prop_DeviceCanPowerOff_Bool, ETrackedDeviceProperty_Prop_Firmware_ProgrammingTarget_String, ETrackedDeviceProperty_Prop_DeviceClass_Int32, ETrackedDeviceProperty_Prop_HasCamera_Bool, ETrackedDeviceProperty_Prop_DriverVersion_String, ETrackedDeviceProperty_Prop_Firmware_ForceUpdateRequired_Bool, ETrackedDeviceProperty_Prop_ViveSystemButtonFixRequired_Bool, ETrackedDeviceProperty_Prop_ParentDriver_Uint64, ETrackedDeviceProperty_Prop_ResourceRoot_String, ETrackedDeviceProperty_Prop_RegisteredDeviceType_String, ETrackedDeviceProperty_Prop_InputProfilePath_String, ETrackedDeviceProperty_Prop_NeverTracked_Bool, ETrackedDeviceProperty_Prop_NumCameras_Int32, ETrackedDeviceProperty_Prop_CameraFrameLayout_Int32, ETrackedDeviceProperty_Prop_CameraStreamFormat_Int32, ETrackedDeviceProperty_Prop_AdditionalDeviceSettingsPath_String, ETrackedDeviceProperty_Prop_Identifiable_Bool, ETrackedDeviceProperty_Prop_BootloaderVersion_Uint64, ETrackedDeviceProperty_Prop_AdditionalSystemReportData_String, ETrackedDeviceProperty_Prop_CompositeFirmwareVersion_String, ETrackedDeviceProperty_Prop_Firmware_RemindUpdate_Bool, ETrackedDeviceProperty_Prop_PeripheralApplicationVersion_Uint64, ETrackedDeviceProperty_Prop_ManufacturerSerialNumber_String, ETrackedDeviceProperty_Prop_ComputedSerialNumber_String, ETrackedDeviceProperty_Prop_EstimatedDeviceFirstUseTime_Int32, ETrackedDeviceProperty_Prop_ReportsTimeSinceVSync_Bool, ETrackedDeviceProperty_Prop_SecondsFromVsyncToPhotons_Float, ETrackedDeviceProperty_Prop_DisplayFrequency_Float, ETrackedDeviceProperty_Prop_UserIpdMeters_Float, ETrackedDeviceProperty_Prop_CurrentUniverseId_Uint64, ETrackedDeviceProperty_Prop_PreviousUniverseId_Uint64, ETrackedDeviceProperty_Prop_DisplayFirmwareVersion_Uint64, ETrackedDeviceProperty_Prop_IsOnDesktop_Bool, ETrackedDeviceProperty_Prop_DisplayMCType_Int32, ETrackedDeviceProperty_Prop_DisplayMCOffset_Float, ETrackedDeviceProperty_Prop_DisplayMCScale_Float, ETrackedDeviceProperty_Prop_EdidVendorID_Int32, ETrackedDeviceProperty_Prop_DisplayMCImageLeft_String, ETrackedDeviceProperty_Prop_DisplayMCImageRight_String, ETrackedDeviceProperty_Prop_DisplayGCBlackClamp_Float, ETrackedDeviceProperty_Prop_EdidProductID_Int32, ETrackedDeviceProperty_Prop_CameraToHeadTransform_Matrix34, ETrackedDeviceProperty_Prop_DisplayGCType_Int32, ETrackedDeviceProperty_Prop_DisplayGCOffset_Float, ETrackedDeviceProperty_Prop_DisplayGCScale_Float, ETrackedDeviceProperty_Prop_DisplayGCPrescale_Float, ETrackedDeviceProperty_Prop_DisplayGCImage_String, ETrackedDeviceProperty_Prop_LensCenterLeftU_Float, ETrackedDeviceProperty_Prop_LensCenterLeftV_Float, ETrackedDeviceProperty_Prop_LensCenterRightU_Float, ETrackedDeviceProperty_Prop_LensCenterRightV_Float, ETrackedDeviceProperty_Prop_UserHeadToEyeDepthMeters_Float, ETrackedDeviceProperty_Prop_CameraFirmwareVersion_Uint64, ETrackedDeviceProperty_Prop_CameraFirmwareDescription_String, ETrackedDeviceProperty_Prop_DisplayFPGAVersion_Uint64, ETrackedDeviceProperty_Prop_DisplayBootloaderVersion_Uint64, ETrackedDeviceProperty_Prop_DisplayHardwareVersion_Uint64, ETrackedDeviceProperty_Prop_AudioFirmwareVersion_Uint64, ETrackedDeviceProperty_Prop_CameraCompatibilityMode_Int32, ETrackedDeviceProperty_Prop_ScreenshotHorizontalFieldOfViewDegrees_Float, ETrackedDeviceProperty_Prop_ScreenshotVerticalFieldOfViewDegrees_Float, ETrackedDeviceProperty_Prop_DisplaySuppressed_Bool, ETrackedDeviceProperty_Prop_DisplayAllowNightMode_Bool, ETrackedDeviceProperty_Prop_DisplayMCImageWidth_Int32, ETrackedDeviceProperty_Prop_DisplayMCImageHeight_Int32, ETrackedDeviceProperty_Prop_DisplayMCImageNumChannels_Int32, ETrackedDeviceProperty_Prop_DisplayMCImageData_Binary, ETrackedDeviceProperty_Prop_SecondsFromPhotonsToVblank_Float, ETrackedDeviceProperty_Prop_DriverDirectModeSendsVsyncEvents_Bool, ETrackedDeviceProperty_Prop_DisplayDebugMode_Bool, ETrackedDeviceProperty_Prop_GraphicsAdapterLuid_Uint64, ETrackedDeviceProperty_Prop_DriverProvidedChaperonePath_String, ETrackedDeviceProperty_Prop_ExpectedTrackingReferenceCount_Int32, ETrackedDeviceProperty_Prop_ExpectedControllerCount_Int32, ETrackedDeviceProperty_Prop_NamedIconPathControllerLeftDeviceOff_String, ETrackedDeviceProperty_Prop_NamedIconPathControllerRightDeviceOff_String, ETrackedDeviceProperty_Prop_NamedIconPathTrackingReferenceDeviceOff_String, ETrackedDeviceProperty_Prop_DoNotApplyPrediction_Bool, ETrackedDeviceProperty_Prop_CameraToHeadTransforms_Matrix34_Array, ETrackedDeviceProperty_Prop_DistortionMeshResolution_Int32, ETrackedDeviceProperty_Prop_DriverIsDrawingControllers_Bool, ETrackedDeviceProperty_Prop_DriverRequestsApplicationPause_Bool, ETrackedDeviceProperty_Prop_DriverRequestsReducedRendering_Bool, ETrackedDeviceProperty_Prop_MinimumIpdStepMeters_Float, ETrackedDeviceProperty_Prop_AudioBridgeFirmwareVersion_Uint64, ETrackedDeviceProperty_Prop_ImageBridgeFirmwareVersion_Uint64, ETrackedDeviceProperty_Prop_ImuToHeadTransform_Matrix34, ETrackedDeviceProperty_Prop_ImuFactoryGyroBias_Vector3, ETrackedDeviceProperty_Prop_ImuFactoryGyroScale_Vector3, ETrackedDeviceProperty_Prop_ImuFactoryAccelerometerBias_Vector3, ETrackedDeviceProperty_Prop_ImuFactoryAccelerometerScale_Vector3, ETrackedDeviceProperty_Prop_ConfigurationIncludesLighthouse20Features_Bool, ETrackedDeviceProperty_Prop_AdditionalRadioFeatures_Uint64, ETrackedDeviceProperty_Prop_CameraWhiteBalance_Vector4_Array, ETrackedDeviceProperty_Prop_CameraDistortionFunction_Int32_Array, ETrackedDeviceProperty_Prop_CameraDistortionCoefficients_Float_Array, ETrackedDeviceProperty_Prop_ExpectedControllerType_String, ETrackedDeviceProperty_Prop_HmdTrackingStyle_Int32, ETrackedDeviceProperty_Prop_DriverProvidedChaperoneVisibility_Bool, ETrackedDeviceProperty_Prop_HmdColumnCorrectionSettingPrefix_String, ETrackedDeviceProperty_Prop_CameraSupportsCompatibilityModes_Bool, ETrackedDeviceProperty_Prop_DisplayAvailableFrameRates_Float_Array, ETrackedDeviceProperty_Prop_DisplaySupportsMultipleFramerates_Bool, ETrackedDeviceProperty_Prop_DisplayColorMultLeft_Vector3, ETrackedDeviceProperty_Prop_DisplayColorMultRight_Vector3, ETrackedDeviceProperty_Prop_DisplaySupportsRuntimeFramerateChange_Bool, ETrackedDeviceProperty_Prop_DisplaySupportsAnalogGain_Bool, ETrackedDeviceProperty_Prop_DisplayMinAnalogGain_Float, ETrackedDeviceProperty_Prop_DisplayMaxAnalogGain_Float, ETrackedDeviceProperty_Prop_DashboardLayoutPathName_String, ETrackedDeviceProperty_Prop_DashboardScale_Float, ETrackedDeviceProperty_Prop_IpdUIRangeMinMeters_Float, ETrackedDeviceProperty_Prop_IpdUIRangeMaxMeters_Float, ETrackedDeviceProperty_Prop_DriverRequestedMuraCorrectionMode_Int32, ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_InnerLeft_Int32, ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_InnerRight_Int32, ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_InnerTop_Int32, ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_InnerBottom_Int32, ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_OuterLeft_Int32, ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_OuterRight_Int32, ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_OuterTop_Int32, ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_OuterBottom_Int32, ETrackedDeviceProperty_Prop_Audio_DefaultPlaybackDeviceId_String, ETrackedDeviceProperty_Prop_Audio_DefaultRecordingDeviceId_String, ETrackedDeviceProperty_Prop_Audio_DefaultPlaybackDeviceVolume_Float, ETrackedDeviceProperty_Prop_AttachedDeviceId_String, ETrackedDeviceProperty_Prop_SupportedButtons_Uint64, ETrackedDeviceProperty_Prop_Axis0Type_Int32, ETrackedDeviceProperty_Prop_Axis1Type_Int32, ETrackedDeviceProperty_Prop_Axis2Type_Int32, ETrackedDeviceProperty_Prop_Axis3Type_Int32, ETrackedDeviceProperty_Prop_Axis4Type_Int32, ETrackedDeviceProperty_Prop_ControllerRoleHint_Int32, ETrackedDeviceProperty_Prop_FieldOfViewLeftDegrees_Float, ETrackedDeviceProperty_Prop_FieldOfViewRightDegrees_Float, ETrackedDeviceProperty_Prop_FieldOfViewTopDegrees_Float, ETrackedDeviceProperty_Prop_FieldOfViewBottomDegrees_Float, ETrackedDeviceProperty_Prop_TrackingRangeMinimumMeters_Float, ETrackedDeviceProperty_Prop_TrackingRangeMaximumMeters_Float, ETrackedDeviceProperty_Prop_ModeLabel_String, ETrackedDeviceProperty_Prop_CanWirelessIdentify_Bool, ETrackedDeviceProperty_Prop_Nonce_Int32, ETrackedDeviceProperty_Prop_IconPathName_String, ETrackedDeviceProperty_Prop_NamedIconPathDeviceOff_String, ETrackedDeviceProperty_Prop_NamedIconPathDeviceSearching_String, ETrackedDeviceProperty_Prop_NamedIconPathDeviceSearchingAlert_String, ETrackedDeviceProperty_Prop_NamedIconPathDeviceReady_String, ETrackedDeviceProperty_Prop_NamedIconPathDeviceReadyAlert_String, ETrackedDeviceProperty_Prop_NamedIconPathDeviceNotReady_String, ETrackedDeviceProperty_Prop_NamedIconPathDeviceStandby_String, ETrackedDeviceProperty_Prop_NamedIconPathDeviceAlertLow_String, ETrackedDeviceProperty_Prop_NamedIconPathDeviceStandbyAlert_String, ETrackedDeviceProperty_Prop_DisplayHiddenArea_Binary_Start, ETrackedDeviceProperty_Prop_DisplayHiddenArea_Binary_End, ETrackedDeviceProperty_Prop_ParentContainer, ETrackedDeviceProperty_Prop_OverrideContainer_Uint64, ETrackedDeviceProperty_Prop_UserConfigPath_String, ETrackedDeviceProperty_Prop_InstallPath_String, ETrackedDeviceProperty_Prop_HasDisplayComponent_Bool, ETrackedDeviceProperty_Prop_HasControllerComponent_Bool, ETrackedDeviceProperty_Prop_HasCameraComponent_Bool, ETrackedDeviceProperty_Prop_HasDriverDirectModeComponent_Bool, ETrackedDeviceProperty_Prop_HasVirtualDisplayComponent_Bool, ETrackedDeviceProperty_Prop_HasSpatialAnchorsSupport_Bool, ETrackedDeviceProperty_Prop_ControllerType_String, ETrackedDeviceProperty_Prop_ControllerHandSelectionPriority_Int32, ETrackedDeviceProperty_Prop_VendorSpecific_Reserved_Start, ETrackedDeviceProperty_Prop_VendorSpecific_Reserved_End, ETrackedDeviceProperty_Prop_TrackedDeviceProperty_Max
ETrackedDeviceProperty
: Each entry in this enum represents a property that can be retrieved about a tracked device. Many fields are only valid for oneETrackedDeviceClass
.Enum values:
ETrackedDeviceProperty_Prop_Invalid
ETrackedDeviceProperty_Prop_TrackingSystemName_String
ETrackedDeviceProperty_Prop_ModelNumber_String
ETrackedDeviceProperty_Prop_SerialNumber_String
ETrackedDeviceProperty_Prop_RenderModelName_String
ETrackedDeviceProperty_Prop_WillDriftInYaw_Bool
ETrackedDeviceProperty_Prop_ManufacturerName_String
ETrackedDeviceProperty_Prop_TrackingFirmwareVersion_String
ETrackedDeviceProperty_Prop_HardwareRevision_String
ETrackedDeviceProperty_Prop_AllWirelessDongleDescriptions_String
ETrackedDeviceProperty_Prop_ConnectedWirelessDongle_String
ETrackedDeviceProperty_Prop_DeviceIsWireless_Bool
ETrackedDeviceProperty_Prop_DeviceIsCharging_Bool
ETrackedDeviceProperty_Prop_DeviceBatteryPercentage_Float
- 0 is empty, 1 is fullETrackedDeviceProperty_Prop_StatusDisplayTransform_Matrix34
ETrackedDeviceProperty_Prop_Firmware_UpdateAvailable_Bool
ETrackedDeviceProperty_Prop_Firmware_ManualUpdate_Bool
ETrackedDeviceProperty_Prop_Firmware_ManualUpdateURL_String
ETrackedDeviceProperty_Prop_HardwareRevision_Uint64
ETrackedDeviceProperty_Prop_FirmwareVersion_Uint64
ETrackedDeviceProperty_Prop_FPGAVersion_Uint64
ETrackedDeviceProperty_Prop_VRCVersion_Uint64
ETrackedDeviceProperty_Prop_RadioVersion_Uint64
ETrackedDeviceProperty_Prop_DongleVersion_Uint64
ETrackedDeviceProperty_Prop_BlockServerShutdown_Bool
ETrackedDeviceProperty_Prop_CanUnifyCoordinateSystemWithHmd_Bool
ETrackedDeviceProperty_Prop_ContainsProximitySensor_Bool
ETrackedDeviceProperty_Prop_DeviceProvidesBatteryStatus_Bool
ETrackedDeviceProperty_Prop_DeviceCanPowerOff_Bool
ETrackedDeviceProperty_Prop_Firmware_ProgrammingTarget_String
ETrackedDeviceProperty_Prop_DeviceClass_Int32
ETrackedDeviceProperty_Prop_HasCamera_Bool
ETrackedDeviceProperty_Prop_DriverVersion_String
ETrackedDeviceProperty_Prop_Firmware_ForceUpdateRequired_Bool
ETrackedDeviceProperty_Prop_ViveSystemButtonFixRequired_Bool
ETrackedDeviceProperty_Prop_ParentDriver_Uint64
ETrackedDeviceProperty_Prop_ResourceRoot_String
ETrackedDeviceProperty_Prop_RegisteredDeviceType_String
ETrackedDeviceProperty_Prop_InputProfilePath_String
- input profile to use for this device in the input system. Will default to tracking system name if this isn't provided.ETrackedDeviceProperty_Prop_NeverTracked_Bool
- used for devices that will never have a valid pose by design.ETrackedDeviceProperty_Prop_NumCameras_Int32
ETrackedDeviceProperty_Prop_CameraFrameLayout_Int32
-EVRTrackedCameraFrameLayout
valueETrackedDeviceProperty_Prop_CameraStreamFormat_Int32
-ECameraVideoStreamFormat
valueETrackedDeviceProperty_Prop_AdditionalDeviceSettingsPath_String
- driver-relative path to additional device and global configuration settingsETrackedDeviceProperty_Prop_Identifiable_Bool
- Whether device supports being identified from vrmonitor (e.g. blink LED, vibrate haptics, etc)ETrackedDeviceProperty_Prop_BootloaderVersion_Uint64
ETrackedDeviceProperty_Prop_AdditionalSystemReportData_String
- additional string to include in system reports about a tracked deviceETrackedDeviceProperty_Prop_CompositeFirmwareVersion_String
- additional FW components from a device that gets propagated into reportsETrackedDeviceProperty_Prop_Firmware_RemindUpdate_Bool
ETrackedDeviceProperty_Prop_PeripheralApplicationVersion_Uint64
ETrackedDeviceProperty_Prop_ManufacturerSerialNumber_String
ETrackedDeviceProperty_Prop_ComputedSerialNumber_String
ETrackedDeviceProperty_Prop_EstimatedDeviceFirstUseTime_Int32
ETrackedDeviceProperty_Prop_ReportsTimeSinceVSync_Bool
ETrackedDeviceProperty_Prop_SecondsFromVsyncToPhotons_Float
ETrackedDeviceProperty_Prop_DisplayFrequency_Float
ETrackedDeviceProperty_Prop_UserIpdMeters_Float
ETrackedDeviceProperty_Prop_CurrentUniverseId_Uint64
ETrackedDeviceProperty_Prop_PreviousUniverseId_Uint64
ETrackedDeviceProperty_Prop_DisplayFirmwareVersion_Uint64
ETrackedDeviceProperty_Prop_IsOnDesktop_Bool
ETrackedDeviceProperty_Prop_DisplayMCType_Int32
ETrackedDeviceProperty_Prop_DisplayMCOffset_Float
ETrackedDeviceProperty_Prop_DisplayMCScale_Float
ETrackedDeviceProperty_Prop_EdidVendorID_Int32
ETrackedDeviceProperty_Prop_DisplayMCImageLeft_String
ETrackedDeviceProperty_Prop_DisplayMCImageRight_String
ETrackedDeviceProperty_Prop_DisplayGCBlackClamp_Float
ETrackedDeviceProperty_Prop_EdidProductID_Int32
ETrackedDeviceProperty_Prop_CameraToHeadTransform_Matrix34
ETrackedDeviceProperty_Prop_DisplayGCType_Int32
ETrackedDeviceProperty_Prop_DisplayGCOffset_Float
ETrackedDeviceProperty_Prop_DisplayGCScale_Float
ETrackedDeviceProperty_Prop_DisplayGCPrescale_Float
ETrackedDeviceProperty_Prop_DisplayGCImage_String
ETrackedDeviceProperty_Prop_LensCenterLeftU_Float
ETrackedDeviceProperty_Prop_LensCenterLeftV_Float
ETrackedDeviceProperty_Prop_LensCenterRightU_Float
ETrackedDeviceProperty_Prop_LensCenterRightV_Float
ETrackedDeviceProperty_Prop_UserHeadToEyeDepthMeters_Float
ETrackedDeviceProperty_Prop_CameraFirmwareVersion_Uint64
ETrackedDeviceProperty_Prop_CameraFirmwareDescription_String
ETrackedDeviceProperty_Prop_DisplayFPGAVersion_Uint64
ETrackedDeviceProperty_Prop_DisplayBootloaderVersion_Uint64
ETrackedDeviceProperty_Prop_DisplayHardwareVersion_Uint64
ETrackedDeviceProperty_Prop_AudioFirmwareVersion_Uint64
ETrackedDeviceProperty_Prop_CameraCompatibilityMode_Int32
ETrackedDeviceProperty_Prop_ScreenshotHorizontalFieldOfViewDegrees_Float
ETrackedDeviceProperty_Prop_ScreenshotVerticalFieldOfViewDegrees_Float
ETrackedDeviceProperty_Prop_DisplaySuppressed_Bool
ETrackedDeviceProperty_Prop_DisplayAllowNightMode_Bool
ETrackedDeviceProperty_Prop_DisplayMCImageWidth_Int32
ETrackedDeviceProperty_Prop_DisplayMCImageHeight_Int32
ETrackedDeviceProperty_Prop_DisplayMCImageNumChannels_Int32
ETrackedDeviceProperty_Prop_DisplayMCImageData_Binary
ETrackedDeviceProperty_Prop_SecondsFromPhotonsToVblank_Float
ETrackedDeviceProperty_Prop_DriverDirectModeSendsVsyncEvents_Bool
ETrackedDeviceProperty_Prop_DisplayDebugMode_Bool
ETrackedDeviceProperty_Prop_GraphicsAdapterLuid_Uint64
ETrackedDeviceProperty_Prop_DriverProvidedChaperonePath_String
ETrackedDeviceProperty_Prop_ExpectedTrackingReferenceCount_Int32
- expected number of sensors or basestations to reserve UI space forETrackedDeviceProperty_Prop_ExpectedControllerCount_Int32
- expected number of tracked controllers to reserve UI space forETrackedDeviceProperty_Prop_NamedIconPathControllerLeftDeviceOff_String
- placeholder icon for "left" controller if not yet detected/loadedETrackedDeviceProperty_Prop_NamedIconPathControllerRightDeviceOff_String
- placeholder icon for "right" controller if not yet detected/loadedETrackedDeviceProperty_Prop_NamedIconPathTrackingReferenceDeviceOff_String
- placeholder icon for sensor/base if not yet detected/loadedETrackedDeviceProperty_Prop_DoNotApplyPrediction_Bool
- currently no effect. Was used to disable HMD pose prediction on MR, which is now done by MR driver settingvelocity=0
.ETrackedDeviceProperty_Prop_CameraToHeadTransforms_Matrix34_Array
ETrackedDeviceProperty_Prop_DistortionMeshResolution_Int32
- custom resolution of compositor calls toComputeDistortion
ETrackedDeviceProperty_Prop_DriverIsDrawingControllers_Bool
ETrackedDeviceProperty_Prop_DriverRequestsApplicationPause_Bool
ETrackedDeviceProperty_Prop_DriverRequestsReducedRendering_Bool
ETrackedDeviceProperty_Prop_MinimumIpdStepMeters_Float
ETrackedDeviceProperty_Prop_AudioBridgeFirmwareVersion_Uint64
ETrackedDeviceProperty_Prop_ImageBridgeFirmwareVersion_Uint64
ETrackedDeviceProperty_Prop_ImuToHeadTransform_Matrix34
ETrackedDeviceProperty_Prop_ImuFactoryGyroBias_Vector3
ETrackedDeviceProperty_Prop_ImuFactoryGyroScale_Vector3
ETrackedDeviceProperty_Prop_ImuFactoryAccelerometerBias_Vector3
ETrackedDeviceProperty_Prop_ImuFactoryAccelerometerScale_Vector3
ETrackedDeviceProperty_Prop_ConfigurationIncludesLighthouse20Features_Bool
ETrackedDeviceProperty_Prop_AdditionalRadioFeatures_Uint64
ETrackedDeviceProperty_Prop_CameraWhiteBalance_Vector4_Array
-Prop_NumCameras_Int32
-sized array offloat[4]
RGBG white balance calibration data (max size isvr::k_unMaxCameras
)ETrackedDeviceProperty_Prop_CameraDistortionFunction_Int32_Array
-Prop_NumCameras_Int32
-sized array ofvr::EVRDistortionFunctionType
values (max size isvr::k_unMaxCameras
)ETrackedDeviceProperty_Prop_CameraDistortionCoefficients_Float_Array
-Prop_NumCameras_Int32
-sized array ofdouble[vr::k_unMaxDistortionFunctionParameters]
(max size isvr::k_unMaxCameras
)ETrackedDeviceProperty_Prop_ExpectedControllerType_String
ETrackedDeviceProperty_Prop_HmdTrackingStyle_Int32
- one ofEHmdTrackingStyle
ETrackedDeviceProperty_Prop_DriverProvidedChaperoneVisibility_Bool
ETrackedDeviceProperty_Prop_HmdColumnCorrectionSettingPrefix_String
ETrackedDeviceProperty_Prop_CameraSupportsCompatibilityModes_Bool
ETrackedDeviceProperty_Prop_DisplayAvailableFrameRates_Float_Array
- populated by compositor from actual EDID list when available from GPU driverETrackedDeviceProperty_Prop_DisplaySupportsMultipleFramerates_Bool
- if this is true butETrackedDeviceProperty_Prop_DisplayAvailableFrameRates_Float_Array
is empty, explain to userETrackedDeviceProperty_Prop_DisplayColorMultLeft_Vector3
ETrackedDeviceProperty_Prop_DisplayColorMultRight_Vector3
ETrackedDeviceProperty_Prop_DisplaySupportsRuntimeFramerateChange_Bool
ETrackedDeviceProperty_Prop_DisplaySupportsAnalogGain_Bool
ETrackedDeviceProperty_Prop_DisplayMinAnalogGain_Float
ETrackedDeviceProperty_Prop_DisplayMaxAnalogGain_Float
ETrackedDeviceProperty_Prop_DashboardLayoutPathName_String
ETrackedDeviceProperty_Prop_DashboardScale_Float
ETrackedDeviceProperty_Prop_IpdUIRangeMinMeters_Float
ETrackedDeviceProperty_Prop_IpdUIRangeMaxMeters_Float
ETrackedDeviceProperty_Prop_DriverRequestedMuraCorrectionMode_Int32
ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_InnerLeft_Int32
ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_InnerRight_Int32
ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_InnerTop_Int32
ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_InnerBottom_Int32
ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_OuterLeft_Int32
ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_OuterRight_Int32
ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_OuterTop_Int32
ETrackedDeviceProperty_Prop_DriverRequestedMuraFeather_OuterBottom_Int32
ETrackedDeviceProperty_Prop_Audio_DefaultPlaybackDeviceId_String
ETrackedDeviceProperty_Prop_Audio_DefaultRecordingDeviceId_String
ETrackedDeviceProperty_Prop_Audio_DefaultPlaybackDeviceVolume_Float
ETrackedDeviceProperty_Prop_AttachedDeviceId_String
ETrackedDeviceProperty_Prop_SupportedButtons_Uint64
ETrackedDeviceProperty_Prop_Axis0Type_Int32
ETrackedDeviceProperty_Prop_Axis1Type_Int32
ETrackedDeviceProperty_Prop_Axis2Type_Int32
ETrackedDeviceProperty_Prop_Axis3Type_Int32
ETrackedDeviceProperty_Prop_Axis4Type_Int32
ETrackedDeviceProperty_Prop_ControllerRoleHint_Int32
ETrackedDeviceProperty_Prop_FieldOfViewLeftDegrees_Float
ETrackedDeviceProperty_Prop_FieldOfViewRightDegrees_Float
ETrackedDeviceProperty_Prop_FieldOfViewTopDegrees_Float
ETrackedDeviceProperty_Prop_FieldOfViewBottomDegrees_Float
ETrackedDeviceProperty_Prop_TrackingRangeMinimumMeters_Float
ETrackedDeviceProperty_Prop_TrackingRangeMaximumMeters_Float
ETrackedDeviceProperty_Prop_ModeLabel_String
ETrackedDeviceProperty_Prop_CanWirelessIdentify_Bool
- volatile, based on radio presence and fw discoveryETrackedDeviceProperty_Prop_Nonce_Int32
ETrackedDeviceProperty_Prop_IconPathName_String
- usually a directory named "icons"ETrackedDeviceProperty_Prop_NamedIconPathDeviceOff_String
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_NamedIconPathDeviceSearching_String
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_NamedIconPathDeviceSearchingAlert_String
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_NamedIconPathDeviceReady_String
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_NamedIconPathDeviceReadyAlert_String
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_NamedIconPathDeviceNotReady_String
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_NamedIconPathDeviceStandby_String
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_NamedIconPathDeviceAlertLow_String
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_NamedIconPathDeviceStandbyAlert_String
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_DisplayHiddenArea_Binary_Start
ETrackedDeviceProperty_Prop_DisplayHiddenArea_Binary_End
ETrackedDeviceProperty_Prop_ParentContainer
ETrackedDeviceProperty_Prop_OverrideContainer_Uint64
ETrackedDeviceProperty_Prop_UserConfigPath_String
ETrackedDeviceProperty_Prop_InstallPath_String
ETrackedDeviceProperty_Prop_HasDisplayComponent_Bool
ETrackedDeviceProperty_Prop_HasControllerComponent_Bool
ETrackedDeviceProperty_Prop_HasCameraComponent_Bool
ETrackedDeviceProperty_Prop_HasDriverDirectModeComponent_Bool
ETrackedDeviceProperty_Prop_HasVirtualDisplayComponent_Bool
ETrackedDeviceProperty_Prop_HasSpatialAnchorsSupport_Bool
ETrackedDeviceProperty_Prop_ControllerType_String
ETrackedDeviceProperty_Prop_ControllerHandSelectionPriority_Int32
- Allows hand assignments to prefer some controllers over others. High numbers are selected over low numbers.ETrackedDeviceProperty_Prop_VendorSpecific_Reserved_Start
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_VendorSpecific_Reserved_End
- PNG for static icon, or GIF for animation, 50x32 for headsets and 32x32 for othersETrackedDeviceProperty_Prop_TrackedDeviceProperty_Max
-
ETrackedPropertyError_TrackedProp_Success, ETrackedPropertyError_TrackedProp_WrongDataType, ETrackedPropertyError_TrackedProp_WrongDeviceClass, ETrackedPropertyError_TrackedProp_BufferTooSmall, ETrackedPropertyError_TrackedProp_UnknownProperty, ETrackedPropertyError_TrackedProp_InvalidDevice, ETrackedPropertyError_TrackedProp_CouldNotContactServer, ETrackedPropertyError_TrackedProp_ValueNotProvidedByDevice, ETrackedPropertyError_TrackedProp_StringExceedsMaximumLength, ETrackedPropertyError_TrackedProp_NotYetAvailable, ETrackedPropertyError_TrackedProp_PermissionDenied, ETrackedPropertyError_TrackedProp_InvalidOperation, ETrackedPropertyError_TrackedProp_CannotWriteToWildcards, ETrackedPropertyError_TrackedProp_IPCReadFailure, ETrackedPropertyError_TrackedProp_OutOfMemory, ETrackedPropertyError_TrackedProp_InvalidContainer
ETrackedPropertyError
: Used to return errors that occur when reading properties.Enum values:
ETrackedPropertyError_TrackedProp_Success
ETrackedPropertyError_TrackedProp_WrongDataType
ETrackedPropertyError_TrackedProp_WrongDeviceClass
ETrackedPropertyError_TrackedProp_BufferTooSmall
ETrackedPropertyError_TrackedProp_UnknownProperty
- Driver has not set the property (and may not ever).ETrackedPropertyError_TrackedProp_InvalidDevice
ETrackedPropertyError_TrackedProp_CouldNotContactServer
ETrackedPropertyError_TrackedProp_ValueNotProvidedByDevice
ETrackedPropertyError_TrackedProp_StringExceedsMaximumLength
ETrackedPropertyError_TrackedProp_NotYetAvailable
- The property value isn't known yet, but is expected soon. Call again later.ETrackedPropertyError_TrackedProp_PermissionDenied
ETrackedPropertyError_TrackedProp_InvalidOperation
ETrackedPropertyError_TrackedProp_CannotWriteToWildcards
ETrackedPropertyError_TrackedProp_IPCReadFailure
ETrackedPropertyError_TrackedProp_OutOfMemory
ETrackedPropertyError_TrackedProp_InvalidContainer
-
EHmdTrackingStyle_HmdTrackingStyle_Unknown, EHmdTrackingStyle_HmdTrackingStyle_Lighthouse, EHmdTrackingStyle_HmdTrackingStyle_OutsideInCameras, EHmdTrackingStyle_HmdTrackingStyle_InsideOutCameras
EHmdTrackingStyle
: Used to drive certain text in the UI when talking about the tracking system for the HMD.Enum values:
EHmdTrackingStyle_HmdTrackingStyle_Unknown
EHmdTrackingStyle_HmdTrackingStyle_Lighthouse
- Base stations and lasers.EHmdTrackingStyle_HmdTrackingStyle_OutsideInCameras
- Cameras and LED, Rift 1 style.EHmdTrackingStyle_HmdTrackingStyle_InsideOutCameras
- Cameras on HMD looking at the world.
-
EVRSubmitFlags_Submit_Default, EVRSubmitFlags_Submit_LensDistortionAlreadyApplied, EVRSubmitFlags_Submit_GlRenderBuffer, EVRSubmitFlags_Submit_Reserved, EVRSubmit_TextureWithPose, EVRSubmitFlags_Submit_TextureWithDepth
EVRSubmitFlags
: Allows the application to control how scene textures are used by the compositor when callingSubmit
.Enum values:
EVRSubmitFlags_Submit_Default
- Simple render path. App submits rendered left and right eye images with no lens distortion correction applied.EVRSubmitFlags_Submit_LensDistortionAlreadyApplied
- App submits final left and right eye images with lens distortion already applied (lens distortion makes the images appear barrel distorted with chromatic aberration correction applied). The app would have used the data returned byComputeDistortion
to apply the correct distortion to the rendered images before callingSubmit
.EVRSubmitFlags_Submit_GlRenderBuffer
- If the texture pointer passed in is actually a renderbuffer (e.g. for MSAA in OpenGL) then set this flag.EVRSubmitFlags_Submit_Reserved
- Do not use.EVRSubmit_TextureWithPose
- Set to indicate thatpTexture
is a pointer to aVRTextureWithPose
.This flag can be combined with
EVRSubmitFlags_Submit_TextureWithDepth
to pass aVRTextureWithPoseAndDepth
.EVRSubmitFlags_Submit_TextureWithDepth
- Set to indicate thatpTexture
is a pointer to aVRTextureWithDepth
.This flag can be combined with
EVRSubmit_TextureWithPose
to pass aVRTextureWithPoseAndDepth
.
-
EVRState_VRState_Undefined, EVRState_VRState_Off, EVRState_VRState_Searching, EVRState_VRState_Searching_Alert, EVRState_VRState_Ready, EVRState_VRState_Ready_Alert, EVRState_VRState_NotReady, EVRState_VRState_Standby, EVRState_VRState_Ready_Alert_Low
EVRState
: Status of the overall system or tracked objects.Enum values:
-
EVREventType_VREvent_None, EVREventType_VREvent_TrackedDeviceActivated, EVREventType_VREvent_TrackedDeviceDeactivated, EVREventType_VREvent_TrackedDeviceUpdated, EVREventType_VREvent_TrackedDeviceUserInteractionStarted, EVREventType_VREvent_TrackedDeviceUserInteractionEnded, EVREventType_VREvent_IpdChanged, EVREventType_VREvent_EnterStandbyMode, EVREventType_VREvent_LeaveStandbyMode, EVREventType_VREvent_TrackedDeviceRoleChanged, EVREventType_VREvent_WatchdogWakeUpRequested, EVREventType_VREvent_LensDistortionChanged, EVREventType_VREvent_PropertyChanged, EVREventType_VREvent_WirelessDisconnect, EVREventType_VREvent_WirelessReconnect, EVREventType_VREvent_ButtonPress, EVREventType_VREvent_ButtonUnpress, EVREventType_VREvent_ButtonTouch, EVREventType_VREvent_ButtonUntouch, EVREventType_VREvent_DualAnalog_Press, EVREventType_VREvent_DualAnalog_Unpress, EVREventType_VREvent_DualAnalog_Touch, EVREventType_VREvent_DualAnalog_Untouch, EVREventType_VREvent_DualAnalog_Move, EVREventType_VREvent_DualAnalog_ModeSwitch1, EVREventType_VREvent_DualAnalog_ModeSwitch2, EVREventType_VREvent_DualAnalog_Cancel, EVREventType_VREvent_MouseMove, EVREventType_VREvent_MouseButtonDown, EVREventType_VREvent_MouseButtonUp, EVREventType_VREvent_FocusEnter, EVREventType_VREvent_FocusLeave, EVREventType_VREvent_ScrollDiscrete, EVREventType_VREvent_TouchPadMove, EVREventType_VREvent_OverlayFocusChanged, EVREventType_VREvent_ReloadOverlays, EVREventType_VREvent_ScrollSmooth, EVREventType_VREvent_InputFocusCaptured, EVREventType_VREvent_InputFocusReleased, EVREventType_VREvent_SceneApplicationChanged, EVREventType_VREvent_SceneFocusChanged, EVREventType_VREvent_InputFocusChanged, EVREventType_VREvent_SceneApplicationUsingWrongGraphicsAdapter, EVREventType_VREvent_ActionBindingReloaded, EVREventType_VREvent_HideRenderModels, EVREventType_VREvent_ShowRenderModels, EVREventType_VREvent_SceneApplicationStateChanged, EVREventType_VREvent_ConsoleOpened, EVREventType_VREvent_ConsoleClosed, EVREventType_VREvent_OverlayShown, EVREventType_VREvent_OverlayHidden, EVREventType_VREvent_DashboardActivated, EVREventType_VREvent_DashboardDeactivated, EVREventType_VREvent_DashboardRequested, EVREventType_VREvent_ResetDashboard, EVREventType_VREvent_RenderToast, EVREventType_VREvent_ImageLoaded, EVREventType_VREvent_ShowKeyboard, EVREventType_VREvent_HideKeyboard, EVREventType_VREvent_OverlayGamepadFocusGained, EVREventType_VREvent_OverlayGamepadFocusLost, EVREventType_VREvent_OverlaySharedTextureChanged, EVREventType_VREvent_ScreenshotTriggered, EVREventType_VREvent_ImageFailed, EVREventType_VREvent_DashboardOverlayCreated, EVREventType_VREvent_SwitchGamepadFocus, EVREventType_VREvent_RequestScreenshot, EVREventType_VREvent_ScreenshotTaken, EVREventType_VREvent_ScreenshotFailed, EVREventType_VREvent_SubmitScreenshotToDashboard, EVREventType_VREvent_ScreenshotProgressToDashboard, EVREventType_VREvent_PrimaryDashboardDeviceChanged, EVREventType_VREvent_RoomViewShown, EVREventType_VREvent_RoomViewHidden, EVREventType_VREvent_ShowUI, EVREventType_VREvent_ShowDevTools, EVREventType_VREvent_Notification_Shown, EVREventType_VREvent_Notification_Hidden, EVREventType_VREvent_Notification_BeginInteraction, EVREventType_VREvent_Notification_Destroyed, EVREventType_VREvent_Quit, EVREventType_VREvent_ProcessQuit, EVREventType_VREvent_QuitAcknowledged, EVREventType_VREvent_DriverRequestedQuit, EVREventType_VREvent_RestartRequested, EVREventType_VREvent_ChaperoneDataHasChanged, EVREventType_VREvent_ChaperoneUniverseHasChanged, EVREventType_VREvent_ChaperoneTempDataHasChanged, EVREventType_VREvent_ChaperoneSettingsHaveChanged, EVREventType_VREvent_SeatedZeroPoseReset, EVREventType_VREvent_ChaperoneFlushCache, EVREventType_VREvent_ChaperoneRoomSetupStarting, EVREventType_VREvent_ChaperoneRoomSetupFinished, EVREventType_VREvent_AudioSettingsHaveChanged, EVREventType_VREvent_BackgroundSettingHasChanged, EVREventType_VREvent_CameraSettingsHaveChanged, EVREventType_VREvent_ReprojectionSettingHasChanged, EVREventType_VREvent_ModelSkinSettingsHaveChanged, EVREventType_VREvent_EnvironmentSettingsHaveChanged, EVREventType_VREvent_PowerSettingsHaveChanged, EVREventType_VREvent_EnableHomeAppSettingsHaveChanged, EVREventType_VREvent_SteamVRSectionSettingChanged, EVREventType_VREvent_LighthouseSectionSettingChanged, EVREventType_VREvent_NullSectionSettingChanged, EVREventType_VREvent_UserInterfaceSectionSettingChanged, EVREventType_VREvent_NotificationsSectionSettingChanged, EVREventType_VREvent_KeyboardSectionSettingChanged, EVREventType_VREvent_PerfSectionSettingChanged, EVREventType_VREvent_DashboardSectionSettingChanged, EVREventType_VREvent_WebInterfaceSectionSettingChanged, EVREventType_VREvent_TrackersSectionSettingChanged, EVREventType_VREvent_LastKnownSectionSettingChanged, EVREventType_VREvent_DismissedWarningsSectionSettingChanged, EVREventType_VREvent_GpuSpeedSectionSettingChanged, EVREventType_VREvent_StatusUpdate, EVREventType_VREvent_WebInterface_InstallDriverCompleted, EVREventType_VREvent_MCImageUpdated, EVREventType_VREvent_FirmwareUpdateStarted, EVREventType_VREvent_FirmwareUpdateFinished, EVREventType_VREvent_KeyboardClosed, EVREventType_VREvent_KeyboardCharInput, EVREventType_VREvent_KeyboardDone, EVREventType_VREvent_ApplicationListUpdated, EVREventType_VREvent_ApplicationMimeTypeLoad, EVREventType_VREvent_ProcessConnected, EVREventType_VREvent_ProcessDisconnected, EVREventType_VREvent_Compositor_ChaperoneBoundsShown, EVREventType_VREvent_Compositor_ChaperoneBoundsHidden, EVREventType_VREvent_Compositor_DisplayDisconnected, EVREventType_VREvent_Compositor_DisplayReconnected, EVREventType_VREvent_Compositor_HDCPError, EVREventType_VREvent_Compositor_ApplicationNotResponding, EVREventType_VREvent_Compositor_ApplicationResumed, EVREventType_VREvent_Compositor_OutOfVideoMemory, EVREventType_VREvent_Compositor_DisplayModeNotSupported, EVREventType_VREvent_Compositor_StageOverrideReady, EVREventType_VREvent_TrackedCamera_StartVideoStream, EVREventType_VREvent_TrackedCamera_StopVideoStream, EVREventType_VREvent_TrackedCamera_PauseVideoStream, EVREventType_VREvent_TrackedCamera_ResumeVideoStream, EVREventType_VREvent_TrackedCamera_EditingSurface, EVREventType_VREvent_PerformanceTest_EnableCapture, EVREventType_VREvent_PerformanceTest_DisableCapture, EVREventType_VREvent_PerformanceTest_FidelityLevel, EVREventType_VREvent_MessageOverlay_Closed, EVREventType_VREvent_MessageOverlayCloseRequested, EVREventType_VREvent_Input_HapticVibration, EVREventType_VREvent_Input_BindingLoadFailed, EVREventType_VREvent_Input_BindingLoadSuccessful, EVREventType_VREvent_Input_ActionManifestReloaded, EVREventType_VREvent_Input_ActionManifestLoadFailed, EVREventType_VREvent_Input_ProgressUpdate, EVREventType_VREvent_Input_TrackerActivated, EVREventType_VREvent_Input_BindingsUpdated, EVREventType_VREvent_Input_BindingSubscriptionChanged, EVREventType_VREvent_SpatialAnchors_PoseUpdated, EVREventType_VREvent_SpatialAnchors_DescriptorUpdated, EVREventType_VREvent_SpatialAnchors_RequestPoseUpdate, EVREventType_VREvent_SpatialAnchors_RequestDescriptorUpdate, EVREventType_VREvent_SystemReport_Started, EVREventType_VREvent_Monitor_ShowHeadsetView, EVREventType_VREvent_Monitor_HideHeadsetView, EVREventType_VREvent_VendorSpecific_Reserved_Start, EVREventType_VREvent_VendorSpecific_Reserved_End
EVREventType
: The types of events that could be posted (and what the parameters mean for each event type).Enum values:
EVREventType_VREvent_None
EVREventType_VREvent_TrackedDeviceActivated
EVREventType_VREvent_TrackedDeviceDeactivated
EVREventType_VREvent_TrackedDeviceUpdated
EVREventType_VREvent_TrackedDeviceUserInteractionStarted
EVREventType_VREvent_TrackedDeviceUserInteractionEnded
EVREventType_VREvent_IpdChanged
EVREventType_VREvent_EnterStandbyMode
EVREventType_VREvent_LeaveStandbyMode
EVREventType_VREvent_TrackedDeviceRoleChanged
EVREventType_VREvent_WatchdogWakeUpRequested
EVREventType_VREvent_LensDistortionChanged
EVREventType_VREvent_PropertyChanged
EVREventType_VREvent_WirelessDisconnect
EVREventType_VREvent_WirelessReconnect
EVREventType_VREvent_ButtonPress
- data is controllerEVREventType_VREvent_ButtonUnpress
- data is controllerEVREventType_VREvent_ButtonTouch
- data is controllerEVREventType_VREvent_ButtonUntouch
- data is controllerEVREventType_VREvent_DualAnalog_Press
- data is dualAnalogEVREventType_VREvent_DualAnalog_Unpress
- data is dualAnalogEVREventType_VREvent_DualAnalog_Touch
- data is dualAnalogEVREventType_VREvent_DualAnalog_Untouch
- data is dualAnalogEVREventType_VREvent_DualAnalog_Move
- data is dualAnalogEVREventType_VREvent_DualAnalog_ModeSwitch1
- data is dualAnalogEVREventType_VREvent_DualAnalog_ModeSwitch2
- data is dualAnalogEVREventType_VREvent_DualAnalog_Cancel
- data is dualAnalogEVREventType_VREvent_MouseMove
- data is mouseEVREventType_VREvent_MouseButtonDown
- data is mouseEVREventType_VREvent_MouseButtonUp
- data is mouseEVREventType_VREvent_FocusEnter
- data is overlayEVREventType_VREvent_FocusLeave
- data is overlayEVREventType_VREvent_ScrollDiscrete
- data is scrollEVREventType_VREvent_TouchPadMove
- data is mouseEVREventType_VREvent_OverlayFocusChanged
- data is overlay, global eventEVREventType_VREvent_ReloadOverlays
EVREventType_VREvent_ScrollSmooth
- data is scrollEVREventType_VREvent_InputFocusCaptured
- data is process DEPRECATEDEVREventType_VREvent_InputFocusReleased
- data is process DEPRECATEDEVREventType_VREvent_SceneApplicationChanged
- data is process - The App actually drawing the scene changed (usually to or from the compositor)EVREventType_VREvent_SceneFocusChanged
- data is process - New app got access to draw the sceneEVREventType_VREvent_InputFocusChanged
- data is processEVREventType_VREvent_SceneApplicationUsingWrongGraphicsAdapter
- data is processEVREventType_VREvent_ActionBindingReloaded
- data is process - The App that action binds reloaded forEVREventType_VREvent_HideRenderModels
- Sent to the scene application to request hiding render models temporarilyEVREventType_VREvent_ShowRenderModels
- Sent to the scene application to request restoring render model visibilityEVREventType_VREvent_SceneApplicationStateChanged
- No data; but queryVRApplications()->GetSceneApplicationState();
EVREventType_VREvent_ConsoleOpened
EVREventType_VREvent_ConsoleClosed
EVREventType_VREvent_OverlayShown
EVREventType_VREvent_OverlayHidden
EVREventType_VREvent_DashboardActivated
EVREventType_VREvent_DashboardDeactivated
EVREventType_VREvent_DashboardRequested
- Sent to the overlay manager - data is overlayEVREventType_VREvent_ResetDashboard
- Sent to the overlay managerEVREventType_VREvent_RenderToast
- Sent to the dashboard to render a toast - data is the notification IDEVREventType_VREvent_ImageLoaded
- Sent to overlays when a SetOverlayRaw or SetOverlayFromFile call finishes loadingEVREventType_VREvent_ShowKeyboard
- Sent to keyboard renderer in the dashboard to invoke itEVREventType_VREvent_HideKeyboard
- Sent to keyboard renderer in the dashboard to hide itEVREventType_VREvent_OverlayGamepadFocusGained
- Sent to an overlay when IVROverlay::SetFocusOverlay is called on itEVREventType_VREvent_OverlayGamepadFocusLost
- Send to an overlay when it previously had focus and IVROverlay::SetFocusOverlay is called on something elseEVREventType_VREvent_OverlaySharedTextureChanged
EVREventType_VREvent_ScreenshotTriggered
- Screenshot button combo was pressed, Dashboard should request a screenshotEVREventType_VREvent_ImageFailed
- Sent to overlays when a SetOverlayRaw or SetOverlayfromFail fails to loadEVREventType_VREvent_DashboardOverlayCreated
EVREventType_VREvent_SwitchGamepadFocus
EVREventType_VREvent_RequestScreenshot
- Sent by vrclient application to compositor to take a screenshotEVREventType_VREvent_ScreenshotTaken
- Sent by compositor to the application that the screenshot has been takenEVREventType_VREvent_ScreenshotFailed
- Sent by compositor to the application that the screenshot failed to be takenEVREventType_VREvent_SubmitScreenshotToDashboard
- Sent by compositor to the dashboard that a completed screenshot was submittedEVREventType_VREvent_ScreenshotProgressToDashboard
- Sent by compositor to the dashboard that a completed screenshot was submittedEVREventType_VREvent_PrimaryDashboardDeviceChanged
EVREventType_VREvent_RoomViewShown
- Sent by compositor whenever room-view is enabledEVREventType_VREvent_RoomViewHidden
- Sent by compositor whenever room-view is disabledEVREventType_VREvent_ShowUI
- data is showUiEVREventType_VREvent_ShowDevTools
- data is showDevToolsEVREventType_VREvent_Notification_Shown
EVREventType_VREvent_Notification_Hidden
EVREventType_VREvent_Notification_BeginInteraction
EVREventType_VREvent_Notification_Destroyed
EVREventType_VREvent_Quit
- data is processEVREventType_VREvent_ProcessQuit
- data is processEVREventType_VREvent_QuitAcknowledged
- data is processEVREventType_VREvent_DriverRequestedQuit
- The driver has requested that SteamVR shut downEVREventType_VREvent_RestartRequested
- A driver or other component wants the user to restart SteamVREVREventType_VREvent_ChaperoneDataHasChanged
- this will never happen with the new chaperone systemEVREventType_VREvent_ChaperoneUniverseHasChanged
EVREventType_VREvent_ChaperoneTempDataHasChanged
- this will never happen with the new chaperone systemEVREventType_VREvent_ChaperoneSettingsHaveChanged
EVREventType_VREvent_SeatedZeroPoseReset
EVREventType_VREvent_ChaperoneFlushCache
- Sent when the process needs to reload any cached data it retrieved fromVRChaperone()
EVREventType_VREvent_ChaperoneRoomSetupStarting
- Triggered byCVRChaperoneClient::RoomSetupStarting
EVREventType_VREvent_ChaperoneRoomSetupFinished
- Triggered byCVRChaperoneClient::CommitWorkingCopy
EVREventType_VREvent_AudioSettingsHaveChanged
EVREventType_VREvent_BackgroundSettingHasChanged
EVREventType_VREvent_CameraSettingsHaveChanged
EVREventType_VREvent_ReprojectionSettingHasChanged
EVREventType_VREvent_ModelSkinSettingsHaveChanged
EVREventType_VREvent_EnvironmentSettingsHaveChanged
EVREventType_VREvent_PowerSettingsHaveChanged
EVREventType_VREvent_EnableHomeAppSettingsHaveChanged
EVREventType_VREvent_SteamVRSectionSettingChanged
EVREventType_VREvent_LighthouseSectionSettingChanged
EVREventType_VREvent_NullSectionSettingChanged
EVREventType_VREvent_UserInterfaceSectionSettingChanged
EVREventType_VREvent_NotificationsSectionSettingChanged
EVREventType_VREvent_KeyboardSectionSettingChanged
EVREventType_VREvent_PerfSectionSettingChanged
EVREventType_VREvent_DashboardSectionSettingChanged
EVREventType_VREvent_WebInterfaceSectionSettingChanged
EVREventType_VREvent_TrackersSectionSettingChanged
EVREventType_VREvent_LastKnownSectionSettingChanged
EVREventType_VREvent_DismissedWarningsSectionSettingChanged
EVREventType_VREvent_GpuSpeedSectionSettingChanged
EVREventType_VREvent_StatusUpdate
EVREventType_VREvent_WebInterface_InstallDriverCompleted
EVREventType_VREvent_MCImageUpdated
EVREventType_VREvent_FirmwareUpdateStarted
EVREventType_VREvent_FirmwareUpdateFinished
EVREventType_VREvent_KeyboardClosed
EVREventType_VREvent_KeyboardCharInput
EVREventType_VREvent_KeyboardDone
- Sent when DONE button clicked on keyboardEVREventType_VREvent_ApplicationListUpdated
EVREventType_VREvent_ApplicationMimeTypeLoad
EVREventType_VREvent_ProcessConnected
EVREventType_VREvent_ProcessDisconnected
EVREventType_VREvent_Compositor_ChaperoneBoundsShown
EVREventType_VREvent_Compositor_ChaperoneBoundsHidden
EVREventType_VREvent_Compositor_DisplayDisconnected
EVREventType_VREvent_Compositor_DisplayReconnected
EVREventType_VREvent_Compositor_HDCPError
- data is hdcpErrorEVREventType_VREvent_Compositor_ApplicationNotResponding
EVREventType_VREvent_Compositor_ApplicationResumed
EVREventType_VREvent_Compositor_OutOfVideoMemory
EVREventType_VREvent_Compositor_DisplayModeNotSupported
-k_pch_SteamVR_PreferredRefreshRate
EVREventType_VREvent_Compositor_StageOverrideReady
EVREventType_VREvent_TrackedCamera_StartVideoStream
EVREventType_VREvent_TrackedCamera_StopVideoStream
EVREventType_VREvent_TrackedCamera_PauseVideoStream
EVREventType_VREvent_TrackedCamera_ResumeVideoStream
EVREventType_VREvent_TrackedCamera_EditingSurface
EVREventType_VREvent_PerformanceTest_EnableCapture
EVREventType_VREvent_PerformanceTest_DisableCapture
EVREventType_VREvent_PerformanceTest_FidelityLevel
EVREventType_VREvent_MessageOverlay_Closed
EVREventType_VREvent_MessageOverlayCloseRequested
EVREventType_VREvent_Input_HapticVibration
EVREventType_VREvent_Input_BindingLoadFailed
- data is inputBindingEVREventType_VREvent_Input_BindingLoadSuccessful
- data is inputBindingEVREventType_VREvent_Input_ActionManifestReloaded
- no dataEVREventType_VREvent_Input_ActionManifestLoadFailed
- data is actionManifestEVREventType_VREvent_Input_ProgressUpdate
- data is progressUpdateEVREventType_VREvent_Input_TrackerActivated
EVREventType_VREvent_Input_BindingsUpdated
EVREventType_VREvent_Input_BindingSubscriptionChanged
EVREventType_VREvent_SpatialAnchors_PoseUpdated
- data is spatialAnchor. broadcastEVREventType_VREvent_SpatialAnchors_DescriptorUpdated
- data is spatialAnchor. broadcastEVREventType_VREvent_SpatialAnchors_RequestPoseUpdate
- data is spatialAnchor. sent to specific driverEVREventType_VREvent_SpatialAnchors_RequestDescriptorUpdate
- data is spatialAnchor. sent to specific driverEVREventType_VREvent_SystemReport_Started
- user or system initiated generation of a system report. broadcastEVREventType_VREvent_Monitor_ShowHeadsetView
- data is processEVREventType_VREvent_Monitor_HideHeadsetView
- data is processEVREventType_VREvent_VendorSpecific_Reserved_Start
EVREventType_VREvent_VendorSpecific_Reserved_End
-
EDeviceActivityLevel_k_EDeviceActivityLevel_Unknown, EDeviceActivityLevel_k_EDeviceActivityLevel_Idle, EDeviceActivityLevel_k_EDeviceActivityLevel_UserInteraction, EDeviceActivityLevel_k_EDeviceActivityLevel_UserInteraction_Timeout, EDeviceActivityLevel_k_EDeviceActivityLevel_Standby, EDeviceActivityLevel_k_EDeviceActivityLevel_Idle_Timeout
EDeviceActivityLevel
: Level of Hmd activity.Enum values:
EDeviceActivityLevel_k_EDeviceActivityLevel_Unknown
EDeviceActivityLevel_k_EDeviceActivityLevel_Idle
- No activity for the last 10 seconds.EDeviceActivityLevel_k_EDeviceActivityLevel_UserInteraction
- Activity (movement or prox sensor) is happening now.EDeviceActivityLevel_k_EDeviceActivityLevel_UserInteraction_Timeout
- No activity for the last 0.5 seconds.EDeviceActivityLevel_k_EDeviceActivityLevel_Standby
- Idle for at least 5 seconds (configurable in Settings -> Power Management).EDeviceActivityLevel_k_EDeviceActivityLevel_Idle_Timeout
-
EVRButtonId_k_EButton_System, EVRButtonId_k_EButton_ApplicationMenu, EVRButtonId_k_EButton_Grip, EVRButtonId_k_EButton_DPad_Left, EVRButtonId_k_EButton_DPad_Up, EVRButtonId_k_EButton_DPad_Right, EVRButtonId_k_EButton_DPad_Down, EVRButtonId_k_EButton_A, EVRButtonId_k_EButton_ProximitySensor, EVRButtonId_k_EButton_Axis0, EVRButtonId_k_EButton_Axis1, EVRButtonId_k_EButton_Axis2, EVRButtonId_k_EButton_Axis3, EVRButtonId_k_EButton_Axis4, EVRButtonId_k_EButton_SteamVR_Touchpad, EVRButtonId_k_EButton_SteamVR_Trigger, EVRButtonId_k_EButton_Dashboard_Back, EVRButtonId_k_EButton_IndexController_A, EVRButtonId_k_EButton_IndexController_B, EVRButtonId_k_EButton_IndexController_JoyStick, EVRButtonId_k_EButton_Max
EVRButtonId
: VR controller button and axis IDs.Enum values:
EVRButtonId_k_EButton_System
EVRButtonId_k_EButton_ApplicationMenu
EVRButtonId_k_EButton_Grip
EVRButtonId_k_EButton_DPad_Left
EVRButtonId_k_EButton_DPad_Up
EVRButtonId_k_EButton_DPad_Right
EVRButtonId_k_EButton_DPad_Down
EVRButtonId_k_EButton_A
EVRButtonId_k_EButton_ProximitySensor
EVRButtonId_k_EButton_Axis0
EVRButtonId_k_EButton_Axis1
EVRButtonId_k_EButton_Axis2
EVRButtonId_k_EButton_Axis3
EVRButtonId_k_EButton_Axis4
EVRButtonId_k_EButton_SteamVR_Touchpad
EVRButtonId_k_EButton_SteamVR_Trigger
EVRButtonId_k_EButton_Dashboard_Back
EVRButtonId_k_EButton_IndexController_A
EVRButtonId_k_EButton_IndexController_B
EVRButtonId_k_EButton_IndexController_JoyStick
EVRButtonId_k_EButton_Max
-
EVRMouseButton_VRMouseButton_Left, EVRMouseButton_VRMouseButton_Right, EVRMouseButton_VRMouseButton_Middle
EVRMouseButton
: used for simulated mouse events in overlay space.Enum values:
-
EDualAnalogWhich_k_EDualAnalog_Left, EDualAnalogWhich_k_EDualAnalog_Right
EDualAnalogWhich
Enum values:
-
EShowUIType_ShowUI_ControllerBinding, EShowUIType_ShowUI_ManageTrackers, EShowUIType_ShowUI_Pairing, EShowUIType_ShowUI_Settings, EShowUIType_ShowUI_DebugCommands, EShowUIType_ShowUI_FullControllerBinding
-
EHDCPError_HDCPError_None, EHDCPError_HDCPError_LinkLost, EHDCPError_HDCPError_Tampered, EHDCPError_HDCPError_DeviceRevoked, EHDCPError_HDCPError_Unknown
-
EVRInputError_VRInputError_None, EVRInputError_VRInputError_NameNotFound, EVRInputError_VRInputError_WrongType, EVRInputError_VRInputError_InvalidHandle, EVRInputError_VRInputError_InvalidParam, EVRInputError_VRInputError_NoSteam, EVRInputError_VRInputError_MaxCapacityReached, EVRInputError_VRInputError_IPCError, EVRInputError_VRInputError_NoActiveActionSet, EVRInputError_VRInputError_InvalidDevice, EVRInputError_VRInputError_InvalidSkeleton, EVRInputError_VRInputError_InvalidBoneCount, EVRInputError_VRInputError_InvalidCompressedData, EVRInputError_VRInputError_NoData, EVRInputError_VRInputError_BufferTooSmall, EVRInputError_VRInputError_MismatchedActionManifest, EVRInputError_VRInputError_MissingSkeletonData, EVRInputError_VRInputError_InvalidBoneIndex
EVRInputError
Enum values:
EVRInputError_VRInputError_None
EVRInputError_VRInputError_NameNotFound
EVRInputError_VRInputError_WrongType
EVRInputError_VRInputError_InvalidHandle
EVRInputError_VRInputError_InvalidParam
EVRInputError_VRInputError_NoSteam
EVRInputError_VRInputError_MaxCapacityReached
EVRInputError_VRInputError_IPCError
EVRInputError_VRInputError_NoActiveActionSet
EVRInputError_VRInputError_InvalidDevice
EVRInputError_VRInputError_InvalidSkeleton
EVRInputError_VRInputError_InvalidBoneCount
EVRInputError_VRInputError_InvalidCompressedData
EVRInputError_VRInputError_NoData
EVRInputError_VRInputError_BufferTooSmall
EVRInputError_VRInputError_MismatchedActionManifest
EVRInputError_VRInputError_MissingSkeletonData
EVRInputError_VRInputError_InvalidBoneIndex
-
EVRSpatialAnchorError_VRSpatialAnchorError_Success, EVRSpatialAnchorError_VRSpatialAnchorError_Internal, EVRSpatialAnchorError_VRSpatialAnchorError_UnknownHandle, EVRSpatialAnchorError_VRSpatialAnchorError_ArrayTooSmall, EVRSpatialAnchorError_VRSpatialAnchorError_InvalidDescriptorChar, EVRSpatialAnchorError_VRSpatialAnchorError_NotYetAvailable, EVRSpatialAnchorError_VRSpatialAnchorError_NotAvailableInThisUniverse, EVRSpatialAnchorError_VRSpatialAnchorError_PermanentlyUnavailable, EVRSpatialAnchorError_VRSpatialAnchorError_WrongDriver, EVRSpatialAnchorError_VRSpatialAnchorError_DescriptorTooLong, EVRSpatialAnchorError_VRSpatialAnchorError_Unknown, EVRSpatialAnchorError_VRSpatialAnchorError_NoRoomCalibration, EVRSpatialAnchorError_VRSpatialAnchorError_InvalidArgument, EVRSpatialAnchorError_VRSpatialAnchorError_UnknownDriver
EVRSpatialAnchorError
Enum values:
EVRSpatialAnchorError_VRSpatialAnchorError_Success
EVRSpatialAnchorError_VRSpatialAnchorError_Internal
EVRSpatialAnchorError_VRSpatialAnchorError_UnknownHandle
EVRSpatialAnchorError_VRSpatialAnchorError_ArrayTooSmall
EVRSpatialAnchorError_VRSpatialAnchorError_InvalidDescriptorChar
EVRSpatialAnchorError_VRSpatialAnchorError_NotYetAvailable
EVRSpatialAnchorError_VRSpatialAnchorError_NotAvailableInThisUniverse
EVRSpatialAnchorError_VRSpatialAnchorError_PermanentlyUnavailable
EVRSpatialAnchorError_VRSpatialAnchorError_WrongDriver
EVRSpatialAnchorError_VRSpatialAnchorError_DescriptorTooLong
EVRSpatialAnchorError_VRSpatialAnchorError_Unknown
EVRSpatialAnchorError_VRSpatialAnchorError_NoRoomCalibration
EVRSpatialAnchorError_VRSpatialAnchorError_InvalidArgument
EVRSpatialAnchorError_VRSpatialAnchorError_UnknownDriver
-
EHiddenAreaMeshType_k_eHiddenAreaMesh_Standard, EHiddenAreaMeshType_k_eHiddenAreaMesh_Inverse, EHiddenAreaMeshType_k_eHiddenAreaMesh_LineLoop, EHiddenAreaMeshType_k_eHiddenAreaMesh_Max
-
EVRControllerAxisType_k_eControllerAxis_None, EVRControllerAxisType_k_eControllerAxis_TrackPad, EVRControllerAxisType_k_eControllerAxis_Joystick, EVRControllerAxisType_k_eControllerAxis_Trigger
EVRControllerAxisType
: Identifies what kind of axis is on the controller at indexn
. Read this type with:pVRSystem->Get(nControllerDeviceIndex, Prop_Axis0Type_Int32+n);
Enum values:
-
EVRControllerEventOutputType_ControllerEventOutput_OSEvents, EVRControllerEventOutputType_ControllerEventOutput_VREvents
EVRControllerEventOutputType
: determines how to provide output to the application of various event processing functions.Enum values:
-
ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_BEGINNER, ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_INTERMEDIATE, ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_SQUARES, ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_ADVANCED, ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_NONE, ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_COUNT
ECollisionBoundsStyle
: Collision Bounds Style.Enum values:
ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_BEGINNER
ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_INTERMEDIATE
ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_SQUARES
ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_ADVANCED
ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_NONE
ECollisionBoundsStyle_COLLISION_BOUNDS_STYLE_COUNT
-
EVROverlayError_VROverlayError_None, EVROverlayError_VROverlayError_UnknownOverlay, EVROverlayError_VROverlayError_InvalidHandle, EVROverlayError_VROverlayError_PermissionDenied, EVROverlayError_VROverlayError_OverlayLimitExceeded, EVROverlayError_VROverlayError_WrongVisibilityType, EVROverlayError_VROverlayError_KeyTooLong, EVROverlayError_VROverlayError_NameTooLong, EVROverlayError_VROverlayError_KeyInUse, EVROverlayError_VROverlayError_WrongTransformType, EVROverlayError_VROverlayError_InvalidTrackedDevice, EVROverlayError_VROverlayError_InvalidParameter, EVROverlayError_VROverlayError_ThumbnailCantBeDestroyed, EVROverlayError_VROverlayError_ArrayTooSmall, EVROverlayError_VROverlayError_RequestFailed, EVROverlayError_VROverlayError_InvalidTexture, EVROverlayError_VROverlayError_UnableToLoadFile, EVROverlayError_VROverlayError_KeyboardAlreadyInUse, EVROverlayError_VROverlayError_NoNeighbor, EVROverlayError_VROverlayError_TooManyMaskPrimitives, EVROverlayError_VROverlayError_BadMaskPrimitive, EVROverlayError_VROverlayError_TextureAlreadyLocked, EVROverlayError_VROverlayError_TextureLockCapacityReached, EVROverlayError_VROverlayError_TextureNotLocked
EVROverlayError
: Errors that can occur around VR overlays.Enum values:
EVROverlayError_VROverlayError_None
EVROverlayError_VROverlayError_UnknownOverlay
EVROverlayError_VROverlayError_InvalidHandle
EVROverlayError_VROverlayError_PermissionDenied
EVROverlayError_VROverlayError_OverlayLimitExceeded
- No more overlays could be created because the maximum number already exist.EVROverlayError_VROverlayError_WrongVisibilityType
EVROverlayError_VROverlayError_KeyTooLong
EVROverlayError_VROverlayError_NameTooLong
EVROverlayError_VROverlayError_KeyInUse
EVROverlayError_VROverlayError_WrongTransformType
EVROverlayError_VROverlayError_InvalidTrackedDevice
EVROverlayError_VROverlayError_InvalidParameter
EVROverlayError_VROverlayError_ThumbnailCantBeDestroyed
EVROverlayError_VROverlayError_ArrayTooSmall
EVROverlayError_VROverlayError_RequestFailed
EVROverlayError_VROverlayError_InvalidTexture
EVROverlayError_VROverlayError_UnableToLoadFile
EVROverlayError_VROverlayError_KeyboardAlreadyInUse
EVROverlayError_VROverlayError_NoNeighbor
EVROverlayError_VROverlayError_TooManyMaskPrimitives
EVROverlayError_VROverlayError_BadMaskPrimitive
EVROverlayError_VROverlayError_TextureAlreadyLocked
EVROverlayError_VROverlayError_TextureLockCapacityReached
EVROverlayError_VROverlayError_TextureNotLocked
-
EVRApplicationType_VRApplication_Other, EVRApplicationType_VRApplication_Scene, EVRApplicationType_VRApplication_Overlay, EVRApplicationType_VRApplication_Background, EVRApplicationType_VRApplication_Utility, EVRApplicationType_VRApplication_VRMonitor, EVRApplicationType_VRApplication_SteamWatchdog, EVRApplicationType_VRApplication_Bootstrapper, EVRApplicationType_VRApplication_WebHelper, EVRApplicationType_VRApplication_Max
EVRApplicationType
: enum values to pass in toInitInternal
to identify whether the application will draw a 3D scene.Enum values:
EVRApplicationType_VRApplication_Other
- Some other kind of application that isn't covered by the other entries.EVRApplicationType_VRApplication_Scene
- Application will submit 3D frames.EVRApplicationType_VRApplication_Overlay
- Application only interacts with overlays.EVRApplicationType_VRApplication_Background
- Application should not start SteamVR if it's not already running, and should not keep it running if everything else quits.EVRApplicationType_VRApplication_Utility
- Init should not try to load any drivers. The application needs access to utility interfaces (likeVRSettings
andVRApplications
) but not hardware.EVRApplicationType_VRApplication_VRMonitor
- Reserved for vrmonitor.EVRApplicationType_VRApplication_SteamWatchdog
- Reserved for Steam.EVRApplicationType_VRApplication_Bootstrapper
- Reserved for vrstartup.EVRApplicationType_VRApplication_WebHelper
- Reserved for vrwebhelper.EVRApplicationType_VRApplication_Max
-
EVRFirmwareError_VRFirmwareError_None, EVRFirmwareError_VRFirmwareError_Success, EVRFirmwareError_VRFirmwareError_Fail
EVRFirmwareError
: error codes for firmware.Enum values:
-
EVRNotificationError_VRNotificationError_OK, EVRNotificationError_VRNotificationError_InvalidNotificationId, EVRNotificationError_VRNotificationError_NotificationQueueFull, EVRNotificationError_VRNotificationError_InvalidOverlayHandle, EVRNotificationError_VRNotificationError_SystemWithUserValueAlreadyExists
EVRNotificationError
: error codes for notifications.Enum values:
EVRNotificationError_VRNotificationError_OK
EVRNotificationError_VRNotificationError_InvalidNotificationId
EVRNotificationError_VRNotificationError_NotificationQueueFull
EVRNotificationError_VRNotificationError_InvalidOverlayHandle
EVRNotificationError_VRNotificationError_SystemWithUserValueAlreadyExists
-
EVRSkeletalMotionRange_VRSkeletalMotionRange_WithController, EVRSkeletalMotionRange_VRSkeletalMotionRange_WithoutController
EVRSkeletalMotionRange
Enum values:
EVRSkeletalMotionRange_VRSkeletalMotionRange_WithController
- The range of motion of the skeleton takes into account any physical limits imposed by the controller itself. This will tend to be the most accurate pose compared to the user's actual hand pose, but might not allow a closed fist for example.EVRSkeletalMotionRange_VRSkeletalMotionRange_WithoutController
- Retarget the range of motion provided by the input device to make the hand appear to move as if it was not holding a controller. eg: map "hand grasping controller" to "closed fist".
-
EVRSkeletalTrackingLevel_VRSkeletalTracking_Estimated, EVRSkeletalTrackingLevel_VRSkeletalTracking_Partial, EVRSkeletalTrackingLevel_VRSkeletalTracking_Full, EVRSkeletalTrackingLevel_VRSkeletalTrackingLevel_Count, EVRSkeletalTrackingLevel_VRSkeletalTrackingLevel_Max
EVRSkeletalTrackingLevel
Enum values:
EVRSkeletalTrackingLevel_VRSkeletalTracking_Estimated
- Body part location can't be directly determined by the device.Any skeletal pose provided by the device is estimated by assuming the position required to active buttons, triggers, joysticks, or other input sensors. E.g. Vive Controller, Gamepad.
EVRSkeletalTrackingLevel_VRSkeletalTracking_Partial
- Body part location can be measured directly but with fewer degrees of freedom than the actual body part.Certain body part positions may be unmeasured by the device and estimated from other input data. E.g. Index Controllers, gloves that only measure finger curl.
EVRSkeletalTrackingLevel_VRSkeletalTracking_Full
- Body part location can be measured directly throughout the entire range of motion of the body part.E.g. Mocap suit for the full body, gloves that measure rotation of each finger segment.
EVRSkeletalTrackingLevel_VRSkeletalTrackingLevel_Count
EVRSkeletalTrackingLevel_VRSkeletalTrackingLevel_Max
-
EVRInitError_VRInitError_None, EVRInitError_VRInitError_Unknown, EVRInitError_VRInitError_Init_InstallationNotFound, EVRInitError_VRInitError_Init_InstallationCorrupt, EVRInitError_VRInitError_Init_VRClientDLLNotFound, EVRInitError_VRInitError_Init_FileNotFound, EVRInitError_VRInitError_Init_FactoryNotFound, EVRInitError_VRInitError_Init_InterfaceNotFound, EVRInitError_VRInitError_Init_InvalidInterface, EVRInitError_VRInitError_Init_UserConfigDirectoryInvalid, EVRInitError_VRInitError_Init_HmdNotFound, EVRInitError_VRInitError_Init_NotInitialized, EVRInitError_VRInitError_Init_PathRegistryNotFound, EVRInitError_VRInitError_Init_NoConfigPath, EVRInitError_VRInitError_Init_NoLogPath, EVRInitError_VRInitError_Init_PathRegistryNotWritable, EVRInitError_VRInitError_Init_AppInfoInitFailed, EVRInitError_VRInitError_Init_Retry, EVRInitError_VRInitError_Init_InitCanceledByUser, EVRInitError_VRInitError_Init_AnotherAppLaunching, EVRInitError_VRInitError_Init_SettingsInitFailed, EVRInitError_VRInitError_Init_ShuttingDown, EVRInitError_VRInitError_Init_TooManyObjects, EVRInitError_VRInitError_Init_NoServerForBackgroundApp, EVRInitError_VRInitError_Init_NotSupportedWithCompositor, EVRInitError_VRInitError_Init_NotAvailableToUtilityApps, EVRInitError_VRInitError_Init_Internal, EVRInitError_VRInitError_Init_HmdDriverIdIsNone, EVRInitError_VRInitError_Init_HmdNotFoundPresenceFailed, EVRInitError_VRInitError_Init_VRMonitorNotFound, EVRInitError_VRInitError_Init_VRMonitorStartupFailed, EVRInitError_VRInitError_Init_LowPowerWatchdogNotSupported, EVRInitError_VRInitError_Init_InvalidApplicationType, EVRInitError_VRInitError_Init_NotAvailableToWatchdogApps, EVRInitError_VRInitError_Init_WatchdogDisabledInSettings, EVRInitError_VRInitError_Init_VRDashboardNotFound, EVRInitError_VRInitError_Init_VRDashboardStartupFailed, EVRInitError_VRInitError_Init_VRHomeNotFound, EVRInitError_VRInitError_Init_VRHomeStartupFailed, EVRInitError_VRInitError_Init_RebootingBusy, EVRInitError_VRInitError_Init_FirmwareUpdateBusy, EVRInitError_VRInitError_Init_FirmwareRecoveryBusy, EVRInitError_VRInitError_Init_USBServiceBusy, EVRInitError_VRInitError_Init_VRWebHelperStartupFailed, EVRInitError_VRInitError_Init_TrackerManagerInitFailed, EVRInitError_VRInitError_Init_AlreadyRunning, EVRInitError_VRInitError_Init_FailedForVrMonitor, EVRInitError_VRInitError_Init_PropertyManagerInitFailed, EVRInitError_VRInitError_Init_WebServerFailed, EVRInitError_VRInitError_Driver_Failed, EVRInitError_VRInitError_Driver_Unknown, EVRInitError_VRInitError_Driver_HmdUnknown, EVRInitError_VRInitError_Driver_NotLoaded, EVRInitError_VRInitError_Driver_RuntimeOutOfDate, EVRInitError_VRInitError_Driver_HmdInUse, EVRInitError_VRInitError_Driver_NotCalibrated, EVRInitError_VRInitError_Driver_CalibrationInvalid, EVRInitError_VRInitError_Driver_HmdDisplayNotFound, EVRInitError_VRInitError_Driver_TrackedDeviceInterfaceUnknown, EVRInitError_VRInitError_Driver_HmdDriverIdOutOfBounds, EVRInitError_VRInitError_Driver_HmdDisplayMirrored, EVRInitError_VRInitError_Driver_HmdDisplayNotFoundLaptop, EVRInitError_VRInitError_IPC_ServerInitFailed, EVRInitError_VRInitError_IPC_ConnectFailed, EVRInitError_VRInitError_IPC_SharedStateInitFailed, EVRInitError_VRInitError_IPC_CompositorInitFailed, EVRInitError_VRInitError_IPC_MutexInitFailed, EVRInitError_VRInitError_IPC_Failed, EVRInitError_VRInitError_IPC_CompositorConnectFailed, EVRInitError_VRInitError_IPC_CompositorInvalidConnectResponse, EVRInitError_VRInitError_IPC_ConnectFailedAfterMultipleAttempts, EVRInitError_VRInitError_IPC_ConnectFailedAfterTargetExited, EVRInitError_VRInitError_IPC_NamespaceUnavailable, EVRInitError_VRInitError_Compositor_Failed, EVRInitError_VRInitError_Compositor_D3D11HardwareRequired, EVRInitError_VRInitError_Compositor_FirmwareRequiresUpdate, EVRInitError_VRInitError_Compositor_OverlayInitFailed, EVRInitError_VRInitError_Compositor_ScreenshotsInitFailed, EVRInitError_VRInitError_Compositor_UnableToCreateDevice, EVRInitError_VRInitError_Compositor_SharedStateIsNull, EVRInitError_VRInitError_Compositor_NotificationManagerIsNull, EVRInitError_VRInitError_Compositor_ResourceManagerClientIsNull, EVRInitError_VRInitError_Compositor_MessageOverlaySharedStateInitFailure, EVRInitError_VRInitError_Compositor_PropertiesInterfaceIsNull, EVRInitError_VRInitError_Compositor_CreateFullscreenWindowFailed, EVRInitError_VRInitError_Compositor_SettingsInterfaceIsNull, EVRInitError_VRInitError_Compositor_FailedToShowWindow, EVRInitError_VRInitError_Compositor_DistortInterfaceIsNull, EVRInitError_VRInitError_Compositor_DisplayFrequencyFailure, EVRInitError_VRInitError_Compositor_RendererInitializationFailed, EVRInitError_VRInitError_Compositor_DXGIFactoryInterfaceIsNull, EVRInitError_VRInitError_Compositor_DXGIFactoryCreateFailed, EVRInitError_VRInitError_Compositor_DXGIFactoryQueryFailed, EVRInitError_VRInitError_Compositor_InvalidAdapterDesktop, EVRInitError_VRInitError_Compositor_InvalidHmdAttachment, EVRInitError_VRInitError_Compositor_InvalidOutputDesktop, EVRInitError_VRInitError_Compositor_InvalidDeviceProvided, EVRInitError_VRInitError_Compositor_D3D11RendererInitializationFailed, EVRInitError_VRInitError_Compositor_FailedToFindDisplayMode, EVRInitError_VRInitError_Compositor_FailedToCreateSwapChain, EVRInitError_VRInitError_Compositor_FailedToGetBackBuffer, EVRInitError_VRInitError_Compositor_FailedToCreateRenderTarget, EVRInitError_VRInitError_Compositor_FailedToCreateDXGI2SwapChain, EVRInitError_VRInitError_Compositor_FailedtoGetDXGI2BackBuffer, EVRInitError_VRInitError_Compositor_FailedToCreateDXGI2RenderTarget, EVRInitError_VRInitError_Compositor_FailedToGetDXGIDeviceInterface, EVRInitError_VRInitError_Compositor_SelectDisplayMode, EVRInitError_VRInitError_Compositor_FailedToCreateNvAPIRenderTargets, EVRInitError_VRInitError_Compositor_NvAPISetDisplayMode, EVRInitError_VRInitError_Compositor_FailedToCreateDirectModeDisplay, EVRInitError_VRInitError_Compositor_InvalidHmdPropertyContainer, EVRInitError_VRInitError_Compositor_UpdateDisplayFrequency, EVRInitError_VRInitError_Compositor_CreateRasterizerState, EVRInitError_VRInitError_Compositor_CreateWireframeRasterizerState, EVRInitError_VRInitError_Compositor_CreateSamplerState, EVRInitError_VRInitError_Compositor_CreateClampToBorderSamplerState, EVRInitError_VRInitError_Compositor_CreateAnisoSamplerState, EVRInitError_VRInitError_Compositor_CreateOverlaySamplerState, EVRInitError_VRInitError_Compositor_CreatePanoramaSamplerState, EVRInitError_VRInitError_Compositor_CreateFontSamplerState, EVRInitError_VRInitError_Compositor_CreateNoBlendState, EVRInitError_VRInitError_Compositor_CreateBlendState, EVRInitError_VRInitError_Compositor_CreateAlphaBlendState, EVRInitError_VRInitError_Compositor_CreateBlendStateMaskR, EVRInitError_VRInitError_Compositor_CreateBlendStateMaskG, EVRInitError_VRInitError_Compositor_CreateBlendStateMaskB, EVRInitError_VRInitError_Compositor_CreateDepthStencilState, EVRInitError_VRInitError_Compositor_CreateDepthStencilStateNoWrite, EVRInitError_VRInitError_Compositor_CreateDepthStencilStateNoDepth, EVRInitError_VRInitError_Compositor_CreateFlushTexture, EVRInitError_VRInitError_Compositor_CreateDistortionSurfaces, EVRInitError_VRInitError_Compositor_CreateConstantBuffer, EVRInitError_VRInitError_Compositor_CreateHmdPoseConstantBuffer, EVRInitError_VRInitError_Compositor_CreateHmdPoseStagingConstantBuffer, EVRInitError_VRInitError_Compositor_CreateSharedFrameInfoConstantBuffer, EVRInitError_VRInitError_Compositor_CreateOverlayConstantBuffer, EVRInitError_VRInitError_Compositor_CreateSceneTextureIndexConstantBuffer, EVRInitError_VRInitError_Compositor_CreateReadableSceneTextureIndexConstantBuffer, EVRInitError_VRInitError_Compositor_CreateLayerGraphicsTextureIndexConstantBuffer, EVRInitError_VRInitError_Compositor_CreateLayerComputeTextureIndexConstantBuffer, EVRInitError_VRInitError_Compositor_CreateLayerComputeSceneTextureIndexConstantBuffer, EVRInitError_VRInitError_Compositor_CreateComputeHmdPoseConstantBuffer, EVRInitError_VRInitError_Compositor_CreateGeomConstantBuffer, EVRInitError_VRInitError_Compositor_CreatePanelMaskConstantBuffer, EVRInitError_VRInitError_Compositor_CreatePixelSimUBO, EVRInitError_VRInitError_Compositor_CreateMSAARenderTextures, EVRInitError_VRInitError_Compositor_CreateResolveRenderTextures, EVRInitError_VRInitError_Compositor_CreateComputeResolveRenderTextures, EVRInitError_VRInitError_Compositor_CreateDriverDirectModeResolveTextures, EVRInitError_VRInitError_Compositor_OpenDriverDirectModeResolveTextures, EVRInitError_VRInitError_Compositor_CreateFallbackSyncTexture, EVRInitError_VRInitError_Compositor_ShareFallbackSyncTexture, EVRInitError_VRInitError_Compositor_CreateOverlayIndexBuffer, EVRInitError_VRInitError_Compositor_CreateOverlayVertextBuffer, EVRInitError_VRInitError_Compositor_CreateTextVertexBuffer, EVRInitError_VRInitError_Compositor_CreateTextIndexBuffer, EVRInitError_VRInitError_Compositor_CreateMirrorTextures, EVRInitError_VRInitError_Compositor_CreateLastFrameRenderTexture, EVRInitError_VRInitError_Compositor_CreateMirrorOverlay, EVRInitError_VRInitError_Compositor_FailedToCreateVirtualDisplayBackbuffer, EVRInitError_VRInitError_Compositor_DisplayModeNotSupported, EVRInitError_VRInitError_VendorSpecific_UnableToConnectToOculusRuntime, EVRInitError_VRInitError_VendorSpecific_WindowsNotInDevMode, EVRInitError_VRInitError_VendorSpecific_HmdFound_CantOpenDevice, EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToRequestConfigStart, EVRInitError_VRInitError_VendorSpecific_HmdFound_NoStoredConfig, EVRInitError_VRInitError_VendorSpecific_HmdFound_ConfigTooBig, EVRInitError_VRInitError_VendorSpecific_HmdFound_ConfigTooSmall, EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToInitZLib, EVRInitError_VRInitError_VendorSpecific_HmdFound_CantReadFirmwareVersion, EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToSendUserDataStart, EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToGetUserDataStart, EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToGetUserDataNext, EVRInitError_VRInitError_VendorSpecific_HmdFound_UserDataAddressRange, EVRInitError_VRInitError_VendorSpecific_HmdFound_UserDataError, EVRInitError_VRInitError_VendorSpecific_HmdFound_ConfigFailedSanityCheck, EVRInitError_VRInitError_VendorSpecific_OculusRuntimeBadInstall, EVRInitError_VRInitError_Steam_SteamInstallationNotFound, EVRInitError_VRInitError_LastError
EVRInitError
: error codes returned byInitInternal
.Enum values:
EVRInitError_VRInitError_None
EVRInitError_VRInitError_Unknown
EVRInitError_VRInitError_Init_InstallationNotFound
EVRInitError_VRInitError_Init_InstallationCorrupt
EVRInitError_VRInitError_Init_VRClientDLLNotFound
EVRInitError_VRInitError_Init_FileNotFound
EVRInitError_VRInitError_Init_FactoryNotFound
EVRInitError_VRInitError_Init_InterfaceNotFound
EVRInitError_VRInitError_Init_InvalidInterface
EVRInitError_VRInitError_Init_UserConfigDirectoryInvalid
EVRInitError_VRInitError_Init_HmdNotFound
EVRInitError_VRInitError_Init_NotInitialized
EVRInitError_VRInitError_Init_PathRegistryNotFound
EVRInitError_VRInitError_Init_NoConfigPath
EVRInitError_VRInitError_Init_NoLogPath
EVRInitError_VRInitError_Init_PathRegistryNotWritable
EVRInitError_VRInitError_Init_AppInfoInitFailed
EVRInitError_VRInitError_Init_Retry
- Used internally to cause retries to vrserver.EVRInitError_VRInitError_Init_InitCanceledByUser
- The calling application should silently exit. The user canceled app startup.EVRInitError_VRInitError_Init_AnotherAppLaunching
EVRInitError_VRInitError_Init_SettingsInitFailed
EVRInitError_VRInitError_Init_ShuttingDown
EVRInitError_VRInitError_Init_TooManyObjects
EVRInitError_VRInitError_Init_NoServerForBackgroundApp
EVRInitError_VRInitError_Init_NotSupportedWithCompositor
EVRInitError_VRInitError_Init_NotAvailableToUtilityApps
EVRInitError_VRInitError_Init_Internal
EVRInitError_VRInitError_Init_HmdDriverIdIsNone
EVRInitError_VRInitError_Init_HmdNotFoundPresenceFailed
EVRInitError_VRInitError_Init_VRMonitorNotFound
EVRInitError_VRInitError_Init_VRMonitorStartupFailed
EVRInitError_VRInitError_Init_LowPowerWatchdogNotSupported
EVRInitError_VRInitError_Init_InvalidApplicationType
EVRInitError_VRInitError_Init_NotAvailableToWatchdogApps
EVRInitError_VRInitError_Init_WatchdogDisabledInSettings
EVRInitError_VRInitError_Init_VRDashboardNotFound
EVRInitError_VRInitError_Init_VRDashboardStartupFailed
EVRInitError_VRInitError_Init_VRHomeNotFound
EVRInitError_VRInitError_Init_VRHomeStartupFailed
EVRInitError_VRInitError_Init_RebootingBusy
EVRInitError_VRInitError_Init_FirmwareUpdateBusy
EVRInitError_VRInitError_Init_FirmwareRecoveryBusy
EVRInitError_VRInitError_Init_USBServiceBusy
EVRInitError_VRInitError_Init_VRWebHelperStartupFailed
EVRInitError_VRInitError_Init_TrackerManagerInitFailed
EVRInitError_VRInitError_Init_AlreadyRunning
EVRInitError_VRInitError_Init_FailedForVrMonitor
EVRInitError_VRInitError_Init_PropertyManagerInitFailed
EVRInitError_VRInitError_Init_WebServerFailed
EVRInitError_VRInitError_Driver_Failed
EVRInitError_VRInitError_Driver_Unknown
EVRInitError_VRInitError_Driver_HmdUnknown
EVRInitError_VRInitError_Driver_NotLoaded
EVRInitError_VRInitError_Driver_RuntimeOutOfDate
EVRInitError_VRInitError_Driver_HmdInUse
EVRInitError_VRInitError_Driver_NotCalibrated
EVRInitError_VRInitError_Driver_CalibrationInvalid
EVRInitError_VRInitError_Driver_HmdDisplayNotFound
EVRInitError_VRInitError_Driver_TrackedDeviceInterfaceUnknown
EVRInitError_VRInitError_Driver_HmdDriverIdOutOfBounds
EVRInitError_VRInitError_Driver_HmdDisplayMirrored
EVRInitError_VRInitError_Driver_HmdDisplayNotFoundLaptop
EVRInitError_VRInitError_IPC_ServerInitFailed
EVRInitError_VRInitError_IPC_ConnectFailed
EVRInitError_VRInitError_IPC_SharedStateInitFailed
EVRInitError_VRInitError_IPC_CompositorInitFailed
EVRInitError_VRInitError_IPC_MutexInitFailed
EVRInitError_VRInitError_IPC_Failed
EVRInitError_VRInitError_IPC_CompositorConnectFailed
EVRInitError_VRInitError_IPC_CompositorInvalidConnectResponse
EVRInitError_VRInitError_IPC_ConnectFailedAfterMultipleAttempts
EVRInitError_VRInitError_IPC_ConnectFailedAfterTargetExited
EVRInitError_VRInitError_IPC_NamespaceUnavailable
EVRInitError_VRInitError_Compositor_Failed
EVRInitError_VRInitError_Compositor_D3D11HardwareRequired
EVRInitError_VRInitError_Compositor_FirmwareRequiresUpdate
EVRInitError_VRInitError_Compositor_OverlayInitFailed
EVRInitError_VRInitError_Compositor_ScreenshotsInitFailed
EVRInitError_VRInitError_Compositor_UnableToCreateDevice
EVRInitError_VRInitError_Compositor_SharedStateIsNull
EVRInitError_VRInitError_Compositor_NotificationManagerIsNull
EVRInitError_VRInitError_Compositor_ResourceManagerClientIsNull
EVRInitError_VRInitError_Compositor_MessageOverlaySharedStateInitFailure
EVRInitError_VRInitError_Compositor_PropertiesInterfaceIsNull
EVRInitError_VRInitError_Compositor_CreateFullscreenWindowFailed
EVRInitError_VRInitError_Compositor_SettingsInterfaceIsNull
EVRInitError_VRInitError_Compositor_FailedToShowWindow
EVRInitError_VRInitError_Compositor_DistortInterfaceIsNull
EVRInitError_VRInitError_Compositor_DisplayFrequencyFailure
EVRInitError_VRInitError_Compositor_RendererInitializationFailed
EVRInitError_VRInitError_Compositor_DXGIFactoryInterfaceIsNull
EVRInitError_VRInitError_Compositor_DXGIFactoryCreateFailed
EVRInitError_VRInitError_Compositor_DXGIFactoryQueryFailed
EVRInitError_VRInitError_Compositor_InvalidAdapterDesktop
EVRInitError_VRInitError_Compositor_InvalidHmdAttachment
EVRInitError_VRInitError_Compositor_InvalidOutputDesktop
EVRInitError_VRInitError_Compositor_InvalidDeviceProvided
EVRInitError_VRInitError_Compositor_D3D11RendererInitializationFailed
EVRInitError_VRInitError_Compositor_FailedToFindDisplayMode
EVRInitError_VRInitError_Compositor_FailedToCreateSwapChain
EVRInitError_VRInitError_Compositor_FailedToGetBackBuffer
EVRInitError_VRInitError_Compositor_FailedToCreateRenderTarget
EVRInitError_VRInitError_Compositor_FailedToCreateDXGI2SwapChain
EVRInitError_VRInitError_Compositor_FailedtoGetDXGI2BackBuffer
EVRInitError_VRInitError_Compositor_FailedToCreateDXGI2RenderTarget
EVRInitError_VRInitError_Compositor_FailedToGetDXGIDeviceInterface
EVRInitError_VRInitError_Compositor_SelectDisplayMode
EVRInitError_VRInitError_Compositor_FailedToCreateNvAPIRenderTargets
EVRInitError_VRInitError_Compositor_NvAPISetDisplayMode
EVRInitError_VRInitError_Compositor_FailedToCreateDirectModeDisplay
EVRInitError_VRInitError_Compositor_InvalidHmdPropertyContainer
EVRInitError_VRInitError_Compositor_UpdateDisplayFrequency
EVRInitError_VRInitError_Compositor_CreateRasterizerState
EVRInitError_VRInitError_Compositor_CreateWireframeRasterizerState
EVRInitError_VRInitError_Compositor_CreateSamplerState
EVRInitError_VRInitError_Compositor_CreateClampToBorderSamplerState
EVRInitError_VRInitError_Compositor_CreateAnisoSamplerState
EVRInitError_VRInitError_Compositor_CreateOverlaySamplerState
EVRInitError_VRInitError_Compositor_CreatePanoramaSamplerState
EVRInitError_VRInitError_Compositor_CreateFontSamplerState
EVRInitError_VRInitError_Compositor_CreateNoBlendState
EVRInitError_VRInitError_Compositor_CreateBlendState
EVRInitError_VRInitError_Compositor_CreateAlphaBlendState
EVRInitError_VRInitError_Compositor_CreateBlendStateMaskR
EVRInitError_VRInitError_Compositor_CreateBlendStateMaskG
EVRInitError_VRInitError_Compositor_CreateBlendStateMaskB
EVRInitError_VRInitError_Compositor_CreateDepthStencilState
EVRInitError_VRInitError_Compositor_CreateDepthStencilStateNoWrite
EVRInitError_VRInitError_Compositor_CreateDepthStencilStateNoDepth
EVRInitError_VRInitError_Compositor_CreateFlushTexture
EVRInitError_VRInitError_Compositor_CreateDistortionSurfaces
EVRInitError_VRInitError_Compositor_CreateConstantBuffer
EVRInitError_VRInitError_Compositor_CreateHmdPoseConstantBuffer
EVRInitError_VRInitError_Compositor_CreateHmdPoseStagingConstantBuffer
EVRInitError_VRInitError_Compositor_CreateSharedFrameInfoConstantBuffer
EVRInitError_VRInitError_Compositor_CreateOverlayConstantBuffer
EVRInitError_VRInitError_Compositor_CreateSceneTextureIndexConstantBuffer
EVRInitError_VRInitError_Compositor_CreateReadableSceneTextureIndexConstantBuffer
EVRInitError_VRInitError_Compositor_CreateLayerGraphicsTextureIndexConstantBuffer
EVRInitError_VRInitError_Compositor_CreateLayerComputeTextureIndexConstantBuffer
EVRInitError_VRInitError_Compositor_CreateLayerComputeSceneTextureIndexConstantBuffer
EVRInitError_VRInitError_Compositor_CreateComputeHmdPoseConstantBuffer
EVRInitError_VRInitError_Compositor_CreateGeomConstantBuffer
EVRInitError_VRInitError_Compositor_CreatePanelMaskConstantBuffer
EVRInitError_VRInitError_Compositor_CreatePixelSimUBO
EVRInitError_VRInitError_Compositor_CreateMSAARenderTextures
EVRInitError_VRInitError_Compositor_CreateResolveRenderTextures
EVRInitError_VRInitError_Compositor_CreateComputeResolveRenderTextures
EVRInitError_VRInitError_Compositor_CreateDriverDirectModeResolveTextures
EVRInitError_VRInitError_Compositor_OpenDriverDirectModeResolveTextures
EVRInitError_VRInitError_Compositor_CreateFallbackSyncTexture
EVRInitError_VRInitError_Compositor_ShareFallbackSyncTexture
EVRInitError_VRInitError_Compositor_CreateOverlayIndexBuffer
EVRInitError_VRInitError_Compositor_CreateOverlayVertextBuffer
EVRInitError_VRInitError_Compositor_CreateTextVertexBuffer
EVRInitError_VRInitError_Compositor_CreateTextIndexBuffer
EVRInitError_VRInitError_Compositor_CreateMirrorTextures
EVRInitError_VRInitError_Compositor_CreateLastFrameRenderTexture
EVRInitError_VRInitError_Compositor_CreateMirrorOverlay
EVRInitError_VRInitError_Compositor_FailedToCreateVirtualDisplayBackbuffer
EVRInitError_VRInitError_Compositor_DisplayModeNotSupported
EVRInitError_VRInitError_VendorSpecific_UnableToConnectToOculusRuntime
EVRInitError_VRInitError_VendorSpecific_WindowsNotInDevMode
EVRInitError_VRInitError_VendorSpecific_HmdFound_CantOpenDevice
EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToRequestConfigStart
EVRInitError_VRInitError_VendorSpecific_HmdFound_NoStoredConfig
EVRInitError_VRInitError_VendorSpecific_HmdFound_ConfigTooBig
EVRInitError_VRInitError_VendorSpecific_HmdFound_ConfigTooSmall
EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToInitZLib
EVRInitError_VRInitError_VendorSpecific_HmdFound_CantReadFirmwareVersion
EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToSendUserDataStart
EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToGetUserDataStart
EVRInitError_VRInitError_VendorSpecific_HmdFound_UnableToGetUserDataNext
EVRInitError_VRInitError_VendorSpecific_HmdFound_UserDataAddressRange
EVRInitError_VRInitError_VendorSpecific_HmdFound_UserDataError
EVRInitError_VRInitError_VendorSpecific_HmdFound_ConfigFailedSanityCheck
EVRInitError_VRInitError_VendorSpecific_OculusRuntimeBadInstall
EVRInitError_VRInitError_Steam_SteamInstallationNotFound
EVRInitError_VRInitError_LastError
-
EVRScreenshotType_VRScreenshotType_None, EVRScreenshotType_VRScreenshotType_Mono, EVRScreenshotType_VRScreenshotType_Stereo, EVRScreenshotType_VRScreenshotType_Cubemap, EVRScreenshotType_VRScreenshotType_MonoPanorama, EVRScreenshotType_VRScreenshotType_StereoPanorama
EVRScreenshotType
Enum values:
EVRScreenshotType_VRScreenshotType_None
EVRScreenshotType_VRScreenshotType_Mono
- the VR filename is ignored (can be nullptr), this is a normal flat single shot.EVRScreenshotType_VRScreenshotType_Stereo
- The VR image should be a side-by-side with the left eye image on the left.EVRScreenshotType_VRScreenshotType_Cubemap
- The VR image should be six square images composited horizontally.EVRScreenshotType_VRScreenshotType_MonoPanorama
EVRScreenshotType_VRScreenshotType_StereoPanorama
- above/below with left eye panorama being the above image. Image is typically square with the panorama being 2x horizontal.
-
EVRScreenshotPropertyFilenames_VRScreenshotPropertyFilenames_Preview, EVRScreenshotPropertyFilenames_VRScreenshotPropertyFilenames_VR
EVRScreenshotPropertyFilenames
Enum values:
-
EVRTrackedCameraError_VRTrackedCameraError_None, EVRTrackedCameraError_VRTrackedCameraError_OperationFailed, EVRTrackedCameraError_VRTrackedCameraError_InvalidHandle, EVRTrackedCameraError_VRTrackedCameraError_InvalidFrameHeaderVersion, EVRTrackedCameraError_VRTrackedCameraError_OutOfHandles, EVRTrackedCameraError_VRTrackedCameraError_IPCFailure, EVRTrackedCameraError_VRTrackedCameraError_NotSupportedForThisDevice, EVRTrackedCameraError_VRTrackedCameraError_SharedMemoryFailure, EVRTrackedCameraError_VRTrackedCameraError_FrameBufferingFailure, EVRTrackedCameraError_VRTrackedCameraError_StreamSetupFailure, EVRTrackedCameraError_VRTrackedCameraError_InvalidGLTextureId, EVRTrackedCameraError_VRTrackedCameraError_InvalidSharedTextureHandle, EVRTrackedCameraError_VRTrackedCameraError_FailedToGetGLTextureId, EVRTrackedCameraError_VRTrackedCameraError_SharedTextureFailure, EVRTrackedCameraError_VRTrackedCameraError_NoFrameAvailable, EVRTrackedCameraError_VRTrackedCameraError_InvalidArgument, EVRTrackedCameraError_VRTrackedCameraError_InvalidFrameBufferSize
EVRTrackedCameraError
Enum values:
EVRTrackedCameraError_VRTrackedCameraError_None
EVRTrackedCameraError_VRTrackedCameraError_OperationFailed
EVRTrackedCameraError_VRTrackedCameraError_InvalidHandle
EVRTrackedCameraError_VRTrackedCameraError_InvalidFrameHeaderVersion
EVRTrackedCameraError_VRTrackedCameraError_OutOfHandles
EVRTrackedCameraError_VRTrackedCameraError_IPCFailure
EVRTrackedCameraError_VRTrackedCameraError_NotSupportedForThisDevice
EVRTrackedCameraError_VRTrackedCameraError_SharedMemoryFailure
EVRTrackedCameraError_VRTrackedCameraError_FrameBufferingFailure
EVRTrackedCameraError_VRTrackedCameraError_StreamSetupFailure
EVRTrackedCameraError_VRTrackedCameraError_InvalidGLTextureId
EVRTrackedCameraError_VRTrackedCameraError_InvalidSharedTextureHandle
EVRTrackedCameraError_VRTrackedCameraError_FailedToGetGLTextureId
EVRTrackedCameraError_VRTrackedCameraError_SharedTextureFailure
EVRTrackedCameraError_VRTrackedCameraError_NoFrameAvailable
EVRTrackedCameraError_VRTrackedCameraError_InvalidArgument
EVRTrackedCameraError_VRTrackedCameraError_InvalidFrameBufferSize
-
EVRTrackedCameraFrameLayout_Mono, EVRTrackedCameraFrameLayout_Stereo, EVRTrackedCameraFrameLayout_VerticalLayout, EVRTrackedCameraFrameLayout_HorizontalLayout
EVRTrackedCameraFrameLayout
Enum values:
EVRTrackedCameraFrameLayout_Mono
EVRTrackedCameraFrameLayout_Stereo
EVRTrackedCameraFrameLayout_VerticalLayout
- Stereo frames are Top/Bottom (left/right)EVRTrackedCameraFrameLayout_HorizontalLayout
- Stereo frames are Left/Right
-
EVRTrackedCameraFrameType_VRTrackedCameraFrameType_Distorted, EVRTrackedCameraFrameType_VRTrackedCameraFrameType_Undistorted, EVRTrackedCameraFrameType_VRTrackedCameraFrameType_MaximumUndistorted, EVRTrackedCameraFrameType_MAX_CAMERA_FRAME_TYPES
EVRTrackedCameraFrameType
Enum values:
EVRTrackedCameraFrameType_VRTrackedCameraFrameType_Distorted
- This is the camera video frame size in pixels, still distorted.EVRTrackedCameraFrameType_VRTrackedCameraFrameType_Undistorted
- In pixels, an undistorted inscribed rectangle region without invalid regions. This size is subject to changes shortly.EVRTrackedCameraFrameType_VRTrackedCameraFrameType_MaximumUndistorted
- In pixels, maximum undistorted with invalid regions. Non zero alpha component identifies valid regions.EVRTrackedCameraFrameType_MAX_CAMERA_FRAME_TYPES
-
EVRDistortionFunctionType_VRDistortionFunctionType_None, EVRDistortionFunctionType_VRDistortionFunctionType_FTheta, EVRDistortionFunctionType_VRDistortionFunctionType_Extended_FTheta, EVRDistortionFunctionType_MAX_DISTORTION_FUNCTION_TYPES
-
EVSync_VSync_None, EVSync_VSync_WaitRender, EVSync_VSync_NoWaitRender
EVSync
Enum values:
EVSync_VSync_None
EVSync_VSync_WaitRender
- block following render work until vsyncEVSync_VSync_NoWaitRender
- do not block following render work (allow to get started early)
-
Imu_OffScaleFlags_OffScale_AccelX, Imu_OffScaleFlags_OffScale_AccelY, Imu_OffScaleFlags_OffScale_AccelZ, Imu_OffScaleFlags_OffScale_GyroX, Imu_OffScaleFlags_OffScale_GyroY, Imu_OffScaleFlags_OffScale_GyroZ
Imu_OffScaleFlags
: raw IMU data provided byIVRIOBuffer
from paths to tracked devices with IMUs.Enum values:
-
EVRApplicationError_VRApplicationError_None, EVRApplicationError_VRApplicationError_AppKeyAlreadyExists, EVRApplicationError_VRApplicationError_NoManifest, EVRApplicationError_VRApplicationError_NoApplication, EVRApplicationError_VRApplicationError_InvalidIndex, EVRApplicationError_VRApplicationError_UnknownApplication, EVRApplicationError_VRApplicationError_IPCFailed, EVRApplicationError_VRApplicationError_ApplicationAlreadyRunning, EVRApplicationError_VRApplicationError_InvalidManifest, EVRApplicationError_VRApplicationError_InvalidApplication, EVRApplicationError_VRApplicationError_LaunchFailed, EVRApplicationError_VRApplicationError_ApplicationAlreadyStarting, EVRApplicationError_VRApplicationError_LaunchInProgress, EVRApplicationError_VRApplicationError_OldApplicationQuitting, EVRApplicationError_VRApplicationError_TransitionAborted, EVRApplicationError_VRApplicationError_IsTemplate, EVRApplicationError_VRApplicationError_SteamVRIsExiting, EVRApplicationError_VRApplicationError_BufferTooSmall, EVRApplicationError_VRApplicationError_PropertyNotSet, EVRApplicationError_VRApplicationError_UnknownProperty, EVRApplicationError_VRApplicationError_InvalidParameter
EVRApplicationError
: Used for all errors reported by theVRApplications
interface.Enum values:
EVRApplicationError_VRApplicationError_None
EVRApplicationError_VRApplicationError_AppKeyAlreadyExists
- Only one application can use any given key.EVRApplicationError_VRApplicationError_NoManifest
- the running application does not have a manifest.EVRApplicationError_VRApplicationError_NoApplication
- No application is running.EVRApplicationError_VRApplicationError_InvalidIndex
EVRApplicationError_VRApplicationError_UnknownApplication
- the application could not be found.EVRApplicationError_VRApplicationError_IPCFailed
- An IPC failure caused the request to fail.EVRApplicationError_VRApplicationError_ApplicationAlreadyRunning
EVRApplicationError_VRApplicationError_InvalidManifest
EVRApplicationError_VRApplicationError_InvalidApplication
EVRApplicationError_VRApplicationError_LaunchFailed
- the process didn't start.EVRApplicationError_VRApplicationError_ApplicationAlreadyStarting
- the system was already starting the same application.EVRApplicationError_VRApplicationError_LaunchInProgress
- The system was already starting a different application.EVRApplicationError_VRApplicationError_OldApplicationQuitting
EVRApplicationError_VRApplicationError_TransitionAborted
EVRApplicationError_VRApplicationError_IsTemplate
- error when you try to callLaunchApplication()
on a template type app (useLaunchTemplateApplication
).EVRApplicationError_VRApplicationError_SteamVRIsExiting
EVRApplicationError_VRApplicationError_BufferTooSmall
- The provided buffer was too small to fit the requested data.EVRApplicationError_VRApplicationError_PropertyNotSet
- The requested property was not set.EVRApplicationError_VRApplicationError_UnknownProperty
EVRApplicationError_VRApplicationError_InvalidParameter
-
EVRApplicationProperty_VRApplicationProperty_Name_String, EVRApplicationProperty_VRApplicationProperty_LaunchType_String, EVRApplicationProperty_VRApplicationProperty_WorkingDirectory_String, EVRApplicationProperty_VRApplicationProperty_BinaryPath_String, EVRApplicationProperty_VRApplicationProperty_Arguments_String, EVRApplicationProperty_VRApplicationProperty_URL_String, EVRApplicationProperty_VRApplicationProperty_Description_String, EVRApplicationProperty_VRApplicationProperty_NewsURL_String, EVRApplicationProperty_VRApplicationProperty_ImagePath_String, EVRApplicationProperty_VRApplicationProperty_Source_String, EVRApplicationProperty_VRApplicationProperty_ActionManifestURL_String, EVRApplicationProperty_VRApplicationProperty_IsDashboardOverlay_Bool, EVRApplicationProperty_VRApplicationProperty_IsTemplate_Bool, EVRApplicationProperty_VRApplicationProperty_IsInstanced_Bool, EVRApplicationProperty_VRApplicationProperty_IsInternal_Bool, EVRApplicationProperty_VRApplicationProperty_WantsCompositorPauseInStandby_Bool, EVRApplicationProperty_VRApplicationProperty_IsHidden_Bool, EVRApplicationProperty_VRApplicationProperty_LastLaunchTime_Uint64
EVRApplicationProperty
: these are the properties available on applications.Enum values:
EVRApplicationProperty_VRApplicationProperty_Name_String
EVRApplicationProperty_VRApplicationProperty_LaunchType_String
EVRApplicationProperty_VRApplicationProperty_WorkingDirectory_String
EVRApplicationProperty_VRApplicationProperty_BinaryPath_String
EVRApplicationProperty_VRApplicationProperty_Arguments_String
EVRApplicationProperty_VRApplicationProperty_URL_String
EVRApplicationProperty_VRApplicationProperty_Description_String
EVRApplicationProperty_VRApplicationProperty_NewsURL_String
EVRApplicationProperty_VRApplicationProperty_ImagePath_String
EVRApplicationProperty_VRApplicationProperty_Source_String
EVRApplicationProperty_VRApplicationProperty_ActionManifestURL_String
EVRApplicationProperty_VRApplicationProperty_IsDashboardOverlay_Bool
EVRApplicationProperty_VRApplicationProperty_IsTemplate_Bool
EVRApplicationProperty_VRApplicationProperty_IsInstanced_Bool
EVRApplicationProperty_VRApplicationProperty_IsInternal_Bool
EVRApplicationProperty_VRApplicationProperty_WantsCompositorPauseInStandby_Bool
EVRApplicationProperty_VRApplicationProperty_IsHidden_Bool
EVRApplicationProperty_VRApplicationProperty_LastLaunchTime_Uint64
-
EVRSceneApplicationState_None, EVRSceneApplicationState_Starting, EVRSceneApplicationState_Quitting, EVRSceneApplicationState_Running, EVRSceneApplicationState_Waiting
EVRSceneApplicationState
Enum values:
EVRSceneApplicationState_None
- Scene Application is not running.EVRSceneApplicationState_Starting
- Scene Application is starting.EVRSceneApplicationState_Quitting
- Scene Application is quitting.EVRSceneApplicationState_Running
- Scene Application is running, and submitting frames, a custom skybox, or a visible overlay.EVRSceneApplicationState_Waiting
- Scene Application is running, but not drawing anything.
-
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
ChaperoneCalibrationState
Enum values:
ChaperoneCalibrationState_OK
- Chaperone is fully calibrated and working correctly.ChaperoneCalibrationState_Warning
ChaperoneCalibrationState_Warning_BaseStationMayHaveMoved
- A base station thinks that it might have moved.ChaperoneCalibrationState_Warning_BaseStationRemoved
- There are less base stations than when calibrated.ChaperoneCalibrationState_Warning_SeatedBoundsInvalid
- Seated bounds haven't been calibrated for the current tracking center.ChaperoneCalibrationState_Error
- The UniverseID is invalid.ChaperoneCalibrationState_Error_BaseStationUninitialized
- Tracking center hasn't be calibrated for at least one of the base stations.ChaperoneCalibrationState_Error_BaseStationConflict
- Tracking center is calibrated, but base stations disagree on the tracking space.ChaperoneCalibrationState_Error_PlayAreaInvalid
- Play Area hasn't been calibrated for the current tracking center.ChaperoneCalibrationState_Error_CollisionBoundsInvalid
- Collision Bounds haven't been calibrated for the current tracking center.
-
EChaperoneConfigFile_Live, EChaperoneConfigFile_Temp
EChaperoneConfigFile
Enum values:
EChaperoneConfigFile_Live
- The live chaperone config, used by most applications and games.EChaperoneConfigFile_Temp
- The temporary chaperone config, used to live-preview collision bounds in room setup.
-
EChaperoneImportFlags_EChaperoneImport_BoundsOnly
EChaperoneImportFlags
-
EVRCompositorError_VRCompositorError_None, EVRCompositorError_VRCompositorError_RequestFailed, EVRCompositorError_VRCompositorError_IncompatibleVersion, EVRCompositorError_VRCompositorError_DoNotHaveFocus, EVRCompositorError_VRCompositorError_InvalidTexture, EVRCompositorError_VRCompositorError_IsNotSceneApplication, EVRCompositorError_VRCompositorError_TextureIsOnWrongDevice, EVRCompositorError_VRCompositorError_TextureUsesUnsupportedFormat, EVRCompositorError_VRCompositorError_SharedTexturesNotSupported, EVRCompositorError_VRCompositorError_IndexOutOfRange, EVRCompositorError_VRCompositorError_AlreadySubmitted, EVRCompositorError_VRCompositorError_InvalidBounds, EVRCompositorError_VRCompositorError_AlreadySet
EVRCompositorError
: Errors that can occur with the VR compositor.Enum values:
EVRCompositorError_VRCompositorError_None
EVRCompositorError_VRCompositorError_RequestFailed
EVRCompositorError_VRCompositorError_IncompatibleVersion
EVRCompositorError_VRCompositorError_DoNotHaveFocus
EVRCompositorError_VRCompositorError_InvalidTexture
EVRCompositorError_VRCompositorError_IsNotSceneApplication
EVRCompositorError_VRCompositorError_TextureIsOnWrongDevice
EVRCompositorError_VRCompositorError_TextureUsesUnsupportedFormat
EVRCompositorError_VRCompositorError_SharedTexturesNotSupported
EVRCompositorError_VRCompositorError_IndexOutOfRange
EVRCompositorError_VRCompositorError_AlreadySubmitted
EVRCompositorError_VRCompositorError_InvalidBounds
EVRCompositorError_VRCompositorError_AlreadySet
-
EVRCompositorTimingMode_VRCompositorTimingMode_Implicit, EVRCompositorTimingMode_VRCompositorTimingMode_Explicit_RuntimePerformsPostPresentHandoff, EVRCompositorTimingMode_VRCompositorTimingMode_Explicit_ApplicationPerformsPostPresentHandoff
-
VROverlayInputMethod_None, VROverlayInputMethod_Mouse, VROverlayInputMethod_DualAnalog
VROverlayInputMethod
: Types of input supported by VR Overlays.Enum values:
VROverlayInputMethod_None
- No input events will be generated automatically for this overlay.VROverlayInputMethod_Mouse
- Tracked controllers will get mouse events automatically.VROverlayInputMethod_DualAnalog
- Analog inputs from tracked controllers are turned into DualAnalog events.
-
VROverlayTransformType_VROverlayTransform_Invalid, VROverlayTransformType_VROverlayTransform_Absolute, VROverlayTransformType_VROverlayTransform_TrackedDeviceRelative, VROverlayTransformType_VROverlayTransform_SystemOverlay, VROverlayTransformType_VROverlayTransform_TrackedComponent, VROverlayTransformType_VROverlayTransform_Cursor, VROverlayTransformType_VROverlayTransform_DashboardTab, VROverlayTransformType_VROverlayTransform_DashboardThumb
VROverlayTransformType
: Allows the caller to figure out which overlay transform getter to call.Enum values:
VROverlayTransformType_VROverlayTransform_Invalid
VROverlayTransformType_VROverlayTransform_Absolute
VROverlayTransformType_VROverlayTransform_TrackedDeviceRelative
VROverlayTransformType_VROverlayTransform_SystemOverlay
VROverlayTransformType_VROverlayTransform_TrackedComponent
VROverlayTransformType_VROverlayTransform_Cursor
VROverlayTransformType_VROverlayTransform_DashboardTab
VROverlayTransformType_VROverlayTransform_DashboardThumb
-
VROverlayFlags_NoDashboardTab, VROverlayFlags_SendVRDiscreteScrollEvents, VROverlayFlags_SendVRTouchpadEvents, VROverlayFlags_ShowTouchPadScrollWheel, VROverlayFlags_TransferOwnershipToInternalProcess, VROverlayFlags_SideBySide_Parallel, VROverlayFlags_SideBySide_Crossed, VROverlayFlags_Panorama, VROverlayFlags_StereoPanorama, VROverlayFlags_SortWithNonSceneOverlays, VROverlayFlags_VisibleInDashboard, VROverlayFlags_MakeOverlaysInteractiveIfVisible, VROverlayFlags_SendVRSmoothScrollEvents, VROverlayFlags_ProtectedContent, VROverlayFlags_HideLaserIntersection
VROverlayFlags
: Overlay control settings.Enum values:
VROverlayFlags_NoDashboardTab
- Set this flag on a dashboard overlay to prevent a tab from showing up for that overlay.VROverlayFlags_SendVRDiscreteScrollEvents
- When this is set the overlay will receiveVREvent_ScrollDiscrete
events like a mouse wheel. Requires mouse input mode.VROverlayFlags_SendVRTouchpadEvents
- Indicates that the overlay would like to receive.VROverlayFlags_ShowTouchPadScrollWheel
- If set this will render a vertical scroll wheel on the primary controller, only needed if not using VROverlayFlags_SendVRScrollEvents but you still want to represent a scroll wheel.VROverlayFlags_TransferOwnershipToInternalProcess
- If this is set ownership and render access to the overlay are transferred to the new scene process on a call toLaunchInternalProcess
.VROverlayFlags_SideBySide_Parallel
- If set, renders 50% of the texture in each eye, side by side. Texture is left/right.VROverlayFlags_SideBySide_Crossed
- If set, renders 50% of the texture in each eye, side by side. Texture is crossed and right/left.VROverlayFlags_Panorama
- Texture is a panorama.VROverlayFlags_StereoPanorama
- Texture is a stereo panorama.VROverlayFlags_SortWithNonSceneOverlays
- If this is set on an overlay owned by the scene application that overlay will be sorted with the "Other" overlays on top of all other scene overlays.VROverlayFlags_VisibleInDashboard
- If set, the overlay will be shown in the dashboard, otherwise it will be hidden.VROverlayFlags_MakeOverlaysInteractiveIfVisible
- If this is set and the overlay's input method is not none, the system-wide laser mouse mode will be activated whenever this overlay is visible.VROverlayFlags_SendVRSmoothScrollEvents
- If this is set the overlay will receive smoothVREvent_ScrollSmooth
that emulate trackpad scrolling. Requires mouse input mode.VROverlayFlags_ProtectedContent
- If this is set, the overlay texture will be protected content, preventing unauthorized reads.VROverlayFlags_HideLaserIntersection
- If this is set, the laser mouse splat will not be drawn over this overlay. The overlay will be responsible for drawing its own "cursor".
-
VRMessageOverlayResponse_ButtonPress_0, VRMessageOverlayResponse_ButtonPress_1, VRMessageOverlayResponse_ButtonPress_2, VRMessageOverlayResponse_ButtonPress_3, VRMessageOverlayResponse_CouldntFindSystemOverlay, VRMessageOverlayResponse_CouldntFindOrCreateClientOverlay, VRMessageOverlayResponse_ApplicationQuit
VRMessageOverlayResponse
Enum values:
VRMessageOverlayResponse_ButtonPress_0
VRMessageOverlayResponse_ButtonPress_1
VRMessageOverlayResponse_ButtonPress_2
VRMessageOverlayResponse_ButtonPress_3
VRMessageOverlayResponse_CouldntFindSystemOverlay
VRMessageOverlayResponse_CouldntFindOrCreateClientOverlay
VRMessageOverlayResponse_ApplicationQuit
-
EGamepadTextInputMode_k_EGamepadTextInputModeNormal, EGamepadTextInputMode_k_EGamepadTextInputModePassword, EGamepadTextInputMode_k_EGamepadTextInputModeSubmit
EGamepadTextInputMode
: Input modes for the Big Picture gamepad text entry.Enum values:
-
EGamepadTextInputLineMode_k_EGamepadTextInputLineModeSingleLine, EGamepadTextInputLineMode_k_EGamepadTextInputLineModeMultipleLines
EGamepadTextInputLineMode
: Controls number of allowed lines for the Big Picture gamepad text entry.Enum values:
-
EVROverlayIntersectionMaskPrimitiveType_OverlayIntersectionPrimitiveType_Rectangle, EVROverlayIntersectionMaskPrimitiveType_OverlayIntersectionPrimitiveType_Circle
EVROverlayIntersectionMaskPrimitiveType
Enum values:
-
EVRRenderModelError_VRRenderModelError_None, EVRRenderModelError_VRRenderModelError_Loading, EVRRenderModelError_VRRenderModelError_NotSupported, EVRRenderModelError_VRRenderModelError_InvalidArg, EVRRenderModelError_VRRenderModelError_InvalidModel, EVRRenderModelError_VRRenderModelError_NoShapes, EVRRenderModelError_VRRenderModelError_MultipleShapes, EVRRenderModelError_VRRenderModelError_TooManyVertices, EVRRenderModelError_VRRenderModelError_MultipleTextures, EVRRenderModelError_VRRenderModelError_BufferTooSmall, EVRRenderModelError_VRRenderModelError_NotEnoughNormals, EVRRenderModelError_VRRenderModelError_NotEnoughTexCoords, EVRRenderModelError_VRRenderModelError_InvalidTexture
EVRRenderModelError
: Errors that can occur with the VR compositor.Enum values:
EVRRenderModelError_VRRenderModelError_None
EVRRenderModelError_VRRenderModelError_Loading
EVRRenderModelError_VRRenderModelError_NotSupported
EVRRenderModelError_VRRenderModelError_InvalidArg
EVRRenderModelError_VRRenderModelError_InvalidModel
EVRRenderModelError_VRRenderModelError_NoShapes
EVRRenderModelError_VRRenderModelError_MultipleShapes
EVRRenderModelError_VRRenderModelError_TooManyVertices
EVRRenderModelError_VRRenderModelError_MultipleTextures
EVRRenderModelError_VRRenderModelError_BufferTooSmall
EVRRenderModelError_VRRenderModelError_NotEnoughNormals
EVRRenderModelError_VRRenderModelError_NotEnoughTexCoords
EVRRenderModelError_VRRenderModelError_InvalidTexture
-
EVRComponentProperty_VRComponentProperty_IsStatic, EVRComponentProperty_VRComponentProperty_IsVisible, EVRComponentProperty_VRComponentProperty_IsTouched, EVRComponentProperty_VRComponentProperty_IsPressed, EVRComponentProperty_VRComponentProperty_IsScrolled
-
EVRNotificationType_Transient, EVRNotificationType_Persistent, EVRNotificationType_Transient_SystemWithUserValue
EVRNotificationType
: Be aware that the notification type is used as 'priority' to pick the next notification.Enum values:
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 callingRemoveNotification
. 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 theulUserValue
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.
-
EVRNotificationStyle_None, EVRNotificationStyle_Application, EVRNotificationStyle_Contact_Disabled, EVRNotificationStyle_Contact_Enabled, EVRNotificationStyle_Contact_Active
EVRNotificationStyle
Enum values:
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.
-
EVRSettingsError_VRSettingsError_None, EVRSettingsError_VRSettingsError_IPCFailed, EVRSettingsError_VRSettingsError_WriteFailed, EVRSettingsError_VRSettingsError_ReadFailed, EVRSettingsError_VRSettingsError_JsonParseFailed, EVRSettingsError_VRSettingsError_UnsetSettingHasNoDefault
EVRSettingsError
Enum values:
EVRSettingsError_VRSettingsError_None
EVRSettingsError_VRSettingsError_IPCFailed
EVRSettingsError_VRSettingsError_WriteFailed
EVRSettingsError_VRSettingsError_ReadFailed
EVRSettingsError_VRSettingsError_JsonParseFailed
EVRSettingsError_VRSettingsError_UnsetSettingHasNoDefault
- This will be returned if the setting does not appear in the appropriate default file and has not been set.
-
EVRScreenshotError_VRScreenshotError_None, EVRScreenshotError_VRScreenshotError_RequestFailed, EVRScreenshotError_VRScreenshotError_IncompatibleVersion, EVRScreenshotError_VRScreenshotError_NotFound, EVRScreenshotError_VRScreenshotError_BufferTooSmall, EVRScreenshotError_VRScreenshotError_ScreenshotAlreadyInProgress
EVRScreenshotError
: Errors that can occur with the VR compositor.Enum values:
EVRScreenshotError_VRScreenshotError_None
EVRScreenshotError_VRScreenshotError_RequestFailed
EVRScreenshotError_VRScreenshotError_IncompatibleVersion
EVRScreenshotError_VRScreenshotError_NotFound
EVRScreenshotError_VRScreenshotError_BufferTooSmall
EVRScreenshotError_VRScreenshotError_ScreenshotAlreadyInProgress
-
EVRSkeletalTransformSpace_VRSkeletalTransformSpace_Model, EVRSkeletalTransformSpace_VRSkeletalTransformSpace_Parent
EVRSkeletalTransformSpace
Enum values:
-
EVRSkeletalReferencePose_VRSkeletalReferencePose_BindPose, EVRSkeletalReferencePose_VRSkeletalReferencePose_OpenHand, EVRSkeletalReferencePose_VRSkeletalReferencePose_Fist, EVRSkeletalReferencePose_VRSkeletalReferencePose_GripLimit
-
EVRFinger_VRFinger_Thumb, EVRFinger_VRFinger_Index, EVRFinger_VRFinger_Middle, EVRFinger_VRFinger_Ring, EVRFinger_VRFinger_Pinky, EVRFinger_VRFinger_Count
-
EVRFingerSplay_VRFingerSplay_Thumb_Index, EVRFingerSplay_VRFingerSplay_Index_Middle, EVRFingerSplay_VRFingerSplay_Middle_Ring, EVRFingerSplay_VRFingerSplay_Ring_Pinky, EVRFingerSplay_VRFingerSplay_Count
-
EVRSummaryType_VRSummaryType_FromAnimation, EVRSummaryType_VRSummaryType_FromDevice
EVRSummaryType
Enum values:
EVRSummaryType_VRSummaryType_FromAnimation
- The skeletal summary data will match the animated bone transforms for the action.EVRSummaryType_VRSummaryType_FromDevice
- The skeletal summary data will include unprocessed data directly from the device when available.This data is generally less latent than the data that is computed from the animations.
-
EVRInputFilterCancelType_VRInputFilterCancel_Timers, EVRInputFilterCancelType_VRInputFilterCancel_Momentum
EVRInputFilterCancelType
Enum values:
-
EVRInputStringBits_VRInputString_Hand, EVRInputStringBits_VRInputString_ControllerType, EVRInputStringBits_VRInputString_InputSource, EVRInputStringBits_VRInputString_All
-
EIOBufferError_IOBuffer_Success, EIOBufferError_IOBuffer_OperationFailed, EIOBufferError_IOBuffer_InvalidHandle, EIOBufferError_IOBuffer_InvalidArgument, EIOBufferError_IOBuffer_PathExists, EIOBufferError_IOBuffer_PathDoesNotExist, EIOBufferError_IOBuffer_Permission
-
EIOBufferMode_IOBufferMode_Read, EIOBufferMode_IOBufferMode_Write, EIOBufferMode_IOBufferMode_Create
EIOBufferMode
Enum values:
-
-
Method Detail
-
getLibrary
public static org.lwjgl.system.SharedLibrary getLibrary()
Returns the openvrSharedLibrary
.
-
nVR_InitInternal
public static int nVR_InitInternal(long peError, int eType)
Unsafe version of:InitInternal
-
VR_InitInternal
public static int VR_InitInternal(java.nio.IntBuffer peError, int eType)
Initializes the connection to the VR hardware.- Parameters:
peError
- a buffer in which to store the error codeeType
- the application type. One of:- Returns:
- a VR interface handles token
-
VR_ShutdownInternal
public static void VR_ShutdownInternal()
Shuts down the connection to the VR hardware and cleans up the OpenVR API. TheIVRSystem
pointer returned byInitInternal
will be invalid after this call is made.
-
VR_IsHmdPresent
public static boolean VR_IsHmdPresent()
Returns true if the system believes that an HMD is present on the system. This function is much faster than initializing all of OpenVR just to check for an HMD. Use it when you have a piece of UI that you want to enable only for users with an HMD.This function will return true in situations where
InitInternal
will returnNULL
. It is a quick way to eliminate users that have no VR hardware, but there are some startup conditions that can only be detected by starting the system.
-
nVR_GetGenericInterface
public static long nVR_GetGenericInterface(long pchInterfaceVersion, long peError)
Unsafe version of:GetGenericInterface
-
VR_GetGenericInterface
public static long VR_GetGenericInterface(java.nio.ByteBuffer pchInterfaceVersion, java.nio.IntBuffer peError) public static long VR_GetGenericInterface(java.lang.CharSequence pchInterfaceVersion, java.nio.IntBuffer peError)
Requests an interface by name from OpenVR. It will returnNULL
and pass back an error inpeError
if the interface can't be found. It will always returnNULL
ifInitInternal
has not been called successfully.- Parameters:
pchInterfaceVersion
- the interface name and versionpeError
- a buffer in which to store the error code
-
VR_IsRuntimeInstalled
public static boolean VR_IsRuntimeInstalled()
Returns true if the OpenVR runtime is installed on the system.
-
nVR_RuntimePath
public static long nVR_RuntimePath()
Unsafe version of:RuntimePath
-
VR_RuntimePath
@Nullable public static java.lang.String VR_RuntimePath()
Returns where the OpenVR runtime is installed.
-
nVR_IsInterfaceVersionValid
public static boolean nVR_IsInterfaceVersionValid(long pchInterfaceVersion)
Unsafe version of:IsInterfaceVersionValid
-
VR_IsInterfaceVersionValid
public static boolean VR_IsInterfaceVersionValid(java.nio.ByteBuffer pchInterfaceVersion) public static boolean VR_IsInterfaceVersionValid(java.lang.CharSequence pchInterfaceVersion)
Returns whether the interface of the specified version exists.- Parameters:
pchInterfaceVersion
- the interface name and version
-
VR_GetInitToken
public static int VR_GetInitToken()
Returns a token that represents whether the VR interface handles need to be reloaded.
-
nVR_GetVRInitErrorAsSymbol
public static long nVR_GetVRInitErrorAsSymbol(int error)
Unsafe version of:GetVRInitErrorAsSymbol
-
VR_GetVRInitErrorAsSymbol
@Nullable public static java.lang.String VR_GetVRInitErrorAsSymbol(int error)
Returns theEVRInitError
enum value as a string. It can be called any time, regardless of whether the VR system is started up.- Parameters:
error
- the error code
-
nVR_GetVRInitErrorAsEnglishDescription
public static long nVR_GetVRInitErrorAsEnglishDescription(int error)
Unsafe version of:GetVRInitErrorAsEnglishDescription
-
VR_GetVRInitErrorAsEnglishDescription
@Nullable public static java.lang.String VR_GetVRInitErrorAsEnglishDescription(int error)
Returns an english string for anEVRInitError
.Applications should call
GetVRInitErrorAsSymbol
instead and use that as a key to look up their own localized error message. This function may be called outside ofInitInternal
/ShutdownInternal
.- Parameters:
error
- the error code
-
-