vr::IVRSystem Class Reference

#include <openvr_mingw.h>

Public Member Functions
void	GetRecommendedRenderTargetSize (uint32_t *pnWidth, uint32_t *pnHeight)
HmdMatrix44_t	GetProjectionMatrix (EVREye eEye, float fNearZ, float fFarZ)
void	GetProjectionRaw (EVREye eEye, float *pfLeft, float *pfRight, float *pfTop, float *pfBottom)
bool	ComputeDistortion (EVREye eEye, float fU, float fV, DistortionCoordinates_t *pDistortionCoordinates)
HmdMatrix34_t	GetEyeToHeadTransform (EVREye eEye)
bool	GetTimeSinceLastVsync (float *pfSecondsSinceLastVsync, uint64_t *pulFrameCounter)
int32_t	GetD3D9AdapterIndex ()
void	GetDXGIOutputInfo (int32_t *pnAdapterIndex)
void	GetOutputDevice (uint64_t *pnDevice, ETextureType textureType, VkInstance_T *pInstance=nullptr)
bool	IsDisplayOnDesktop ()
bool	SetDisplayVisibility (bool bIsVisibleOnDesktop)
void	GetDeviceToAbsoluteTrackingPose (ETrackingUniverseOrigin eOrigin, float fPredictedSecondsToPhotonsFromNow, VR_ARRAY_COUNT(unTrackedDevicePoseArrayCount) TrackedDevicePose_t *pTrackedDevicePoseArray, uint32_t unTrackedDevicePoseArrayCount)
void	ResetSeatedZeroPose ()
HmdMatrix34_t	GetSeatedZeroPoseToStandingAbsoluteTrackingPose ()
HmdMatrix34_t	GetRawZeroPoseToStandingAbsoluteTrackingPose ()
uint32_t	GetSortedTrackedDeviceIndicesOfClass (ETrackedDeviceClass eTrackedDeviceClass, VR_ARRAY_COUNT(unTrackedDeviceIndexArrayCount) vr::TrackedDeviceIndex_t *punTrackedDeviceIndexArray, uint32_t unTrackedDeviceIndexArrayCount, vr::TrackedDeviceIndex_t unRelativeToTrackedDeviceIndex=k_unTrackedDeviceIndex_Hmd)
EDeviceActivityLevel	GetTrackedDeviceActivityLevel (vr::TrackedDeviceIndex_t unDeviceId)
void	ApplyTransform (TrackedDevicePose_t *pOutputPose, const TrackedDevicePose_t *pTrackedDevicePose, const HmdMatrix34_t *pTransform)
vr::TrackedDeviceIndex_t	GetTrackedDeviceIndexForControllerRole (vr::ETrackedControllerRole unDeviceType)
vr::ETrackedControllerRole	GetControllerRoleForTrackedDeviceIndex (vr::TrackedDeviceIndex_t unDeviceIndex)
ETrackedDeviceClass	GetTrackedDeviceClass (vr::TrackedDeviceIndex_t unDeviceIndex)
bool	IsTrackedDeviceConnected (vr::TrackedDeviceIndex_t unDeviceIndex)
bool	GetBoolTrackedDeviceProperty (vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError *pError=0L)
float	GetFloatTrackedDeviceProperty (vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError *pError=0L)
int32_t	GetInt32TrackedDeviceProperty (vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError *pError=0L)
uint64_t	GetUint64TrackedDeviceProperty (vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError *pError=0L)
HmdMatrix34_t	GetMatrix34TrackedDeviceProperty (vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError *pError=0L)
uint32_t	GetArrayTrackedDeviceProperty (vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, PropertyTypeTag_t propType, void *pBuffer, uint32_t unBufferSize, ETrackedPropertyError *pError=0L)
uint32_t	GetStringTrackedDeviceProperty (vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, VR_OUT_STRING() char *pchValue, uint32_t unBufferSize, ETrackedPropertyError *pError=0L)
const char *	GetPropErrorNameFromEnum (ETrackedPropertyError error)
bool	PollNextEvent (VREvent_t *pEvent, uint32_t uncbVREvent)
bool	PollNextEventWithPose (ETrackingUniverseOrigin eOrigin, VREvent_t *pEvent, uint32_t uncbVREvent, vr::TrackedDevicePose_t *pTrackedDevicePose)
const char *	GetEventTypeNameFromEnum (EVREventType eType)
HiddenAreaMesh_t	GetHiddenAreaMesh (EVREye eEye, EHiddenAreaMeshType type=k_eHiddenAreaMesh_Standard)
bool	GetControllerState (vr::TrackedDeviceIndex_t unControllerDeviceIndex, vr::VRControllerState_t *pControllerState, uint32_t unControllerStateSize)
bool	GetControllerStateWithPose (ETrackingUniverseOrigin eOrigin, vr::TrackedDeviceIndex_t unControllerDeviceIndex, vr::VRControllerState_t *pControllerState, uint32_t unControllerStateSize, TrackedDevicePose_t *pTrackedDevicePose)
void	TriggerHapticPulse (vr::TrackedDeviceIndex_t unControllerDeviceIndex, uint32_t unAxisId, unsigned short usDurationMicroSec)
const char *	GetButtonIdNameFromEnum (EVRButtonId eButtonId)
const char *	GetControllerAxisTypeNameFromEnum (EVRControllerAxisType eAxisType)
bool	IsInputAvailable ()
bool	IsSteamVRDrawingControllers ()
bool	ShouldApplicationPause ()
bool	ShouldApplicationReduceRenderingWork ()
uint32_t	DriverDebugRequest (vr::TrackedDeviceIndex_t unDeviceIndex, const char *pchRequest, VR_OUT_STRING() char *pchResponseBuffer, uint32_t unResponseBufferSize)
vr::EVRFirmwareError	PerformFirmwareUpdate (vr::TrackedDeviceIndex_t unDeviceIndex)
void	AcknowledgeQuit_Exiting ()
void	AcknowledgeQuit_UserPrompt ()

Member Function Documentation

AcknowledgeQuit_Exiting()

void vr::IVRSystem::AcknowledgeQuit_Exiting ( )

inline

Call this to acknowledge to the system that VREvent_Quit has been received and that the process is exiting. This extends the timeout until the process is killed.

AcknowledgeQuit_UserPrompt()

void vr::IVRSystem::AcknowledgeQuit_UserPrompt ( )

inline

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.

ApplyTransform()

void vr::IVRSystem::ApplyTransform ( TrackedDevicePose_t * pOutputPose, const TrackedDevicePose_t * pTrackedDevicePose, const HmdMatrix34_t * pTransform )

inline

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

ComputeDistortion()

bool vr::IVRSystem::ComputeDistortion ( EVREye eEye, float fU, float fV, DistortionCoordinates_t * pDistortionCoordinates )

inline

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. Returns true for success. Otherwise, returns false, and distortion coordinates are not suitable.

DriverDebugRequest()

uint32_t vr::IVRSystem::DriverDebugRequest ( vr::TrackedDeviceIndex_t unDeviceIndex, const char * pchRequest, VR_OUT_STRING() char * pchResponseBuffer, uint32_t unResponseBufferSize )

inline

Sends a request to the driver for the specified device and returns the response. The maximum response size is 32k, but this method can be called with a smaller buffer. If the response exceeds the size of the buffer, it is truncated. The size of the response including its terminating null is returned.

GetArrayTrackedDeviceProperty()

uint32_t vr::IVRSystem::GetArrayTrackedDeviceProperty ( vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, PropertyTypeTag_t propType, void * pBuffer, uint32_t unBufferSize, ETrackedPropertyError * pError = 0L )

inline

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.

GetBoolTrackedDeviceProperty()

bool vr::IVRSystem::GetBoolTrackedDeviceProperty ( vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError * pError = 0L )

inline

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

GetButtonIdNameFromEnum()

const char * vr::IVRSystem::GetButtonIdNameFromEnum ( EVRButtonId eButtonId )

inline

returns the name of an EVRButtonId enum value

GetControllerAxisTypeNameFromEnum()

const char * vr::IVRSystem::GetControllerAxisTypeNameFromEnum ( EVRControllerAxisType eAxisType )

inline

returns the name of an EVRControllerAxisType enum value

GetControllerRoleForTrackedDeviceIndex()

vr::ETrackedControllerRole vr::IVRSystem::GetControllerRoleForTrackedDeviceIndex ( vr::TrackedDeviceIndex_t unDeviceIndex )

inline

Returns the controller type associated with a device index.

GetControllerState()

bool vr::IVRSystem::GetControllerState ( vr::TrackedDeviceIndex_t unControllerDeviceIndex, vr::VRControllerState_t * pControllerState, uint32_t unControllerStateSize )

inline

Fills the supplied struct with the current state of the controller. Returns false if the controller index is invalid.

GetControllerStateWithPose()

bool vr::IVRSystem::GetControllerStateWithPose ( ETrackingUniverseOrigin eOrigin, vr::TrackedDeviceIndex_t unControllerDeviceIndex, vr::VRControllerState_t * pControllerState, uint32_t unControllerStateSize, TrackedDevicePose_t * pTrackedDevicePose )

inline

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.

GetD3D9AdapterIndex()

int32_t vr::IVRSystem::GetD3D9AdapterIndex ( )

inline

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

GetDeviceToAbsoluteTrackingPose()

void vr::IVRSystem::GetDeviceToAbsoluteTrackingPose ( ETrackingUniverseOrigin eOrigin, float fPredictedSecondsToPhotonsFromNow, VR_ARRAY_COUNT(unTrackedDevicePoseArrayCount) TrackedDevicePose_t * pTrackedDevicePoseArray, uint32_t unTrackedDevicePoseArrayCount )

inline

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

Seated experiences should call this method with TrackingUniverseSeated and receive poses relative to the seated zero pose. Standing experiences should call this method with TrackingUniverseStanding and receive poses relative to the Chaperone Play Area. 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.

GetDXGIOutputInfo()

void vr::IVRSystem::GetDXGIOutputInfo ( int32_t * pnAdapterIndex )

inline

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

GetEventTypeNameFromEnum()

const char * vr::IVRSystem::GetEventTypeNameFromEnum ( EVREventType eType )

inline

returns the name of an EVREvent enum value

GetEyeToHeadTransform()

HmdMatrix34_t vr::IVRSystem::GetEyeToHeadTransform ( EVREye eEye )

inline

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.

GetFloatTrackedDeviceProperty()

float vr::IVRSystem::GetFloatTrackedDeviceProperty ( vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError * pError = 0L )

inline

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

GetHiddenAreaMesh()

HiddenAreaMesh_t vr::IVRSystem::GetHiddenAreaMesh ( EVREye eEye, EHiddenAreaMeshType type = k_eHiddenAreaMesh_Standard )

inline

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. Setting the bInverse argument to true will produce the visible area mesh that is commonly used in place of full-screen quads. The visible area mesh covers all of the pixels the hidden area mesh does not cover. Setting the bLineLoop argument will return a line loop of vertices in HiddenAreaMesh_t->pVertexData with HiddenAreaMesh_t->unTriangleCount set to the number of vertices.

GetInt32TrackedDeviceProperty()

int32_t vr::IVRSystem::GetInt32TrackedDeviceProperty ( vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError * pError = 0L )

inline

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

GetMatrix34TrackedDeviceProperty()

HmdMatrix34_t vr::IVRSystem::GetMatrix34TrackedDeviceProperty ( vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError * pError = 0L )

inline

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

GetOutputDevice()

void vr::IVRSystem::GetOutputDevice ( uint64_t * pnDevice, ETextureType textureType, VkInstance_T * pInstance = nullptr )

inline

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. pInstance is an optional parameter that is required only when textureType is TextureType_Vulkan. [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 IVRCompositor::GetVulkanInstanceExtensionsRequired enabled. [macOS Only] For TextureType_IOSurface returns the id<MTLDevice> that should be used by the application. On 10.13+ for 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 TextureType_OpenGL returns 0, as there is no dependable way to correlate the HMDs MTLDevice with a GL Renderer.

GetProjectionMatrix()

HmdMatrix44_t vr::IVRSystem::GetProjectionMatrix ( EVREye eEye, float fNearZ, float fFarZ )

inline

The projection matrix for the specified eye

GetProjectionRaw()

void vr::IVRSystem::GetProjectionRaw ( EVREye eEye, float * pfLeft, float * pfRight, float * pfTop, float * pfBottom )

inline

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

GetPropErrorNameFromEnum()

const char * vr::IVRSystem::GetPropErrorNameFromEnum ( ETrackedPropertyError error )

inline

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

GetRawZeroPoseToStandingAbsoluteTrackingPose()

HmdMatrix34_t vr::IVRSystem::GetRawZeroPoseToStandingAbsoluteTrackingPose ( )

inline

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.

GetRecommendedRenderTargetSize()

void vr::IVRSystem::GetRecommendedRenderTargetSize ( uint32_t * pnWidth, uint32_t * pnHeight )

inline

Suggested size for the intermediate render target that the distortion pulls from.

GetSeatedZeroPoseToStandingAbsoluteTrackingPose()

HmdMatrix34_t vr::IVRSystem::GetSeatedZeroPoseToStandingAbsoluteTrackingPose ( )

inline

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.

GetSortedTrackedDeviceIndicesOfClass()

uint32_t vr::IVRSystem::GetSortedTrackedDeviceIndicesOfClass ( ETrackedDeviceClass eTrackedDeviceClass, VR_ARRAY_COUNT(unTrackedDeviceIndexArrayCount) vr::TrackedDeviceIndex_t * punTrackedDeviceIndexArray, uint32_t unTrackedDeviceIndexArrayCount, vr::TrackedDeviceIndex_t unRelativeToTrackedDeviceIndex = k_unTrackedDeviceIndex_Hmd )

inline

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). Returns the number of devices in the list, or the size of the array needed if not large enough.

GetStringTrackedDeviceProperty()

uint32_t vr::IVRSystem::GetStringTrackedDeviceProperty ( vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, VR_OUT_STRING() char * pchValue, uint32_t unBufferSize, ETrackedPropertyError * pError = 0L )

inline

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 k_unMaxPropertyStringSize characters.

GetTimeSinceLastVsync()

bool vr::IVRSystem::GetTimeSinceLastVsync ( float * pfSecondsSinceLastVsync, uint64_t * pulFrameCounter )

inline

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. If no vsync times are available the function will return zero for vsync time and frame counter and return false from the method.

GetTrackedDeviceActivityLevel()

EDeviceActivityLevel vr::IVRSystem::GetTrackedDeviceActivityLevel ( vr::TrackedDeviceIndex_t unDeviceId )

inline

Returns the level of activity on the device.

GetTrackedDeviceClass()

ETrackedDeviceClass vr::IVRSystem::GetTrackedDeviceClass ( vr::TrackedDeviceIndex_t unDeviceIndex )

inline

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 TrackedDevice_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 k_unMaxTrackedDeviceCount and check the device class. Every device with something other than TrackedDevice_Invalid is associated with an actual tracked device.

GetTrackedDeviceIndexForControllerRole()

vr::TrackedDeviceIndex_t vr::IVRSystem::GetTrackedDeviceIndexForControllerRole ( vr::ETrackedControllerRole unDeviceType )

inline

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

GetUint64TrackedDeviceProperty()

uint64_t vr::IVRSystem::GetUint64TrackedDeviceProperty ( vr::TrackedDeviceIndex_t unDeviceIndex, ETrackedDeviceProperty prop, ETrackedPropertyError * pError = 0L )

inline

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

IsDisplayOnDesktop()

bool vr::IVRSystem::IsDisplayOnDesktop ( )

inline

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

IsInputAvailable()

bool vr::IVRSystem::IsInputAvailable ( )

inline

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

IsSteamVRDrawingControllers()

bool vr::IVRSystem::IsSteamVRDrawingControllers ( )

inline

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

IsTrackedDeviceConnected()

bool vr::IVRSystem::IsTrackedDeviceConnected ( vr::TrackedDeviceIndex_t unDeviceIndex )

inline

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

PerformFirmwareUpdate()

vr::EVRFirmwareError vr::IVRSystem::PerformFirmwareUpdate ( vr::TrackedDeviceIndex_t unDeviceIndex )

inline

Performs the actual firmware update if applicable. The following events will be sent, if VRFirmwareError_None was returned: VREvent_FirmwareUpdateStarted, VREvent_FirmwareUpdateFinished Use the properties Prop_Firmware_UpdateAvailable_Bool, Prop_Firmware_ManualUpdate_Bool, and Prop_Firmware_ManualUpdateURL_String to figure our whether a firmware update is available, and to figure out whether its a manual update Prop_Firmware_ManualUpdateURL_String should point to an URL describing the manual update process

PollNextEvent()

bool vr::IVRSystem::PollNextEvent ( VREvent_t * pEvent, uint32_t uncbVREvent )

inline

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. uncbVREvent should be the size in bytes of the VREvent_t struct

PollNextEventWithPose()

bool vr::IVRSystem::PollNextEventWithPose ( ETrackingUniverseOrigin eOrigin, VREvent_t * pEvent, uint32_t uncbVREvent, vr::TrackedDevicePose_t * pTrackedDevicePose )

inline

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. uncbVREvent should be the size in bytes of the VREvent_t struct

ResetSeatedZeroPose()

void vr::IVRSystem::ResetSeatedZeroPose ( )

inline

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

SetDisplayVisibility()

bool vr::IVRSystem::SetDisplayVisibility ( bool bIsVisibleOnDesktop )

inline

Set the display visibility (true = extended, false = direct mode). Return value of true indicates that the change was successful.

ShouldApplicationPause()

bool vr::IVRSystem::ShouldApplicationPause ( )

inline

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.

ShouldApplicationReduceRenderingWork()

bool vr::IVRSystem::ShouldApplicationReduceRenderingWork ( )

inline

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.

TriggerHapticPulse()

void vr::IVRSystem::TriggerHapticPulse ( vr::TrackedDeviceIndex_t unControllerDeviceIndex, uint32_t unAxisId, unsigned short usDurationMicroSec )

inline

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.

---

The documentation for this class was generated from the following file:

• openvr/openvr_mingw.h