Package org.lwjgl.openvr

Class VRSystem

java.lang.Object

org.lwjgl.openvr.VRSystem

public class VRSystem
extends java.lang.Object

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.

Method Summary

Modifier and Type	Method	Description
static void	nVRSystem_ApplyTransform(long pOutputPose, long pTrackedDevicePose, long pTransform)	Unsafe version of: ApplyTransform
static boolean	nVRSystem_ComputeDistortion(int eEye, float fU, float fV, long pDistortionCoordinates)	Unsafe version of: ComputeDistortion
static int	nVRSystem_GetAppContainerFilePaths(long pchBuffer, int unBufferSize)	Unsafe version of: GetAppContainerFilePaths
static int	nVRSystem_GetArrayTrackedDeviceProperty(int unDeviceIndex, int prop, int propType, long pBuffer, int unBufferSize, long pError)	Unsafe version of: GetArrayTrackedDeviceProperty
static boolean	nVRSystem_GetBoolTrackedDeviceProperty(int unDeviceIndex, int prop, long pError)	Unsafe version of: GetBoolTrackedDeviceProperty
static long	nVRSystem_GetButtonIdNameFromEnum(int eButtonId)	Unsafe version of: GetButtonIdNameFromEnum
static long	nVRSystem_GetControllerAxisTypeNameFromEnum(int eAxisType)	Unsafe version of: GetControllerAxisTypeNameFromEnum
static boolean	nVRSystem_GetControllerState(int unControllerDeviceIndex, long pControllerState, int unControllerStateSize)	Unsafe version of: GetControllerState
static boolean	nVRSystem_GetControllerStateWithPose(int eOrigin, int unControllerDeviceIndex, long pControllerState, int unControllerStateSize, long pTrackedDevicePose)	Unsafe version of: GetControllerStateWithPose
static void	nVRSystem_GetDeviceToAbsoluteTrackingPose(int eOrigin, float fPredictedSecondsToPhotonsFromNow, long pTrackedDevicePoseArray, int unTrackedDevicePoseArrayCount)	Unsafe version of: GetDeviceToAbsoluteTrackingPose
static void	nVRSystem_GetDXGIOutputInfo(long pnAdapterIndex)	Unsafe version of: GetDXGIOutputInfo
static long	nVRSystem_GetEventTypeNameFromEnum(int eType)	Unsafe version of: GetEventTypeNameFromEnum
static void	nVRSystem_GetEyeToHeadTransform(int eEye, long __result)	Unsafe version of: GetEyeToHeadTransform
static void	nVRSystem_GetEyeToHeadTransform(int eEye, long __functionAddress, long __result)	Unsafe version of: GetEyeToHeadTransform
static float	nVRSystem_GetFloatTrackedDeviceProperty(int unDeviceIndex, int prop, long pError)	Unsafe version of: GetFloatTrackedDeviceProperty
static void	nVRSystem_GetHiddenAreaMesh(int eEye, int type, long __result)	Unsafe version of: GetHiddenAreaMesh
static void	nVRSystem_GetHiddenAreaMesh(int eEye, int type, long __functionAddress, long __result)	Unsafe version of: GetHiddenAreaMesh
static int	nVRSystem_GetInt32TrackedDeviceProperty(int unDeviceIndex, int prop, long pError)	Unsafe version of: GetInt32TrackedDeviceProperty
static void	nVRSystem_GetMatrix34TrackedDeviceProperty(int unDeviceIndex, int prop, long pError, long __result)	Unsafe version of: GetMatrix34TrackedDeviceProperty
static void	nVRSystem_GetMatrix34TrackedDeviceProperty(int unDeviceIndex, int prop, long pError, long __functionAddress, long __result)	Unsafe version of: GetMatrix34TrackedDeviceProperty
static void	nVRSystem_GetOutputDevice(long pnDevice, int textureType, long pInstance)	Unsafe version of: GetOutputDevice
static void	nVRSystem_GetProjectionMatrix(int eEye, float fNearZ, float fFarZ, long __result)	Unsafe version of: GetProjectionMatrix
static void	nVRSystem_GetProjectionMatrix(int eEye, float fNearZ, float fFarZ, long __functionAddress, long __result)	Unsafe version of: GetProjectionMatrix
static void	nVRSystem_GetProjectionRaw(int eEye, long pfLeft, long pfRight, long pfTop, long pfBottom)	Unsafe version of: GetProjectionRaw
static long	nVRSystem_GetPropErrorNameFromEnum(int error)	Unsafe version of: GetPropErrorNameFromEnum
static void	nVRSystem_GetRawZeroPoseToStandingAbsoluteTrackingPose(long __result)	Unsafe version of: GetRawZeroPoseToStandingAbsoluteTrackingPose
static void	nVRSystem_GetRawZeroPoseToStandingAbsoluteTrackingPose(long __functionAddress, long __result)	Unsafe version of: GetRawZeroPoseToStandingAbsoluteTrackingPose
static void	nVRSystem_GetRecommendedRenderTargetSize(long pnWidth, long pnHeight)	Unsafe version of: GetRecommendedRenderTargetSize
static void	nVRSystem_GetSeatedZeroPoseToStandingAbsoluteTrackingPose(long __result)	Unsafe version of: GetSeatedZeroPoseToStandingAbsoluteTrackingPose
static void	nVRSystem_GetSeatedZeroPoseToStandingAbsoluteTrackingPose(long __functionAddress, long __result)	Unsafe version of: GetSeatedZeroPoseToStandingAbsoluteTrackingPose
static int	nVRSystem_GetSortedTrackedDeviceIndicesOfClass(int eTrackedDeviceClass, long punTrackedDeviceIndexArray, int unTrackedDeviceIndexArrayCount, int unRelativeToTrackedDeviceIndex)	Unsafe version of: GetSortedTrackedDeviceIndicesOfClass
static int	nVRSystem_GetStringTrackedDeviceProperty(int unDeviceIndex, int prop, long pchValue, int unBufferSize, long pError)	Unsafe version of: GetStringTrackedDeviceProperty
static boolean	nVRSystem_GetTimeSinceLastVsync(long pfSecondsSinceLastVsync, long pulFrameCounter)	Unsafe version of: GetTimeSinceLastVsync
static long	nVRSystem_GetUint64TrackedDeviceProperty(int unDeviceIndex, int prop, long pError)	Unsafe version of: GetUint64TrackedDeviceProperty
static boolean	nVRSystem_PollNextEvent(long pEvent, int uncbVREvent)	Unsafe version of: PollNextEvent
static boolean	nVRSystem_PollNextEventWithPose(int eOrigin, long pEvent, int uncbVREvent, long pTrackedDevicePose)	Unsafe version of: PollNextEventWithPose
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.
static void	VRSystem_AcknowledgeQuit_UserPrompt()	Call this to tell the system that the user is being prompted to save data.
static void	VRSystem_ApplyTransform(TrackedDevicePose pOutputPose, TrackedDevicePose pTrackedDevicePose, HmdMatrix34 pTransform)	Convenience utility to apply the specified transform to the specified pose.
static boolean	VRSystem_ComputeDistortion(int eEye, float fU, float fV, DistortionCoordinates pDistortionCoordinates)	Gets the result of the distortion function for the specified eye and input UVs.
static java.lang.String	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.
static int	VRSystem_GetAppContainerFilePaths(java.nio.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.
static int	VRSystem_GetArrayTrackedDeviceProperty(int unDeviceIndex, int prop, int propType, java.nio.ByteBuffer pBuffer, java.nio.IntBuffer pError)	Returns an array of one type of property.
static boolean	VRSystem_GetBoolTrackedDeviceProperty(int unDeviceIndex, int prop, java.nio.IntBuffer pError)	Returns a bool property.
static java.lang.String	VRSystem_GetButtonIdNameFromEnum(int eButtonId)	Returns the name of an EVRButtonId enum value.
static java.lang.String	VRSystem_GetControllerAxisTypeNameFromEnum(int eAxisType)	Returns the name of an EVRControllerAxisType enum value.
static int	VRSystem_GetControllerRoleForTrackedDeviceIndex(int unDeviceIndex)	Returns the controller type associated with a device index.
static boolean	VRSystem_GetControllerState(int unControllerDeviceIndex, VRControllerState pControllerState)	Fills the supplied struct with the current state of the controller.
static boolean	VRSystem_GetControllerState(int unControllerDeviceIndex, VRControllerState pControllerState, int unControllerStateSize)	Fills the supplied struct with the current state of the controller.
static boolean	VRSystem_GetControllerStateWithPose(int eOrigin, int unControllerDeviceIndex, VRControllerState pControllerState, int unControllerStateSize, TrackedDevicePose 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.
static boolean	VRSystem_GetControllerStateWithPose(int eOrigin, int unControllerDeviceIndex, VRControllerState pControllerState, TrackedDevicePose 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.
static int	VRSystem_GetD3D9AdapterIndex()	D3D9 Only
static void	VRSystem_GetDeviceToAbsoluteTrackingPose(int eOrigin, float 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.
static void	VRSystem_GetDXGIOutputInfo(java.nio.IntBuffer pnAdapterIndex)	D3D10/11 Only
static java.lang.String	VRSystem_GetEventTypeNameFromEnum(int eType)	Returns the name of an EVREvent enum value.
static HmdMatrix34	VRSystem_GetEyeToHeadTransform(int eEye, HmdMatrix34 __result)	Returns the transform from eye space to the head space.
static float	VRSystem_GetFloatTrackedDeviceProperty(int unDeviceIndex, int prop, java.nio.IntBuffer pError)	Returns a float property.
static HiddenAreaMesh	VRSystem_GetHiddenAreaMesh(int eEye, int type, HiddenAreaMesh __result)	Returns the hidden area mesh for the current HMD.
static int	VRSystem_GetInt32TrackedDeviceProperty(int unDeviceIndex, int prop, java.nio.IntBuffer pError)	Returns an int property.
static HmdMatrix34	VRSystem_GetMatrix34TrackedDeviceProperty(int unDeviceIndex, int prop, java.nio.IntBuffer pError, HmdMatrix34 __result)	Returns a matrix property.
static void	VRSystem_GetOutputDevice(java.nio.LongBuffer pnDevice, int textureType, long 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.
static HmdMatrix44	VRSystem_GetProjectionMatrix(int eEye, float fNearZ, float fFarZ, HmdMatrix44 __result)	Returns the projection matrix for the specified eye.
static void	VRSystem_GetProjectionRaw(int eEye, java.nio.FloatBuffer pfLeft, java.nio.FloatBuffer pfRight, java.nio.FloatBuffer pfTop, java.nio.FloatBuffer pfBottom)	Returns the components necessary to build your own projection matrix in case your application is doing something fancy like infinite Z.
static java.lang.String	VRSystem_GetPropErrorNameFromEnum(int error)	Returns a string that corresponds with the specified property error.
static HmdMatrix34	VRSystem_GetRawZeroPoseToStandingAbsoluteTrackingPose(HmdMatrix34 __result)	Returns the transform from the tracking origin to the standing absolute tracking system.
static void	VRSystem_GetRecommendedRenderTargetSize(java.nio.IntBuffer pnWidth, java.nio.IntBuffer pnHeight)	Returns the suggested size for the intermediate render target that the distortion pulls from.
static HmdMatrix34	VRSystem_GetSeatedZeroPoseToStandingAbsoluteTrackingPose(HmdMatrix34 __result)	Returns the transform from the seated zero pose to the standing absolute tracking system.
static int	VRSystem_GetSortedTrackedDeviceIndicesOfClass(int eTrackedDeviceClass, java.nio.IntBuffer punTrackedDeviceIndexArray, int unRelativeToTrackedDeviceIndex)	Get a sorted array of device indices of a given class of tracked devices (e.g.
static java.lang.String	VRSystem_GetStringTrackedDeviceProperty(int unDeviceIndex, int prop, int unBufferSize, java.nio.IntBuffer pError)	Returns a string property.
static int	VRSystem_GetStringTrackedDeviceProperty(int unDeviceIndex, int prop, java.nio.ByteBuffer pchValue, java.nio.IntBuffer pError)	Returns a string property.
static java.lang.String	VRSystem_GetStringTrackedDeviceProperty(int unDeviceIndex, int prop, java.nio.IntBuffer pError)	Returns a string property.
static boolean	VRSystem_GetTimeSinceLastVsync(java.nio.FloatBuffer pfSecondsSinceLastVsync, java.nio.LongBuffer pulFrameCounter)	Returns the number of elapsed seconds since the last recorded vsync event.
static int	VRSystem_GetTrackedDeviceActivityLevel(int unDeviceId)	Returns the level of activity on the device.
static int	VRSystem_GetTrackedDeviceClass(int unDeviceIndex)	Returns the device class of a tracked device.
static int	VRSystem_GetTrackedDeviceIndexForControllerRole(int unDeviceType)	Returns the device index associated with a specific role, for example the left hand or the right hand.
static long	VRSystem_GetUint64TrackedDeviceProperty(int unDeviceIndex, int prop, java.nio.IntBuffer pError)	Returns a uint64 property.
static boolean	VRSystem_IsDisplayOnDesktop()	Use to determine if the headset display is part of the desktop (i.e.
static boolean	VRSystem_IsInputAvailable()	Returns true if this application is receiving input from the system.
static boolean	VRSystem_IsSteamVRDrawingControllers()	Returns true if SteamVR is drawing controllers on top of the application.
static boolean	VRSystem_IsTrackedDeviceConnected(int unDeviceIndex)	Returns true if there is a device connected in this slot.
static int	VRSystem_PerformFirmwareUpdate(int unDeviceIndex)	Performs the actual firmware update if applicable.
static boolean	VRSystem_PollNextEvent(VREvent pEvent)	Returns true and fills the event with the next event on the queue if there is one.
static boolean	VRSystem_PollNextEvent(VREvent pEvent, int uncbVREvent)	Returns true and fills the event with the next event on the queue if there is one.
static boolean	VRSystem_PollNextEventWithPose(int eOrigin, VREvent pEvent, int uncbVREvent, TrackedDevicePose pTrackedDevicePose)	Returns true and fills the event with the next event on the queue if there is one.
static boolean	VRSystem_PollNextEventWithPose(int eOrigin, VREvent pEvent, TrackedDevicePose pTrackedDevicePose)	Returns true and fills the event with the next event on the queue if there is one.
static void	VRSystem_ResetSeatedZeroPose()	Sets the zero pose for the seated tracker coordinate system to the current position and yaw of the HMD.
static boolean	VRSystem_SetDisplayVisibility(boolean bIsVisibleOnDesktop)	Sets the display visibility (true = extended, false = direct mode).
static boolean	VRSystem_ShouldApplicationPause()	Returns true if the user has put SteamVR into a mode that is distracting them from the application.
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.
static void	VRSystem_TriggerHapticPulse(int unControllerDeviceIndex, int unAxisId, short usDurationMicroSec)	Trigger a single haptic pulse on a controller.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

nVRSystem_GetRecommendedRenderTargetSize

public static void nVRSystem_GetRecommendedRenderTargetSize(long pnWidth,
                                                            long pnHeight)

Unsafe version of: GetRecommendedRenderTargetSize

VRSystem_GetRecommendedRenderTargetSize

public static void VRSystem_GetRecommendedRenderTargetSize(java.nio.IntBuffer pnWidth,
                                                           java.nio.IntBuffer pnHeight)

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

Parameters:

pnWidth - recommended width for the offscreen render target

pnHeight - recommended height for the offscreen render target

nVRSystem_GetProjectionMatrix

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

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

Unsafe version of: GetProjectionMatrix

VRSystem_GetProjectionMatrix

public static HmdMatrix44 VRSystem_GetProjectionMatrix(int eEye,
                                                       float fNearZ,
                                                       float fFarZ,
                                                       HmdMatrix44 __result)

Returns the projection matrix for the specified eye.

Parameters:

eEye - determines which eye the function should return the projection for. One of:

VR.EVREye_Eye_Left

VR.EVREye_Eye_Right

fNearZ - distance to the near clip plane in meters

fFarZ - distance to the far clip plane in meters

nVRSystem_GetProjectionRaw

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

Unsafe version of: GetProjectionRaw

VRSystem_GetProjectionRaw

public static void VRSystem_GetProjectionRaw(int eEye,
                                             java.nio.FloatBuffer pfLeft,
                                             java.nio.FloatBuffer pfRight,
                                             java.nio.FloatBuffer pfTop,
                                             java.nio.FloatBuffer pfBottom)

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

Parameters:

eEye - determines which eye the function should return the projection for. One of:

VR.EVREye_Eye_Left

VR.EVREye_Eye_Right

pfLeft - coordinate for the left clipping plane

pfRight - coordinate for the right clipping plane

pfTop - coordinate for the top clipping plane

pfBottom - coordinate for the bottom clipping plane

nVRSystem_ComputeDistortion

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

Unsafe version of: ComputeDistortion

VRSystem_ComputeDistortion

public static boolean VRSystem_ComputeDistortion(int eEye,
                                                 float fU,
                                                 float fV,
                                                 DistortionCoordinates pDistortionCoordinates)

Gets the result of the distortion function for the specified eye and input UVs. UVs go from 0,0 in the upper left of that eye's viewport and 1,1 in the lower right of that eye's viewport.

Parameters:

eEye - determines which eye the function should return the distortion value for. One of:

VR.EVREye_Eye_Left

VR.EVREye_Eye_Right

fU - horizontal texture coordinate for the output pixel within the viewport

fV - vertical texture coordinate for the output pixel within the viewport

pDistortionCoordinates - a struct in which to return the distortion coordinates

Returns:

true for success. Otherwise, returns false, and distortion coordinates are not suitable.

nVRSystem_GetEyeToHeadTransform

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

public static void nVRSystem_GetEyeToHeadTransform(int eEye,
                                                   long __result)

Unsafe version of: GetEyeToHeadTransform

VRSystem_GetEyeToHeadTransform

public static HmdMatrix34 VRSystem_GetEyeToHeadTransform(int eEye,
                                                         HmdMatrix34 __result)

Returns the transform from eye space to the head space. Eye space is the per-eye flavor of head space that provides stereo disparity. Instead of Model * View * Projection the sequence is Model * View * Eye^-1 * Projection. Normally View and Eye^-1 will be multiplied together and treated as View in your application.

Parameters:

eEye - determines which eye the function should return the eye matrix for. One of:

VR.EVREye_Eye_Left

VR.EVREye_Eye_Right

nVRSystem_GetTimeSinceLastVsync

public static boolean nVRSystem_GetTimeSinceLastVsync(long pfSecondsSinceLastVsync,
                                                      long pulFrameCounter)

Unsafe version of: GetTimeSinceLastVsync

VRSystem_GetTimeSinceLastVsync

public static boolean VRSystem_GetTimeSinceLastVsync(java.nio.FloatBuffer pfSecondsSinceLastVsync,
                                                     java.nio.LongBuffer pulFrameCounter)

Returns the number of elapsed seconds since the last recorded vsync event. This will come from a vsync timer event in the timer if possible or from the application-reported time if that is not available.

Parameters:

pfSecondsSinceLastVsync - fractional number of seconds since the last vsync event. This will never exceed the length of a single frame.

pulFrameCounter - the number of frames since vrserver.exe started

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_GetD3D9AdapterIndex

public static int 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.

Returns:

-1 if there was an error

nVRSystem_GetDXGIOutputInfo

public static void nVRSystem_GetDXGIOutputInfo(long pnAdapterIndex)

Unsafe version of: GetDXGIOutputInfo

VRSystem_GetDXGIOutputInfo

public static void VRSystem_GetDXGIOutputInfo(java.nio.IntBuffer 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. If an error occurs the index will be set to -1.

Parameters:

pnAdapterIndex - the index of the adapter to use for this display

nVRSystem_GetOutputDevice

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

Unsafe version of: GetOutputDevice

VRSystem_GetOutputDevice

public static void VRSystem_GetOutputDevice(java.nio.LongBuffer pnDevice,
                                            int textureType,
                                            long 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. If an error occurs the device will be set to 0.

D3D10/11/12 Only (D3D9 Not Supported)

Returns the adapter LUID that identifies the GPU attached to the HMD. The user should enumerate all adapters using IDXGIFactory::EnumAdapters and IDXGIAdapter::GetDesc to find the adapter with the matching LUID, or use IDXGIFactory4::EnumAdapterByLuid. The discovered IDXGIAdapter should be used to create the device and swap chain.

Vulkan Only

Returns the VkPhysicalDevice that should be used by the application. pInstance must be the instance the application will use to query for the VkPhysicalDevice. The application must create the VkInstance with extensions returned by GetVulkanInstanceExtensionsRequired enabled.

macOS Only

For VR.ETextureType_TextureType_IOSurface returns the id<MTLDevice> that should be used by the application.

On 10.13+ for VR.ETextureType_TextureType_OpenGL returns the registryId of the renderer which should be used by the application. See Apple Technical Q&A QA1168 for information on enumerating GL Renderers, and the new kCGLRPRegistryIDLow and kCGLRPRegistryIDHigh CGLRendererProperty values in the 10.13 SDK.

Pre 10.13 for VR.ETextureType_TextureType_OpenGL returns 0, as there is no dependable way to correlate the HMDs MTLDevice with a GL Renderer.

Parameters:

textureType - one of:

VR.ETextureType_TextureType_Invalid	VR.ETextureType_TextureType_DirectX
VR.ETextureType_TextureType_OpenGL	VR.ETextureType_TextureType_Vulkan
VR.ETextureType_TextureType_IOSurface	VR.ETextureType_TextureType_DirectX12
VR.ETextureType_TextureType_DXGISharedHandle	VR.ETextureType_TextureType_Metal

pInstance - an optional parameter that is required only when textureType is VR.ETextureType_TextureType_Vulkan

VRSystem_IsDisplayOnDesktop

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).

VRSystem_SetDisplayVisibility

public static boolean VRSystem_SetDisplayVisibility(boolean bIsVisibleOnDesktop)

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

Parameters:

bIsVisibleOnDesktop - the display visibility

Returns:

true indicates that the change was successful

nVRSystem_GetDeviceToAbsoluteTrackingPose

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

Unsafe version of: GetDeviceToAbsoluteTrackingPose

VRSystem_GetDeviceToAbsoluteTrackingPose

public static void VRSystem_GetDeviceToAbsoluteTrackingPose(int eOrigin,
                                                            float 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. Pass 0 to get the state at the instant the method is called. Most of the time the application should calculate the time until the photons will be emitted from the display and pass that time into the method.

This is roughly analogous to the inverse of the view matrix in most applications, though many games will need to do some additional rotation or translation on top of the rotation and translation provided by the head pose.

For devices where bPoseIsValid is true the application can use the pose to position the device in question. The provided array can be any size up to VR.k_unMaxTrackedDeviceCount.

Seated experiences should call this method with VR.ETrackingUniverseOrigin_TrackingUniverseSeated and receive poses relative to the seated zero pose. Standing experiences should call this method with VR.ETrackingUniverseOrigin_TrackingUniverseStanding and receive poses relative to the Chaperone Play Area. VR.ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated should probably not be used unless the application is the Chaperone calibration tool itself, but will provide poses relative to the hardware-specific coordinate system in the driver.

Parameters:

eOrigin - tracking universe that returned poses should be relative to. One of:

VR.ETrackingUniverseOrigin_TrackingUniverseSeated

VR.ETrackingUniverseOrigin_TrackingUniverseStanding

VR.ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated

fPredictedSecondsToPhotonsFromNow - 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.

VRSystem_ResetSeatedZeroPose

public static void VRSystem_ResetSeatedZeroPose()

Sets the zero pose for the seated tracker coordinate system to the current position and yaw of the HMD. After ResetSeatedZeroPose all GetDeviceToAbsoluteTrackingPose calls that pass VR.ETrackingUniverseOrigin_TrackingUniverseSeated as the origin will be relative to this new zero pose. The new zero coordinate system will not change the fact that the Y axis is up in the real world, so the next pose returned from GetDeviceToAbsoluteTrackingPose after a call to ResetSeatedZeroPose may not be exactly an identity matrix.

NOTE: This function overrides the user's previously saved seated zero pose and should only be called as the result of a user action. Users are also able to set their seated zero pose via the OpenVR Dashboard.

nVRSystem_GetSeatedZeroPoseToStandingAbsoluteTrackingPose

public static void nVRSystem_GetSeatedZeroPoseToStandingAbsoluteTrackingPose(long __functionAddress,
                                                                             long __result)

public static void nVRSystem_GetSeatedZeroPoseToStandingAbsoluteTrackingPose(long __result)

Unsafe version of: GetSeatedZeroPoseToStandingAbsoluteTrackingPose

VRSystem_GetSeatedZeroPoseToStandingAbsoluteTrackingPose

public static HmdMatrix34 VRSystem_GetSeatedZeroPoseToStandingAbsoluteTrackingPose(HmdMatrix34 __result)

Returns the transform from the seated zero pose to the standing absolute tracking system. This allows applications to represent the seated origin to used or transform object positions from one coordinate system to the other.

The seated origin may or may not be inside the Play Area or Collision Bounds returned by IVRChaperone. Its position depends on what the user has set from the Dashboard settings and previous calls to ResetSeatedZeroPose.

nVRSystem_GetRawZeroPoseToStandingAbsoluteTrackingPose

public static void nVRSystem_GetRawZeroPoseToStandingAbsoluteTrackingPose(long __functionAddress,
                                                                          long __result)

public static void nVRSystem_GetRawZeroPoseToStandingAbsoluteTrackingPose(long __result)

Unsafe version of: GetRawZeroPoseToStandingAbsoluteTrackingPose

VRSystem_GetRawZeroPoseToStandingAbsoluteTrackingPose

public static HmdMatrix34 VRSystem_GetRawZeroPoseToStandingAbsoluteTrackingPose(HmdMatrix34 __result)

Returns the transform from the tracking origin to the standing absolute tracking system. This allows applications to convert from raw tracking space to the calibrated standing coordinate system.

nVRSystem_GetSortedTrackedDeviceIndicesOfClass

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

Unsafe version of: GetSortedTrackedDeviceIndicesOfClass

VRSystem_GetSortedTrackedDeviceIndicesOfClass

public static int VRSystem_GetSortedTrackedDeviceIndicesOfClass(int eTrackedDeviceClass,
                                                                @Nullable
                                                                java.nio.IntBuffer punTrackedDeviceIndexArray,
                                                                int unRelativeToTrackedDeviceIndex)

Get a sorted array of device indices of a given class of tracked devices (e.g. controllers). Devices are sorted right to left relative to the specified tracked device (default: hmd -- pass in -1 for absolute tracking space).

Parameters:

eTrackedDeviceClass - one of:

VR.ETrackedDeviceClass_TrackedDeviceClass_Invalid

VR.ETrackedDeviceClass_TrackedDeviceClass_HMD

VR.ETrackedDeviceClass_TrackedDeviceClass_Controller

VR.ETrackedDeviceClass_TrackedDeviceClass_GenericTracker

VR.ETrackedDeviceClass_TrackedDeviceClass_TrackingReference

VR.ETrackedDeviceClass_TrackedDeviceClass_DisplayRedirect

VR.ETrackedDeviceClass_TrackedDeviceClass_Max

Returns:

the number of devices in the list, or the size of the array needed if not large enough

VRSystem_GetTrackedDeviceActivityLevel

public static int VRSystem_GetTrackedDeviceActivityLevel(int unDeviceId)

Returns the level of activity on the device.

nVRSystem_ApplyTransform

public static void nVRSystem_ApplyTransform(long pOutputPose,
                                            long pTrackedDevicePose,
                                            long pTransform)

Unsafe version of: ApplyTransform

VRSystem_ApplyTransform

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

Convenience utility to apply the specified transform to the specified pose. This properly transforms all pose components, including velocity and angular velocity.

VRSystem_GetTrackedDeviceIndexForControllerRole

public static int VRSystem_GetTrackedDeviceIndexForControllerRole(int unDeviceType)

Returns the device index associated with a specific role, for example the left hand or the right hand.

This function is deprecated in favor of the new IVRInput system.

Parameters:

unDeviceType - one of:

VR.ETrackedControllerRole_TrackedControllerRole_Invalid

VR.ETrackedControllerRole_TrackedControllerRole_LeftHand

VR.ETrackedControllerRole_TrackedControllerRole_RightHand

VR.ETrackedControllerRole_TrackedControllerRole_OptOut

VR.ETrackedControllerRole_TrackedControllerRole_Treadmill

VR.ETrackedControllerRole_TrackedControllerRole_Max

VRSystem_GetControllerRoleForTrackedDeviceIndex

public static int VRSystem_GetControllerRoleForTrackedDeviceIndex(int unDeviceIndex)

Returns the controller type associated with a device index.

This function is deprecated in favor of the new IVRInput system.

VRSystem_GetTrackedDeviceClass

public static int VRSystem_GetTrackedDeviceClass(int unDeviceIndex)

Returns the device class of a tracked device. If there has not been a device connected in this slot since the application started this function will return VR.ETrackedDeviceClass_TrackedDeviceClass_Invalid. For previous detected devices the function will return the previously observed device class.

To determine which devices exist on the system, just loop from 0 to VR.k_unMaxTrackedDeviceCount and check the device class. Every device with something other than VR.ETrackedDeviceClass_TrackedDeviceClass_Invalid is associated with an actual tracked device.

Parameters:

unDeviceIndex - index of the device to get the device class for.

VRSystem_IsTrackedDeviceConnected

public static boolean VRSystem_IsTrackedDeviceConnected(int unDeviceIndex)

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

Parameters:

unDeviceIndex - index of the device to test connected state for

nVRSystem_GetBoolTrackedDeviceProperty

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

Unsafe version of: GetBoolTrackedDeviceProperty

VRSystem_GetBoolTrackedDeviceProperty

public static boolean VRSystem_GetBoolTrackedDeviceProperty(int unDeviceIndex,
                                                            int prop,
                                                            @Nullable
                                                            java.nio.IntBuffer pError)

Returns a bool property. If the device index is not valid or the property is not a bool type this function will return false.

Parameters:

unDeviceIndex - index of the device to get the property for

prop - which property to get

pError - 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.

nVRSystem_GetFloatTrackedDeviceProperty

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

Unsafe version of: GetFloatTrackedDeviceProperty

VRSystem_GetFloatTrackedDeviceProperty

public static float VRSystem_GetFloatTrackedDeviceProperty(int unDeviceIndex,
                                                           int prop,
                                                           @Nullable
                                                           java.nio.IntBuffer pError)

Returns a float property. If the device index is not valid or the property is not a float type this function will return 0.

Parameters:

unDeviceIndex - index of the device to get the property for

prop - which property to get

pError - 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.

nVRSystem_GetInt32TrackedDeviceProperty

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

Unsafe version of: GetInt32TrackedDeviceProperty

VRSystem_GetInt32TrackedDeviceProperty

public static int VRSystem_GetInt32TrackedDeviceProperty(int unDeviceIndex,
                                                         int prop,
                                                         @Nullable
                                                         java.nio.IntBuffer pError)

Returns an int property. If the device index is not valid or the property is not a int type this function will return 0.

Parameters:

unDeviceIndex - index of the device to get the property for

prop - which property to get

pError - 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.

nVRSystem_GetUint64TrackedDeviceProperty

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

Unsafe version of: GetUint64TrackedDeviceProperty

VRSystem_GetUint64TrackedDeviceProperty

public static long VRSystem_GetUint64TrackedDeviceProperty(int unDeviceIndex,
                                                           int prop,
                                                           @Nullable
                                                           java.nio.IntBuffer pError)

Returns a uint64 property. If the device index is not valid or the property is not a uint64 type this function will return 0.

Parameters:

unDeviceIndex - index of the device to get the property for

prop - which property to get

pError - 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.

nVRSystem_GetMatrix34TrackedDeviceProperty

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

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

Unsafe version of: GetMatrix34TrackedDeviceProperty

VRSystem_GetMatrix34TrackedDeviceProperty

public static HmdMatrix34 VRSystem_GetMatrix34TrackedDeviceProperty(int unDeviceIndex,
                                                                    int prop,
                                                                    @Nullable
                                                                    java.nio.IntBuffer pError,
                                                                    HmdMatrix34 __result)

Returns a matrix property. If the device index is not valid or the property is not a matrix type, this function will return identity.

Parameters:

unDeviceIndex - index of the device to get the property for

prop - which property to get

pError - 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.

nVRSystem_GetArrayTrackedDeviceProperty

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

Unsafe version of: GetArrayTrackedDeviceProperty

VRSystem_GetArrayTrackedDeviceProperty

public static int VRSystem_GetArrayTrackedDeviceProperty(int unDeviceIndex,
                                                         int prop,
                                                         int propType,
                                                         @Nullable
                                                         java.nio.ByteBuffer pBuffer,
                                                         @Nullable
                                                         java.nio.IntBuffer pError)

Returns an array of one type of property.

If the device index is not valid or the property is not a single value or an array of the specified type, this function will return 0. Otherwise it returns the number of bytes necessary to hold the array of properties. If unBufferSize is greater than the returned size and pBuffer is non-NULL, pBuffer is filled with the contents of array of properties.

Parameters:

unDeviceIndex - index of the device to get the property for

prop - which property to get

pError - 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.

nVRSystem_GetStringTrackedDeviceProperty

public static int nVRSystem_GetStringTrackedDeviceProperty(int unDeviceIndex,
                                                           int prop,
                                                           long pchValue,
                                                           int unBufferSize,
                                                           long pError)

Unsafe version of: GetStringTrackedDeviceProperty

Parameters:

unBufferSize - the size of the buffer pointed to by pchValue

VRSystem_GetStringTrackedDeviceProperty

public static int VRSystem_GetStringTrackedDeviceProperty(int unDeviceIndex,
                                                          int prop,
                                                          @Nullable
                                                          java.nio.ByteBuffer pchValue,
                                                          @Nullable
                                                          java.nio.IntBuffer pError)

Returns a string property. If the device index is not valid or the property is not a string type this function will return 0. Otherwise it returns the length of the number of bytes necessary to hold this string including the trailing null. Strings will always fit in buffers of VR.k_unMaxPropertyStringSize characters.

Parameters:

unDeviceIndex - index of the device to get the property for

prop - which property to get

pchValue - the buffer to store string properties in. unBufferSize should be the size of this buffer.

pError - 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.

VRSystem_GetStringTrackedDeviceProperty

public static java.lang.String VRSystem_GetStringTrackedDeviceProperty(int unDeviceIndex,
                                                                       int prop,
                                                                       int unBufferSize,
                                                                       @Nullable
                                                                       java.nio.IntBuffer pError)

Returns a string property. If the device index is not valid or the property is not a string type this function will return 0. Otherwise it returns the length of the number of bytes necessary to hold this string including the trailing null. Strings will always fit in buffers of VR.k_unMaxPropertyStringSize characters.

Parameters:

unDeviceIndex - index of the device to get the property for

prop - which property to get

unBufferSize - the size of the buffer pointed to by pchValue

pError - 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.

VRSystem_GetStringTrackedDeviceProperty

public static java.lang.String VRSystem_GetStringTrackedDeviceProperty(int unDeviceIndex,
                                                                       int prop,
                                                                       @Nullable
                                                                       java.nio.IntBuffer pError)

Returns a string property. If the device index is not valid or the property is not a string type this function will return 0. Otherwise it returns the length of the number of bytes necessary to hold this string including the trailing null. Strings will always fit in buffers of VR.k_unMaxPropertyStringSize characters.

Parameters:

unDeviceIndex - index of the device to get the property for

prop - which property to get

pError - 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.

nVRSystem_GetPropErrorNameFromEnum

public static long nVRSystem_GetPropErrorNameFromEnum(int error)

Unsafe version of: GetPropErrorNameFromEnum

VRSystem_GetPropErrorNameFromEnum

@Nullable
public static java.lang.String VRSystem_GetPropErrorNameFromEnum(int error)

Returns a string that corresponds with the specified property error. The string will be the name of the error enum value for all valid error codes.

Parameters:

error - the error code to return a string for. One of:

VR.ETrackedPropertyError_TrackedProp_Success

VR.ETrackedPropertyError_TrackedProp_WrongDataType

VR.ETrackedPropertyError_TrackedProp_WrongDeviceClass

VR.ETrackedPropertyError_TrackedProp_BufferTooSmall

VR.ETrackedPropertyError_TrackedProp_UnknownProperty

VR.ETrackedPropertyError_TrackedProp_InvalidDevice

VR.ETrackedPropertyError_TrackedProp_CouldNotContactServer

VR.ETrackedPropertyError_TrackedProp_ValueNotProvidedByDevice

VR.ETrackedPropertyError_TrackedProp_StringExceedsMaximumLength

VR.ETrackedPropertyError_TrackedProp_NotYetAvailable

VR.ETrackedPropertyError_TrackedProp_PermissionDenied

VR.ETrackedPropertyError_TrackedProp_InvalidOperation

VR.ETrackedPropertyError_TrackedProp_CannotWriteToWildcards

VR.ETrackedPropertyError_TrackedProp_IPCReadFailure

nVRSystem_PollNextEvent

public static boolean nVRSystem_PollNextEvent(long pEvent,
                                              int uncbVREvent)

Unsafe version of: PollNextEvent

VRSystem_PollNextEvent

public static boolean VRSystem_PollNextEvent(VREvent pEvent,
                                             int uncbVREvent)

Returns true and fills the event with the next event on the queue if there is one. If there are no events this method returns false.

Parameters:

pEvent - an event structure to fill with the next event

uncbVREvent - the size in bytes of the VREvent struct

VRSystem_PollNextEvent

public static boolean VRSystem_PollNextEvent(VREvent pEvent)

Returns true and fills the event with the next event on the queue if there is one. If there are no events this method returns false.

Parameters:

pEvent - an event structure to fill with the next event

nVRSystem_PollNextEventWithPose

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

Unsafe version of: PollNextEventWithPose

VRSystem_PollNextEventWithPose

public static boolean VRSystem_PollNextEventWithPose(int eOrigin,
                                                     VREvent pEvent,
                                                     int uncbVREvent,
                                                     TrackedDevicePose pTrackedDevicePose)

Returns true and fills the event with the next event on the queue if there is one. If there are no events this method returns false. Fills in the pose of the associated tracked device in the provided pose struct. This pose will always be older than the call to this function and should not be used to render the device.

Parameters:

eOrigin - the tracking system to return the event's pose in. One of:

VR.ETrackingUniverseOrigin_TrackingUniverseSeated

VR.ETrackingUniverseOrigin_TrackingUniverseStanding

VR.ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated

pEvent - an event structure to fill with the next event

uncbVREvent - the size in bytes of the VREvent struct

pTrackedDevicePose - a pose struct to fill with the returned event's pose. Must not be NULL.

VRSystem_PollNextEventWithPose

public static boolean VRSystem_PollNextEventWithPose(int eOrigin,
                                                     VREvent pEvent,
                                                     TrackedDevicePose pTrackedDevicePose)

Returns true and fills the event with the next event on the queue if there is one. If there are no events this method returns false. Fills in the pose of the associated tracked device in the provided pose struct. This pose will always be older than the call to this function and should not be used to render the device.

Parameters:

eOrigin - the tracking system to return the event's pose in. One of:

VR.ETrackingUniverseOrigin_TrackingUniverseSeated

VR.ETrackingUniverseOrigin_TrackingUniverseStanding

VR.ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated

pEvent - an event structure to fill with the next event

pTrackedDevicePose - a pose struct to fill with the returned event's pose. Must not be NULL.

nVRSystem_GetEventTypeNameFromEnum

public static long nVRSystem_GetEventTypeNameFromEnum(int eType)

Unsafe version of: GetEventTypeNameFromEnum

VRSystem_GetEventTypeNameFromEnum

@Nullable
public static java.lang.String VRSystem_GetEventTypeNameFromEnum(int eType)

Returns the name of an EVREvent enum value.

Parameters:

eType - 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_DualAnalog_Press

VR.EVREventType_VREvent_DualAnalog_Unpress

VR.EVREventType_VREvent_DualAnalog_Touch

VR.EVREventType_VREvent_DualAnalog_Untouch

VR.EVREventType_VREvent_DualAnalog_Move

VR.EVREventType_VREvent_DualAnalog_ModeSwitch1

VR.EVREventType_VREvent_DualAnalog_ModeSwitch2

VR.EVREventType_VREvent_DualAnalog_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_InputFocusCaptured

VR.EVREventType_VREvent_InputFocusReleased

VR.EVREventType_VREvent_SceneFocusLost

VR.EVREventType_VREvent_SceneFocusGained

VR.EVREventType_VREvent_SceneApplicationChanged

VR.EVREventType_VREvent_SceneFocusChanged

VR.EVREventType_VREvent_InputFocusChanged

VR.EVREventType_VREvent_SceneApplicationSecondaryRenderingStarted

VR.EVREventType_VREvent_SceneApplicationUsingWrongGraphicsAdapter

VR.EVREventType_VREvent_ActionBindingReloaded

VR.EVREventType_VREvent_HideRenderModels

VR.EVREventType_VREvent_ShowRenderModels

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_RenderToast

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_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_QuitAborted_UserPrompt

VR.EVREventType_VREvent_QuitAcknowledged

VR.EVREventType_VREvent_DriverRequestedQuit

VR.EVREventType_VREvent_RestartRequested

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_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_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_ApplicationTransitionStarted

VR.EVREventType_VREvent_ApplicationTransitionAborted

VR.EVREventType_VREvent_ApplicationTransitionNewAppStarted

VR.EVREventType_VREvent_ApplicationListUpdated

VR.EVREventType_VREvent_ApplicationMimeTypeLoad

VR.EVREventType_VREvent_ApplicationTransitionNewAppLaunchComplete

VR.EVREventType_VREvent_ProcessConnected

VR.EVREventType_VREvent_ProcessDisconnected

VR.EVREventType_VREvent_Compositor_MirrorWindowShown

VR.EVREventType_VREvent_Compositor_MirrorWindowHidden

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_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_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_VendorSpecific_Reserved_Start

VR.EVREventType_VREvent_VendorSpecific_Reserved_End

nVRSystem_GetHiddenAreaMesh

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

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

Unsafe version of: GetHiddenAreaMesh

VRSystem_GetHiddenAreaMesh

public static HiddenAreaMesh VRSystem_GetHiddenAreaMesh(int eEye,
                                                        int type,
                                                        HiddenAreaMesh __result)

Returns the hidden area mesh for the current HMD. The pixels covered by this mesh will never be seen by the user after the lens distortion is applied based on visibility to the panels. If this HMD does not have a hidden area mesh, the vertex data and count will be NULL and 0 respectively.

This mesh is meant to be rendered into the stencil buffer (or into the depth buffer setting nearz) before rendering each eye's view. This will improve performance by letting the GPU early-reject pixels the user will never see before running the pixel shader.

Note

Render this mesh with backface culling disabled since the winding order of the vertices can be different per-HMD or per-eye.

Parameters:

eEye - the eye to get the hidden area mesh for. One of:

VR.EVREye_Eye_Left

VR.EVREye_Eye_Right

type - one of:

VR.EHiddenAreaMeshType_k_eHiddenAreaMesh_Standard

VR.EHiddenAreaMeshType_k_eHiddenAreaMesh_Inverse

VR.EHiddenAreaMeshType_k_eHiddenAreaMesh_LineLoop

VR.EHiddenAreaMeshType_k_eHiddenAreaMesh_Max

nVRSystem_GetControllerState

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

Unsafe version of: GetControllerState

VRSystem_GetControllerState

public static boolean VRSystem_GetControllerState(int unControllerDeviceIndex,
                                                  VRControllerState pControllerState,
                                                  int unControllerStateSize)

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

This function is deprecated in favor of the new IVRInput system.

Parameters:

unControllerDeviceIndex - the tracked device index of the controller to get the state of

pControllerState - a struct to fill with the controller state

unControllerStateSize - the size in bytes of the VRControllerState struct

Returns:

false if the controller index is invalid

VRSystem_GetControllerState

public static boolean VRSystem_GetControllerState(int unControllerDeviceIndex,
                                                  VRControllerState pControllerState)

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

This function is deprecated in favor of the new IVRInput system.

Parameters:

unControllerDeviceIndex - the tracked device index of the controller to get the state of

pControllerState - a struct to fill with the controller state

Returns:

false if the controller index is invalid

nVRSystem_GetControllerStateWithPose

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

Unsafe version of: GetControllerStateWithPose

VRSystem_GetControllerStateWithPose

public static boolean VRSystem_GetControllerStateWithPose(int eOrigin,
                                                          int unControllerDeviceIndex,
                                                          VRControllerState pControllerState,
                                                          int unControllerStateSize,
                                                          TrackedDevicePose 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. Use this form if you need a precise controller pose as input to your application when the user presses or releases a button.

This function is deprecated in favor of the new IVRInput system.

Parameters:

eOrigin - the tracking coordinate system to return the pose in. One of:

VR.ETrackingUniverseOrigin_TrackingUniverseSeated

VR.ETrackingUniverseOrigin_TrackingUniverseStanding

VR.ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated

unControllerDeviceIndex - the tracked device index of the controller to get the state of

pControllerState - a struct to fill with the controller state

unControllerStateSize - the size in bytes of the VRControllerState struct

pTrackedDevicePose - a pose struct to fill with the pose of the controller when the last button event occurred

VRSystem_GetControllerStateWithPose

public static boolean VRSystem_GetControllerStateWithPose(int eOrigin,
                                                          int unControllerDeviceIndex,
                                                          VRControllerState pControllerState,
                                                          TrackedDevicePose 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. Use this form if you need a precise controller pose as input to your application when the user presses or releases a button.

This function is deprecated in favor of the new IVRInput system.

Parameters:

eOrigin - the tracking coordinate system to return the pose in. One of:

VR.ETrackingUniverseOrigin_TrackingUniverseSeated

VR.ETrackingUniverseOrigin_TrackingUniverseStanding

VR.ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated

unControllerDeviceIndex - the tracked device index of the controller to get the state of

pControllerState - a struct to fill with the controller state

pTrackedDevicePose - a pose struct to fill with the pose of the controller when the last button event occurred

VRSystem_TriggerHapticPulse

public static void VRSystem_TriggerHapticPulse(int unControllerDeviceIndex,
                                               int unAxisId,
                                               short usDurationMicroSec)

Trigger a single haptic pulse on a controller. After this call the application may not trigger another haptic pulse on this controller and axis combination for 5ms.

This function is deprecated in favor of the new IVRInput system.

Parameters:

unControllerDeviceIndex - the tracked device index of the controller to trigger a haptic pulse on

unAxisId - the ID of the axis to trigger a haptic pulse on

usDurationMicroSec - the duration of the desired haptic pulse in microseconds

nVRSystem_GetButtonIdNameFromEnum

public static long nVRSystem_GetButtonIdNameFromEnum(int eButtonId)

Unsafe version of: GetButtonIdNameFromEnum

VRSystem_GetButtonIdNameFromEnum

@Nullable
public static java.lang.String VRSystem_GetButtonIdNameFromEnum(int eButtonId)

Returns the name of an EVRButtonId enum value.

This function is deprecated in favor of the new IVRInput system.

Parameters:

eButtonId - the button ID to return the name of. One of:

VR.EVRButtonId_k_EButton_System	VR.EVRButtonId_k_EButton_ApplicationMenu
VR.EVRButtonId_k_EButton_Grip	VR.EVRButtonId_k_EButton_DPad_Left
VR.EVRButtonId_k_EButton_DPad_Up	VR.EVRButtonId_k_EButton_DPad_Right
VR.EVRButtonId_k_EButton_DPad_Down	VR.EVRButtonId_k_EButton_A
VR.EVRButtonId_k_EButton_ProximitySensor	VR.EVRButtonId_k_EButton_Axis0
VR.EVRButtonId_k_EButton_Axis1	VR.EVRButtonId_k_EButton_Axis2
VR.EVRButtonId_k_EButton_Axis3	VR.EVRButtonId_k_EButton_Axis4
VR.EVRButtonId_k_EButton_SteamVR_Touchpad	VR.EVRButtonId_k_EButton_SteamVR_Trigger
VR.EVRButtonId_k_EButton_Dashboard_Back	VR.EVRButtonId_k_EButton_IndexController_A
VR.EVRButtonId_k_EButton_IndexController_B	VR.EVRButtonId_k_EButton_IndexController_JoyStick
VR.EVRButtonId_k_EButton_Max

nVRSystem_GetControllerAxisTypeNameFromEnum

public static long nVRSystem_GetControllerAxisTypeNameFromEnum(int eAxisType)

Unsafe version of: GetControllerAxisTypeNameFromEnum

VRSystem_GetControllerAxisTypeNameFromEnum

@Nullable
public static java.lang.String VRSystem_GetControllerAxisTypeNameFromEnum(int eAxisType)

Returns the name of an EVRControllerAxisType enum value.

Parameters:

eAxisType - the controller axis type to get a name for. One of:

VR.EVRControllerAxisType_k_eControllerAxis_None

VR.EVRControllerAxisType_k_eControllerAxis_TrackPad

VR.EVRControllerAxisType_k_eControllerAxis_Joystick

VR.EVRControllerAxisType_k_eControllerAxis_Trigger

VRSystem_IsInputAvailable

public static boolean VRSystem_IsInputAvailable()

Returns true if this application is receiving input from the system. This would return false if system-related functionality is consuming the input stream.

VRSystem_IsSteamVRDrawingControllers

public static boolean VRSystem_IsSteamVRDrawingControllers()

Returns true if SteamVR is drawing controllers on top of the application. Applications should consider not drawing anything attached to the user's hands in this case.

VRSystem_ShouldApplicationPause

public static boolean VRSystem_ShouldApplicationPause()

Returns true if the user has put SteamVR into a mode that is distracting them from the application. For applications where this is appropriate, the application should pause ongoing activity.

VRSystem_ShouldApplicationReduceRenderingWork

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. One common way to do this is to reduce the size of the render target provided for each eye.

VRSystem_PerformFirmwareUpdate

public static int VRSystem_PerformFirmwareUpdate(int unDeviceIndex)

Performs the actual firmware update if applicable.

The following events will be sent, if VR.EVRFirmwareError_VRFirmwareError_None was returned: VR.EVREventType_VREvent_FirmwareUpdateStarted, VR.EVREventType_VREvent_FirmwareUpdateFinished

Use the properties VR.ETrackedDeviceProperty_Prop_Firmware_UpdateAvailable_Bool, VR.ETrackedDeviceProperty_Prop_Firmware_ManualUpdate_Bool, and VR.ETrackedDeviceProperty_Prop_Firmware_ManualUpdateURL_String to figure our whether a firmware update is available, and to figure out whether its a manual update. VR.ETrackedDeviceProperty_Prop_Firmware_ManualUpdateURL_String should point to an URL describing the manual update process.

VRSystem_AcknowledgeQuit_Exiting

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. This extends the timeout until the process is killed.

VRSystem_AcknowledgeQuit_UserPrompt

public static void VRSystem_AcknowledgeQuit_UserPrompt()

Call this to tell the system that the user is being prompted to save data. This halts the timeout and dismisses the dashboard (if it was up). Applications should be sure to actually prompt the user to save and then exit afterward, otherwise the user will be left in a confusing state.

nVRSystem_GetAppContainerFilePaths

public static int nVRSystem_GetAppContainerFilePaths(long pchBuffer,
                                                     int unBufferSize)

Unsafe version of: GetAppContainerFilePaths

VRSystem_GetAppContainerFilePaths

public static int VRSystem_GetAppContainerFilePaths(@Nullable
                                                    java.nio.ByteBuffer pchBuffer)

public static java.lang.String 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.

Returns:

the number of bytes needed to hold the list