vrHMDService

class vrHMDService

(Inherits vrBaseService)

Gives access to a Virtual Reality HMD (Head-mounted display) like the HTC Vive or Oculus.

Summary

Functions:
Signals:

Functions

vrHMDService.getActiveOpenXRRuntimeName()
Returns:Returns the active OpenXR runtime’s name as a string
Return type:string
vrHMDService.getActiveOpenXRSystemName()
Returns:Returns the active OpenXR system’s name as a string
Return type:string
vrHMDService.getDefaultRenderMode()

Gets the render mode that will be used on HMD activation.

Returns:The render mode
Return type:vrXRealityTypes.XRRenderMode
vrHMDService.getDepthTextureEnabled()

Checks if depth textures for positional timewarp are enabled.

Returns:True if enables, False if disabled
Return type:bool
vrHMDService.getEyeGaze()

Returns tracked eye gaze data while eye tracking is active. Without eye tracking returns the forward looking ray of the HMD user. The gaze ray is in world coordinates.

Returns:Gaze data
Return type:vrdEyeGaze
vrHMDService.getEyeTrackingEnabled()

Returns whether eye tracking should be enabled in VR. Please note this does not tell whether the HMD actually supports eye tracking or whether eye tracking is currently running. For the latter, use vrHMDService.isEyeTrackingActive().

Returns:True if enabled
Return type:bool
vrHMDService.getFovealRegionSize()

Gets the size of the foveal region in foveated rendering mode.

Returns:The foveal region size
Return type:float
vrHMDService.getFoveatedRenderingEnabled()

Returns whether foveated rendering should be enabled in VR. Please note this does not tell whether the graphics card actually supports foveated rendering.

Returns:True if enabled
Return type:bool
vrHMDService.getFoveatedRenderingQuality(preset)

Gets the quality settings for a given preset.

Parameters:preset (vrRenderTypes.FoveatedQualityPreset) – Preset for shading qualities used in foveated rendering mode.
Returns:Quality settings
Return type:vrdFoveatedQuality
vrHMDService.getFoveatedRenderingQualityPreset()

Gets the quality preset that is used for foveated rendering. Get the individual settings for the preset with getFoveatedRenderingQuality(vrRenderTypes::FoveatedQualityPreset).

Returns:Current preset
Return type:vrRenderTypes.FoveatedQualityPreset
vrHMDService.getMixedRealityDepthEstimationEnabled()

Checks if the depth testing for mixed reality is enabled.

Returns:True if enabled (even if not available), false otherwise
Return type:bool
vrHMDService.getMixedRealityEyeOffsetPercentage()

Get the offset between the camera and the eye for mixed reality in percentage.

Returns:The offset between the eye and camera in range 0.0 to 1.0
Return type:float
vrHMDService.getMixedRealityHandDepthEstimationEnabled()

Checks if the depth testing for mixed reality is enabled.

Returns:True if enabled (even if not available), false otherwise
Return type:bool
vrHMDService.getOpenXRDepthLayerCompositionEnabled()
Returns:Returns if the depth composition layers should be submitted to OpenXR runtimes.
Return type:bool
vrHMDService.getVarjoRenderSettings()

Get current render settings that are specific for the Varjo HMD.

Returns:Render settings for Varjo HMD
Return type:vrdVarjoRenderSettings
vrHMDService.getXRRenderMode()

Gets the currently set XR rendering mode.

Returns:The currently set rendering mode, will return FullScene, if no seethrough capable HMD is attached
Return type:vrXRealityTypes.XRRenderMode
vrHMDService.isEyeTrackingActive()

Returns whether eye tracking is currently active. It can only be active if enabled, while in VR and if the HMD has an eye tracker supported by VRED.

Returns:True if active
Return type:bool
vrHMDService.isHmdActive()

Check if an HMD (VR) display mode is active.

Returns:True, if in HMD mode
Return type:bool
vrHMDService.isMixedRealityDepthEstimationSupported()
Returns:True if the currently active HMD supports depth testing in mixed reality
Return type:bool
vrHMDService.isMixedRealitySupported()

Checks if the currently activated HMD supports mixed reality.

Returns:False if mixed reality is not supported or if no HMD is currently active, True otherwise
Return type:bool
vrHMDService.isXRRenderModeSupported(mode)

Checks if a XR render mode is supported by the currently active HMD.

Parameters:mode (vrXRealityTypes.XRRenderMode) – The render mode
Returns:True if the render mode is supported, false otherwise
Return type:bool
vrHMDService.setDefaultRenderMode(mode)

Sets the render mode that will be used on HMD activation.

Parameters:mode (vrXRealityTypes.XRRenderMode) – The render mode that is set on activation. If the mode is not FullScene and the HMD does not support Mixed Reality, it will activate FullScene mode on activation
vrHMDService.setDepthTextureEnabled(enabled)

Enables/Disables depth textures for positional timewarp if available.

Parameters:enabled (bool) – True to enable, False to disable
vrHMDService.setEyeTrackingEnabled(enabled)

Enables or disables eye tracking in VR if supported by the connected HMD. If the option is set before VR mode is enabled, it is applied when entering VR. Enable eye tracking for foveated rendering.

Parameters:enabled (bool) – True to enable Eye tracking, False to disable Eye tracking
vrHMDService.setFovealRegionSize(size)

Sets the size of the foveal region in foveated rendering mode. See vrHMDService.setFoveatedRenderingEnabled(enabled).

Parameters:size (float) – Foveal region size.
vrHMDService.setFoveatedRenderingCustomQuality(quality)

Allows to set a custom configuration for the shading qualities used in foveated rendering mode. Enable the custom quality by setting vrHMDService.setFoveatedRenderingQualityPreset(preset) to Custom.

Parameters:quality (vrdFoveatedQuality) – Foveated shading qualities settings.
vrHMDService.setFoveatedRenderingEnabled(enabled)

Enables or disables foveated rendering in VR. This requires the OpenGL Shading Rate Image extension which is supported by NVIDIA Turing graphics cards. If the option is set before VR mode is enabled, it is applied when entering VR.

Parameters:enabled (bool) – True to enable, False to disable Foveated rendering.
vrHMDService.setFoveatedRenderingQualityPreset(preset)

Set the quality preset used for foveated rendering.

Parameters:preset (vrRenderTypes.FoveatedQualityPreset) – Preset for shading qualities used in foveated rendering mode.
vrHMDService.setMixedRealityDepthEstimationEnabled(enabled)

Enables/Disables depth testing for mixed reality if supported. Depth testing allows the real world to occlude parts of the rendered image.

Parameters:enabled (bool) – True to enable, False to disable
vrHMDService.setMixedRealityEyeOffsetPercentage(offset)

Set the offset between the camera and the eye for mixed reality in percentage. This is needed to match the mr videos point of view to the renderings point of view.

Parameters:offset (float) – The offset between eye and camera in range 0.0 to 1.0
vrHMDService.setMixedRealityHandDepthEstimationEnabled(enabled)

Enables/Disables depth testing for mixed reality if supported. Depth testing allows the real world hands to occlude parts of the rendered image.

Parameters:enabled (bool) – True to enable, False to disable
vrHMDService.setOpenXRDepthLayerCompositionEnabled(enable)

Enables or disables the submission of depth composition layers to provide depth information to OpenXR runtimes, which can be used for positional time warp or mixed reality for example. Note this might not be supported for all runtimes or HMDs.

Parameters:enable (bool) – True to enable, False to disable
vrHMDService.setVarjoRenderSettings(settings)

Apply specific render settings for the Varjo HMD. Changes to these settings take effect on next activation of Varjo HMD mode.

Parameters:settings (vrdVarjoRenderSettings) –
vrHMDService.setXRRenderMode(mode)

Sets the XR rendering mode of the HMD if available.

Parameters:mode (vrXRealityTypes.XRRenderMode) – The rendering mode

Signals

vrHMDService.eyeGazeChanged()

This signal is triggered every frame while eye tracking is active.

vrHMDService.foveatedRenderingStateChanged(enabled)

This signal is triggered when the state of foveated rendering changed.

Parameters:enabled (bool) – True, if foveated rendering is enabled.
vrHMDService.handDepthEstimationChanged(enabled)

This signal is triggered when the depth testing in MR has been enabled or disabled.

Parameters:enabled (bool) – True, if depth testing has been enabled, false otherwise
vrHMDService.hmdStatusChanged(active)

This signal is triggered when HMD (VR) display mode is switched on or off.

Parameters:active (bool) – True, if HMD mode has been switched on
vrHMDService.hmdStatusWillChange(active)

This signal is triggered just before the HMD (VR) display mode is switched on or off.

Parameters:active (bool) – True, if HMD mode will be switched on, False otherwise
vrHMDService.XRRenderModeChanged(mode)

This signal is triggered when the XR render mode has changed.

Parameters:mode (vrXRealityTypes.XRRenderMode) – The mode to which rendering has been switched.