Support Forum       G3D Web Page     
Public Member Functions | Public Attributes | List of all members
G3D::GApp::Settings::VR Class Reference

Public Member Functions

 VR (bool debugMirrorMode=DebugVRMirrorMode::NONE)
 

Public Attributes

DebugVRMirrorMode debugMirrorMode
 Defaults to false. More...
 
DepthOfFieldSettings depthOfFieldSettings
 Disabled. More...
 
bool disablePostEffectsIfTooSlow
 If this is true, after too many frames have rendered below the target frame rate post-processing effects will be selectively disabled on the active camera. More...
 
bool emulateControllerIfMissing
 If no physical VR controller is present, should the system provide a virtual one that is locked relative to the HMD? This is useful for both development and deployment. More...
 
bool emulateHMDIfMissing
 If no HMD is present, should the system provide a virtual HMD for development and debugging? If false and there is no HMD, the system will throw an error. More...
 
FrameName hudSpace
 Must be CAMERA (player head), OBJECT (player body, the default), or WORLD (fixed at the origin) More...
 
MotionBlurSettings motionBlurSettings
 Defaults to 100% camera motion, 15% exposure time, enabled. More...
 
bool overrideDepthOfField
 
Force depthOfFieldSettings on VR eye cameras at render time. More...
 
bool overrideMotionBlur
 
Force motionBlurSettings on VR eye cameras at render time. More...
 
bool trackingOverridesPitch
 Use pitch control from the HMD instead of from the m_cameraManipulator. More...
 
shared_ptr< XRxrSystem
 

Constructor & Destructor Documentation

◆ VR()

G3D::GApp::Settings::VR::VR ( bool  debugMirrorMode = DebugVRMirrorMode::NONE)
inline

Member Data Documentation

◆ debugMirrorMode

DebugVRMirrorMode G3D::GApp::Settings::VR::debugMirrorMode

Defaults to false.

Cannot be changed once VRApp is initialized.

◆ depthOfFieldSettings

DepthOfFieldSettings G3D::GApp::Settings::VR::depthOfFieldSettings

Disabled.

Referenced by VR().

◆ disablePostEffectsIfTooSlow

bool G3D::GApp::Settings::VR::disablePostEffectsIfTooSlow

If this is true, after too many frames have rendered below the target frame rate post-processing effects will be selectively disabled on the active camera.

Defaults to true.

◆ emulateControllerIfMissing

bool G3D::GApp::Settings::VR::emulateControllerIfMissing

If no physical VR controller is present, should the system provide a virtual one that is locked relative to the HMD? This is useful for both development and deployment.

If false and there is no physical controller, then there is no error– tracking will simply report nothing.

◆ emulateHMDIfMissing

bool G3D::GApp::Settings::VR::emulateHMDIfMissing

If no HMD is present, should the system provide a virtual HMD for development and debugging? If false and there is no HMD, the system will throw an error.

◆ hudSpace

FrameName G3D::GApp::Settings::VR::hudSpace

Must be CAMERA (player head), OBJECT (player body, the default), or WORLD (fixed at the origin)

◆ motionBlurSettings

MotionBlurSettings G3D::GApp::Settings::VR::motionBlurSettings

Defaults to 100% camera motion, 15% exposure time, enabled.

See also
overrideMotionBlur

Referenced by VR().

◆ overrideDepthOfField

bool G3D::GApp::Settings::VR::overrideDepthOfField


Force depthOfFieldSettings on VR eye cameras at render time.

◆ overrideMotionBlur

bool G3D::GApp::Settings::VR::overrideMotionBlur


Force motionBlurSettings on VR eye cameras at render time.

◆ trackingOverridesPitch

bool G3D::GApp::Settings::VR::trackingOverridesPitch

Use pitch control from the HMD instead of from the m_cameraManipulator.

Defaults to true. For walking simulators, we recommend m_trackingOverridesPitch = true. For driving or flight simulators, we recommend m_trackingOverridesPitch = false.

Yaw control is not overriden in order to allow typical first-person strafing movement and rotation. (We may provide an option to do so, or at least to compose them, in the future). Beware that this can be confusing to the user unless some kind of body avatar is rendered.

Can be changed at runtime, although some inconsistency may occur for a few frames after the change.

◆ xrSystem

shared_ptr<XR> G3D::GApp::Settings::VR::xrSystem

documentation generated on Wed Nov 24 2021 08:01:56 using doxygen 1.8.15