Top Description Constructors Methods
org.lwjgl.openvr

public Class VRSystem

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Main interface for display, distortion, tracking, controller, and event access.

The IVRSystem interface provides access to display configuration information, tracking data, distortion functions, controller state, events, and device properties. It is the main interface of OpenVR and can be initialized and retrieved with the InitInternal function.

Many functions in IVRSystem use a tracked device index to identify a specific device attached to the computer. There will never be more than VR#k_unMaxTrackedDeviceCount devices active in the system at any given time. Their indices will be 0 (for the HMD) and 1-15 for the other devices.

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static void
nVRSystem_ApplyTransform(long pOutputPose, long pTrackedDevicePose, long pTransform)

Unsafe version of: ApplyTransform

public static boolean
nVRSystem_ComputeDistortion(int eEye, float fU, float fV, long pDistortionCoordinates)

Unsafe version of: ComputeDistortion

public static int
nVRSystem_GetAppContainerFilePaths(long pchBuffer, int unBufferSize)

Unsafe version of: GetAppContainerFilePaths

public static int
nVRSystem_GetArrayTrackedDeviceProperty(int unDeviceIndex, int prop, int propType, long pBuffer, int unBufferSize, long pError)

Unsafe version of: GetArrayTrackedDeviceProperty

public static boolean
nVRSystem_GetBoolTrackedDeviceProperty(int unDeviceIndex, int prop, long pError)

Unsafe version of: GetBoolTrackedDeviceProperty

public static long
public static long
public static boolean
nVRSystem_GetControllerState(int unControllerDeviceIndex, long pControllerState, int unControllerStateSize)

Unsafe version of: GetControllerState

public static boolean
nVRSystem_GetControllerStateWithPose(int eOrigin, int unControllerDeviceIndex, long pControllerState, int unControllerStateSize, long pTrackedDevicePose)

Unsafe version of: GetControllerStateWithPose

public static void
nVRSystem_GetDeviceToAbsoluteTrackingPose(int eOrigin, float fPredictedSecondsToPhotonsFromNow, long pTrackedDevicePoseArray, int unTrackedDevicePoseArrayCount)

Unsafe version of: GetDeviceToAbsoluteTrackingPose

public static void
nVRSystem_GetDXGIOutputInfo(long pnAdapterIndex)

Unsafe version of: GetDXGIOutputInfo

public static long
public static native void
nVRSystem_GetEyeToHeadTransform(int eEye, long __functionAddress, long __result)

Unsafe version of: GetEyeToHeadTransform

public static void
nVRSystem_GetEyeToHeadTransform(int eEye, long __result)

Unsafe version of: GetEyeToHeadTransform

public static float
nVRSystem_GetFloatTrackedDeviceProperty(int unDeviceIndex, int prop, long pError)

Unsafe version of: GetFloatTrackedDeviceProperty

public static native void
nVRSystem_GetHiddenAreaMesh(int eEye, int type, long __functionAddress, long __result)

Unsafe version of: GetHiddenAreaMesh

public static void
nVRSystem_GetHiddenAreaMesh(int eEye, int type, long __result)

Unsafe version of: GetHiddenAreaMesh

public static int
nVRSystem_GetInt32TrackedDeviceProperty(int unDeviceIndex, int prop, long pError)

Unsafe version of: GetInt32TrackedDeviceProperty

public static native void
nVRSystem_GetMatrix34TrackedDeviceProperty(int unDeviceIndex, int prop, long pError, long __functionAddress, long __result)

Unsafe version of: GetMatrix34TrackedDeviceProperty

public static void
nVRSystem_GetMatrix34TrackedDeviceProperty(int unDeviceIndex, int prop, long pError, long __result)

Unsafe version of: GetMatrix34TrackedDeviceProperty

public static void
nVRSystem_GetOutputDevice(long pnDevice, int textureType, long pInstance)

Unsafe version of: GetOutputDevice

public static native void
nVRSystem_GetProjectionMatrix(int eEye, float fNearZ, float fFarZ, long __functionAddress, long __result)

Unsafe version of: GetProjectionMatrix

public static void
nVRSystem_GetProjectionMatrix(int eEye, float fNearZ, float fFarZ, long __result)

Unsafe version of: GetProjectionMatrix

public static void
nVRSystem_GetProjectionRaw(int eEye, long pfLeft, long pfRight, long pfTop, long pfBottom)

Unsafe version of: GetProjectionRaw

public static long
public static native void
public static void
public static void
nVRSystem_GetRecommendedRenderTargetSize(long pnWidth, long pnHeight)

Unsafe version of: GetRecommendedRenderTargetSize

public static long
public static native void
public static void
public static int
nVRSystem_GetSortedTrackedDeviceIndicesOfClass(int eTrackedDeviceClass, long punTrackedDeviceIndexArray, int unTrackedDeviceIndexArrayCount, int unRelativeToTrackedDeviceIndex)

Unsafe version of: GetSortedTrackedDeviceIndicesOfClass

public static int
nVRSystem_GetStringTrackedDeviceProperty(int unDeviceIndex, int prop, long pchValue, int
the size of the buffer pointed to by pchValue
unBufferSize
,
long pError)

Unsafe version of: GetStringTrackedDeviceProperty

public static boolean
nVRSystem_GetTimeSinceLastVsync(long pfSecondsSinceLastVsync, long pulFrameCounter)

Unsafe version of: GetTimeSinceLastVsync

public static long
nVRSystem_GetUint64TrackedDeviceProperty(int unDeviceIndex, int prop, long pError)

Unsafe version of: GetUint64TrackedDeviceProperty

public static boolean
nVRSystem_PollNextEvent(long pEvent, int uncbVREvent)

Unsafe version of: PollNextEvent

public static boolean
nVRSystem_PollNextEventWithPose(int eOrigin, long pEvent, int uncbVREvent, long pTrackedDevicePose)

Unsafe version of: PollNextEventWithPose

public static void
VRSystem_AcknowledgeQuit_Exiting()

Call this to acknowledge to the system that VR#EVREventType_VREvent_Quit has been received and that the process is exiting.

public static void
VRSystem_ApplyTransform(TrackedDevicePose pOutputPose, TrackedDevicePose pTrackedDevicePose, HmdMatrix34 pTransform)

Convenience utility to apply the specified transform to the specified pose.

public static boolean

Returns:

true for success. Otherwise, returns false, and distortion coordinates are not suitable.
VRSystem_ComputeDistortion
(int
determines which eye the function should return the distortion value for. One of:
VR#EVREye_Eye_LeftVR#EVREye_Eye_Right
eEye
,
float
horizontal texture coordinate for the output pixel within the viewport
fU
,
float
vertical texture coordinate for the output pixel within the viewport
fV
,
DistortionCoordinates
a struct in which to return the distortion coordinates
pDistortionCoordinates
)

Gets the result of the distortion function for the specified eye and input UVs.

public static int

Returns:

the number of bytes needed to hold the list
VRSystem_GetAppContainerFilePaths
(ByteBuffer pchBuffer)

Retrieves a null-terminated, semicolon-delimited list of UTF8 file paths that an application must have read access to when running inside of an app container.

public static String

Returns:

the number of bytes needed to hold the list
VRSystem_GetAppContainerFilePaths
(int unBufferSize)

Retrieves a null-terminated, semicolon-delimited list of UTF8 file paths that an application must have read access to when running inside of an app container.

public static int
VRSystem_GetArrayTrackedDeviceProperty(int
index of the device to get the property for
unDeviceIndex
,
int
which property to get
prop
,
int propType, ByteBuffer pBuffer, IntBuffer
the error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.
pError
)

Returns an array of one type of property.

public static boolean
VRSystem_GetBoolTrackedDeviceProperty(int
index of the device to get the property for
unDeviceIndex
,
int
which property to get
prop
,
IntBuffer
the error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.
pError
)

Returns a bool property.

public static String
public static String
public static int
VRSystem_GetControllerRoleForTrackedDeviceIndex(int unDeviceIndex)

Returns the controller type associated with a device index.

public static boolean

Returns:

false if the controller index is invalid
VRSystem_GetControllerState
(int
the tracked device index of the controller to get the state of
unControllerDeviceIndex
,
VRControllerState
a struct to fill with the controller state
pControllerState
,
int
the size in bytes of the VRControllerState struct
unControllerStateSize
)

Fills the supplied struct with the current state of the controller.

public static boolean

Returns:

false if the controller index is invalid
VRSystem_GetControllerState
(int
the tracked device index of the controller to get the state of
unControllerDeviceIndex
,
VRControllerState
a struct to fill with the controller state
pControllerState
)

Fills the supplied struct with the current state of the controller.

public static boolean
VRSystem_GetControllerStateWithPose(int eOrigin, int
the tracked device index of the controller to get the state of
unControllerDeviceIndex
,
VRControllerState
a struct to fill with the controller state
pControllerState
,
int
the size in bytes of the VRControllerState struct
unControllerStateSize
,
TrackedDevicePose
a pose struct to fill with the pose of the controller when the last button event occurred
pTrackedDevicePose
)

Fills the supplied struct with the current state of the controller and the provided pose with the pose of the controller when the controller state was updated most recently.

public static boolean
VRSystem_GetControllerStateWithPose(int eOrigin, int
the tracked device index of the controller to get the state of
unControllerDeviceIndex
,
VRControllerState
a struct to fill with the controller state
pControllerState
,
TrackedDevicePose
a pose struct to fill with the pose of the controller when the last button event occurred
pTrackedDevicePose
)

Fills the supplied struct with the current state of the controller and the provided pose with the pose of the controller when the controller state was updated most recently.

public static int

Returns:

-1 if there was an error
VRSystem_GetD3D9AdapterIndex
()

D3D9 Only

Returns the adapter index that the user should pass into CreateDevice to set up D3D9 in such a way that it can go full screen exclusive on the HMD.

public static void
VRSystem_GetDeviceToAbsoluteTrackingPose(int eOrigin, float
number of seconds from now to predict poses for. Positive numbers are in the future. Pass 0 to get the state at the instant the function is called.
fPredictedSecondsToPhotonsFromNow
,
TrackedDevicePose.Buffer pTrackedDevicePoseArray)

The pose that the tracker thinks that the HMD will be in at the specified number of seconds into the future.

public static void
VRSystem_GetDXGIOutputInfo(IntBuffer
the index of the adapter to use for this display
pnAdapterIndex
)

D3D10/11 Only

Returns the adapter index that the user should pass into EnumAdapters to create the device and swap chain in DX10 and DX11.

public static String
VRSystem_GetEventTypeNameFromEnum(int
the event type to return a string for. One of:
VR#EVREventType_VREvent_None
VR#EVREventType_VREvent_TrackedDeviceActivated
VR#EVREventType_VREvent_TrackedDeviceDeactivated
VR#EVREventType_VREvent_TrackedDeviceUpdated
VR#EVREventType_VREvent_TrackedDeviceUserInteractionStarted
VR#EVREventType_VREvent_TrackedDeviceUserInteractionEnded
VR#EVREventType_VREvent_IpdChanged
VR#EVREventType_VREvent_EnterStandbyMode
VR#EVREventType_VREvent_LeaveStandbyMode
VR#EVREventType_VREvent_TrackedDeviceRoleChanged
VR#EVREventType_VREvent_WatchdogWakeUpRequested
VR#EVREventType_VREvent_LensDistortionChanged
VR#EVREventType_VREvent_PropertyChanged
VR#EVREventType_VREvent_WirelessDisconnect
VR#EVREventType_VREvent_WirelessReconnect
VR#EVREventType_VREvent_ButtonPress
VR#EVREventType_VREvent_ButtonUnpress
VR#EVREventType_VREvent_ButtonTouch
VR#EVREventType_VREvent_ButtonUntouch
VR#EVREventType_VREvent_Modal_Cancel
VR#EVREventType_VREvent_MouseMove
VR#EVREventType_VREvent_MouseButtonDown
VR#EVREventType_VREvent_MouseButtonUp
VR#EVREventType_VREvent_FocusEnter
VR#EVREventType_VREvent_FocusLeave
VR#EVREventType_VREvent_ScrollDiscrete
VR#EVREventType_VREvent_TouchPadMove
VR#EVREventType_VREvent_OverlayFocusChanged
VR#EVREventType_VREvent_ReloadOverlays
VR#EVREventType_VREvent_ScrollSmooth
VR#EVREventType_VREvent_LockMousePosition
VR#EVREventType_VREvent_UnlockMousePosition
VR#EVREventType_VREvent_InputFocusCaptured
VR#EVREventType_VREvent_InputFocusReleased
VR#EVREventType_VREvent_SceneApplicationChanged
VR#EVREventType_VREvent_InputFocusChanged
VR#EVREventType_VREvent_SceneApplicationUsingWrongGraphicsAdapter
VR#EVREventType_VREvent_ActionBindingReloaded
VR#EVREventType_VREvent_HideRenderModels
VR#EVREventType_VREvent_ShowRenderModels
VR#EVREventType_VREvent_SceneApplicationStateChanged
VR#EVREventType_VREvent_SceneAppPipeDisconnected
VR#EVREventType_VREvent_ConsoleOpened
VR#EVREventType_VREvent_ConsoleClosed
VR#EVREventType_VREvent_OverlayShown
VR#EVREventType_VREvent_OverlayHidden
VR#EVREventType_VREvent_DashboardActivated
VR#EVREventType_VREvent_DashboardDeactivated
VR#EVREventType_VREvent_DashboardRequested
VR#EVREventType_VREvent_ResetDashboard
VR#EVREventType_VREvent_ImageLoaded
VR#EVREventType_VREvent_ShowKeyboard
VR#EVREventType_VREvent_HideKeyboard
VR#EVREventType_VREvent_OverlayGamepadFocusGained
VR#EVREventType_VREvent_OverlayGamepadFocusLost
VR#EVREventType_VREvent_OverlaySharedTextureChanged
VR#EVREventType_VREvent_ScreenshotTriggered
VR#EVREventType_VREvent_ImageFailed
VR#EVREventType_VREvent_DashboardOverlayCreated
VR#EVREventType_VREvent_SwitchGamepadFocus
VR#EVREventType_VREvent_RequestScreenshot
VR#EVREventType_VREvent_ScreenshotTaken
VR#EVREventType_VREvent_ScreenshotFailed
VR#EVREventType_VREvent_SubmitScreenshotToDashboard
VR#EVREventType_VREvent_ScreenshotProgressToDashboard
VR#EVREventType_VREvent_PrimaryDashboardDeviceChanged
VR#EVREventType_VREvent_RoomViewShown
VR#EVREventType_VREvent_RoomViewHidden
VR#EVREventType_VREvent_ShowUI
VR#EVREventType_VREvent_ShowDevTools
VR#EVREventType_VREvent_DesktopViewUpdating
VR#EVREventType_VREvent_DesktopViewReady
VR#EVREventType_VREvent_StartDashboard
VR#EVREventType_VREvent_ElevatePrism
VR#EVREventType_VREvent_OverlayClosed
VR#EVREventType_VREvent_Notification_Shown
VR#EVREventType_VREvent_Notification_Hidden
VR#EVREventType_VREvent_Notification_BeginInteraction
VR#EVREventType_VREvent_Notification_Destroyed
VR#EVREventType_VREvent_Quit
VR#EVREventType_VREvent_ProcessQuit
VR#EVREventType_VREvent_QuitAcknowledged
VR#EVREventType_VREvent_DriverRequestedQuit
VR#EVREventType_VREvent_RestartRequested
VR#EVREventType_VREvent_InvalidateSwapTextureSets
VR#EVREventType_VREvent_ChaperoneDataHasChanged
VR#EVREventType_VREvent_ChaperoneUniverseHasChanged
VR#EVREventType_VREvent_ChaperoneTempDataHasChanged
VR#EVREventType_VREvent_ChaperoneSettingsHaveChanged
VR#EVREventType_VREvent_SeatedZeroPoseReset
VR#EVREventType_VREvent_ChaperoneFlushCache
VR#EVREventType_VREvent_ChaperoneRoomSetupStarting
VR#EVREventType_VREvent_ChaperoneRoomSetupFinished
VR#EVREventType_VREvent_StandingZeroPoseReset
VR#EVREventType_VREvent_AudioSettingsHaveChanged
VR#EVREventType_VREvent_BackgroundSettingHasChanged
VR#EVREventType_VREvent_CameraSettingsHaveChanged
VR#EVREventType_VREvent_ReprojectionSettingHasChanged
VR#EVREventType_VREvent_ModelSkinSettingsHaveChanged
VR#EVREventType_VREvent_EnvironmentSettingsHaveChanged
VR#EVREventType_VREvent_PowerSettingsHaveChanged
VR#EVREventType_VREvent_EnableHomeAppSettingsHaveChanged
VR#EVREventType_VREvent_SteamVRSectionSettingChanged
VR#EVREventType_VREvent_LighthouseSectionSettingChanged
VR#EVREventType_VREvent_NullSectionSettingChanged
VR#EVREventType_VREvent_UserInterfaceSectionSettingChanged
VR#EVREventType_VREvent_NotificationsSectionSettingChanged
VR#EVREventType_VREvent_KeyboardSectionSettingChanged
VR#EVREventType_VREvent_PerfSectionSettingChanged
VR#EVREventType_VREvent_DashboardSectionSettingChanged
VR#EVREventType_VREvent_WebInterfaceSectionSettingChanged
VR#EVREventType_VREvent_TrackersSectionSettingChanged
VR#EVREventType_VREvent_LastKnownSectionSettingChanged
VR#EVREventType_VREvent_DismissedWarningsSectionSettingChanged
VR#EVREventType_VREvent_GpuSpeedSectionSettingChanged
VR#EVREventType_VREvent_WindowsMRSectionSettingChanged
VR#EVREventType_VREvent_OtherSectionSettingChanged
VR#EVREventType_VREvent_StatusUpdate
VR#EVREventType_VREvent_WebInterface_InstallDriverCompleted
VR#EVREventType_VREvent_MCImageUpdated
VR#EVREventType_VREvent_FirmwareUpdateStarted
VR#EVREventType_VREvent_FirmwareUpdateFinished
VR#EVREventType_VREvent_KeyboardClosed
VR#EVREventType_VREvent_KeyboardCharInput
VR#EVREventType_VREvent_KeyboardDone
VR#EVREventType_VREvent_ApplicationListUpdated
VR#EVREventType_VREvent_ApplicationMimeTypeLoad
VR#EVREventType_VREvent_ProcessConnected
VR#EVREventType_VREvent_ProcessDisconnected
VR#EVREventType_VREvent_Compositor_ChaperoneBoundsShown
VR#EVREventType_VREvent_Compositor_ChaperoneBoundsHidden
VR#EVREventType_VREvent_Compositor_DisplayDisconnected
VR#EVREventType_VREvent_Compositor_DisplayReconnected
VR#EVREventType_VREvent_Compositor_HDCPError
VR#EVREventType_VREvent_Compositor_ApplicationNotResponding
VR#EVREventType_VREvent_Compositor_ApplicationResumed
VR#EVREventType_VREvent_Compositor_OutOfVideoMemory
VR#EVREventType_VREvent_Compositor_DisplayModeNotSupported
VR#EVREventType_VREvent_Compositor_StageOverrideReady
VR#EVREventType_VREvent_Compositor_RequestDisconnectReconnect
VR#EVREventType_VREvent_TrackedCamera_StartVideoStream
VR#EVREventType_VREvent_TrackedCamera_StopVideoStream
VR#EVREventType_VREvent_TrackedCamera_PauseVideoStream
VR#EVREventType_VREvent_TrackedCamera_ResumeVideoStream
VR#EVREventType_VREvent_TrackedCamera_EditingSurface
VR#EVREventType_VREvent_PerformanceTest_EnableCapture
VR#EVREventType_VREvent_PerformanceTest_DisableCapture
VR#EVREventType_VREvent_PerformanceTest_FidelityLevel
VR#EVREventType_VREvent_MessageOverlay_Closed
VR#EVREventType_VREvent_MessageOverlayCloseRequested
VR#EVREventType_VREvent_Input_HapticVibration
VR#EVREventType_VREvent_Input_BindingLoadFailed
VR#EVREventType_VREvent_Input_BindingLoadSuccessful
VR#EVREventType_VREvent_Input_ActionManifestReloaded
VR#EVREventType_VREvent_Input_ActionManifestLoadFailed
VR#EVREventType_VREvent_Input_ProgressUpdate
VR#EVREventType_VREvent_Input_TrackerActivated
VR#EVREventType_VREvent_Input_BindingsUpdated
VR#EVREventType_VREvent_Input_BindingSubscriptionChanged
VR#EVREventType_VREvent_SpatialAnchors_PoseUpdated
VR#EVREventType_VREvent_SpatialAnchors_DescriptorUpdated
VR#EVREventType_VREvent_SpatialAnchors_RequestPoseUpdate
VR#EVREventType_VREvent_SpatialAnchors_RequestDescriptorUpdate
VR#EVREventType_VREvent_SystemReport_Started
VR#EVREventType_VREvent_Monitor_ShowHeadsetView
VR#EVREventType_VREvent_Monitor_HideHeadsetView
VR#EVREventType_VREvent_VendorSpecific_Reserved_Start
VR#EVREventType_VREvent_VendorSpecific_Reserved_End
eType
)

Returns the name of an EVREvent enum value.

public static HmdMatrix34
VRSystem_GetEyeToHeadTransform(int
determines which eye the function should return the eye matrix for. One of:
VR#EVREye_Eye_LeftVR#EVREye_Eye_Right
eEye
,
HmdMatrix34 __result)

Returns the transform from eye space to the head space.

public static float
VRSystem_GetFloatTrackedDeviceProperty(int
index of the device to get the property for
unDeviceIndex
,
int
which property to get
prop
,
IntBuffer
the error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.
pError
)

Returns a float property.

public static HiddenAreaMesh
public static int
VRSystem_GetInt32TrackedDeviceProperty(int
index of the device to get the property for
unDeviceIndex
,
int
which property to get
prop
,
IntBuffer
the error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.
pError
)

Returns an int property.

public static HmdMatrix34
VRSystem_GetMatrix34TrackedDeviceProperty(int
index of the device to get the property for
unDeviceIndex
,
int
which property to get
prop
,
IntBuffer
the error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.
pError
,
HmdMatrix34 __result)

Returns a matrix property.

public static void
VRSystem_GetOutputDevice(LongBuffer pnDevice, int textureType, long
an optional parameter that is required only when textureType is VR#ETextureType_TextureType_Vulkan
pInstance
)

Returns platform- and texture-type specific adapter identification so that applications and the compositor are creating textures and swap chains on the same GPU.

public static HmdMatrix44
VRSystem_GetProjectionMatrix(int
determines which eye the function should return the projection for. One of:
VR#EVREye_Eye_LeftVR#EVREye_Eye_Right
eEye
,
float
distance to the near clip plane in meters
fNearZ
,
float
distance to the far clip plane in meters
fFarZ
,
HmdMatrix44 __result)

Returns the projection matrix for the specified eye.

public static void
VRSystem_GetProjectionRaw(int
determines which eye the function should return the projection for. One of:
VR#EVREye_Eye_LeftVR#EVREye_Eye_Right
eEye
,
FloatBuffer
coordinate for the left clipping plane
pfLeft
,
FloatBuffer
coordinate for the right clipping plane
pfRight
,
FloatBuffer
coordinate for the top clipping plane
pfTop
,
FloatBuffer
coordinate for the bottom clipping plane
pfBottom
)

Returns the components necessary to build your own projection matrix in case your application is doing something fancy like infinite Z.

public static String
public static HmdMatrix34
VRSystem_GetRawZeroPoseToStandingAbsoluteTrackingPose(HmdMatrix34 __result)

Returns the transform from the tracking origin to the standing absolute tracking system.

public static void
VRSystem_GetRecommendedRenderTargetSize(IntBuffer
recommended width for the offscreen render target
pnWidth
,
IntBuffer
recommended height for the offscreen render target
pnHeight
)

Returns the suggested size for the intermediate render target that the distortion pulls from.

public static String
VRSystem_GetRuntimeVersion()

Returns the current version of the SteamVR runtime.

public static HmdMatrix34
VRSystem_GetSeatedZeroPoseToStandingAbsoluteTrackingPose(HmdMatrix34 __result)

Returns the transform from the seated zero pose to the standing absolute tracking system.

public static int

Returns:

the number of devices in the list, or the size of the array needed if not large enough
VRSystem_GetSortedTrackedDeviceIndicesOfClass
(int eTrackedDeviceClass, IntBuffer punTrackedDeviceIndexArray, int unRelativeToTrackedDeviceIndex)

Get a sorted array of device indices of a given class of tracked devices (e.g. controllers).

public static int
VRSystem_GetStringTrackedDeviceProperty(int
index of the device to get the property for
unDeviceIndex
,
int
which property to get
prop
,
ByteBuffer
the buffer to store string properties in. unBufferSize should be the size of this buffer.
pchValue
,
IntBuffer
the error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.
pError
)

Returns a string property.

public static String
VRSystem_GetStringTrackedDeviceProperty(int
index of the device to get the property for
unDeviceIndex
,
int
which property to get
prop
,
int
the size of the buffer pointed to by pchValue
unBufferSize
,
IntBuffer
the error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.
pError
)

Returns a string property.

public static String
VRSystem_GetStringTrackedDeviceProperty(int
index of the device to get the property for
unDeviceIndex
,
int
which property to get
prop
,
IntBuffer
the error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.
pError
)

Returns a string property.

public static boolean

Returns:

if no vsync times are available the function will return zero for vsync time and frame counter and return false from the method
VRSystem_GetTimeSinceLastVsync
(FloatBuffer
fractional number of seconds since the last vsync event. This will never exceed the length of a single frame.
pfSecondsSinceLastVsync
,
LongBuffer
the number of frames since vrserver.exe started
pulFrameCounter
)

Returns the number of elapsed seconds since the last recorded vsync event.

public static int
VRSystem_GetTrackedDeviceActivityLevel(int unDeviceId)

Returns the level of activity on the device.

public static int
VRSystem_GetTrackedDeviceClass(int
index of the device to get the device class for.
unDeviceIndex
)

Returns the device class of a tracked device.

public static int
public static long
VRSystem_GetUint64TrackedDeviceProperty(int
index of the device to get the property for
unDeviceIndex
,
int
which property to get
prop
,
IntBuffer
the error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.
pError
)

Returns a uint64 property.

public static boolean
VRSystem_IsDisplayOnDesktop()

Use to determine if the headset display is part of the desktop (i.e. extended) or hidden (i.e. direct mode).

public static boolean
VRSystem_IsInputAvailable()

Returns true if this application is receiving input from the system.

public static boolean
VRSystem_IsSteamVRDrawingControllers()

Returns true if SteamVR is drawing controllers on top of the application.

public static boolean
VRSystem_IsTrackedDeviceConnected(int
index of the device to test connected state for
unDeviceIndex
)

Returns true if there is a device connected in this slot.

public static int
VRSystem_PerformFirmwareUpdate(int unDeviceIndex)

Performs the actual firmware update if applicable.

public static boolean
VRSystem_PollNextEvent(VREvent
an event structure to fill with the next event
pEvent
,
int
the size in bytes of the VREvent struct
uncbVREvent
)

Returns true and fills the event with the next event on the queue if there is one.

public static boolean
VRSystem_PollNextEvent(VREvent
an event structure to fill with the next event
pEvent
)

Returns true and fills the event with the next event on the queue if there is one.

public static boolean
VRSystem_PollNextEventWithPose(int eOrigin, VREvent
an event structure to fill with the next event
pEvent
,
int
the size in bytes of the VREvent struct
uncbVREvent
,
TrackedDevicePose
a pose struct to fill with the returned event's pose. Must not be NULL.
pTrackedDevicePose
)

Returns true and fills the event with the next event on the queue if there is one.

public static boolean
VRSystem_PollNextEventWithPose(int eOrigin, VREvent
an event structure to fill with the next event
pEvent
,
TrackedDevicePose
a pose struct to fill with the returned event's pose. Must not be NULL.
pTrackedDevicePose
)

Returns true and fills the event with the next event on the queue if there is one.

public static boolean

Returns:

true indicates that the change was successful
VRSystem_SetDisplayVisibility
(boolean
the display visibility
bIsVisibleOnDesktop
)

Sets the display visibility (true = extended, false = direct mode).

public static boolean
VRSystem_ShouldApplicationPause()

Returns true if the user has put SteamVR into a mode that is distracting them from the application.

public static boolean
VRSystem_ShouldApplicationReduceRenderingWork()

Returns true if SteamVR is doing significant rendering work and the game should do what it can to reduce its own workload.

public static void
VRSystem_TriggerHapticPulse(int
the tracked device index of the controller to trigger a haptic pulse on
unControllerDeviceIndex
,
int
the ID of the axis to trigger a haptic pulse on
unAxisId
,
short
the duration of the desired haptic pulse in microseconds
usDurationMicroSec
)

Trigger a single haptic pulse on a controller.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait