Log In | Sign Up

Libovr 1.43 Reference Guide

ovrSessionStatus Struct Reference

Specifies status information for the current session.

Data Fields

ovrBool
True if the process has VR focus and thus is visible in the HMD.
ovrBool
True if an HMD is present.
ovrBool
True if the HMD is on the user's head.
ovrBool
True if the session is in a display-lost state. See ovr_SubmitFrame.
ovrBool
True if the application should initiate shutdown.
ovrBool
True if UX has requested re-centering.
ovrBool
True if the application is the foreground application and receives input (e.g.
ovrBool
True if a system overlay is present, such as a dashboard.
ovrBool
True if runtime is requesting that the application provide depth buffers with projection layers.

Detailed Description

Field Documentation

ovrBool ovrSessionStatus::IsVisible ( )
True if the process has VR focus and thus is visible in the HMD.
ovrBool ovrSessionStatus::HmdPresent ( )
True if an HMD is present.
ovrBool ovrSessionStatus::HmdMounted ( )
True if the HMD is on the user's head.
ovrBool ovrSessionStatus::DisplayLost ( )
True if the session is in a display-lost state. See ovr_SubmitFrame.
ovrBool ovrSessionStatus::ShouldQuit ( )
True if the application should initiate shutdown.
ovrBool ovrSessionStatus::ShouldRecenter ( )
True if UX has requested re-centering.
Must call ovr_ClearShouldRecenterFlag, ovr_RecenterTrackingOrigin or ovr_SpecifyTrackingOrigin.
ovrBool ovrSessionStatus::HasInputFocus ( )
True if the application is the foreground application and receives input (e.g.
Touch controller state). If this is false then the application is in the background (but possibly still visible) should hide any input representations such as hands.
ovrBool ovrSessionStatus::OverlayPresent ( )
True if a system overlay is present, such as a dashboard.
In this case the application (if visible) should pause while still drawing, avoid drawing near-field graphics so they don't visually fight with the system overlay, and consume fewer CPU and GPU resources. Deprecated
Do not use.
ovrBool ovrSessionStatus::DepthRequested ( )
True if runtime is requesting that the application provide depth buffers with projection layers.
The documentation for this struct was generated from the following file: Include/OVR_CAPI.h