OpenXRInterface

Inherits: XRInterface < RefCounted < Object

Our OpenXR interface.

Description

The OpenXR interface allows Godot to interact with OpenXR runtimes and make it possible to create XR experiences and games.

Due to the needs of OpenXR this interface works slightly different than other plugin based XR interfaces. It needs to be initialized when Godot starts. You need to enable OpenXR, settings for this can be found in your games project settings under the XR heading. You do need to mark a viewport for use with XR in order for Godot to know which render result should be output to the headset.

Tutorials

Properties

float

display_refresh_rate

0.0

Methods

Array

get_available_display_refresh_rates ( ) const

Signals

  • pose_recentered ( )

Informs the user queued a recenter of the player position.


  • session_begun ( )

Informs our OpenXR session has been started.


  • session_focussed ( )

Informs our OpenXR session now has focus.


  • session_stopping ( )

Informs our OpenXR session is stopping.


  • session_visible ( )

Informs our OpenXR session is now visible (output is being sent to the HMD).

Property Descriptions

  • float display_refresh_rate

Default

0.0

Setter

set_display_refresh_rate(value)

Getter

get_display_refresh_rate()

The display refresh rate for the current HMD. Only functional if this feature is supported by the OpenXR runtime and after the interface has been initialized.

Method Descriptions

  • Array get_available_display_refresh_rates ( ) const

Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized.