Our OpenXR interface.
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.
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.
If true, enables dynamic foveation adjustment. The interface must be initialized before this is accessible. If enabled, foveation will automatically be adjusted between low and foveation_level.
The foveation level, from 0 (off) to 3 (high). The interface must be initialized before this is accessible.
The render size multiplier for the current HMD. Must be set before the interface has been initialized.
The minimum radius around the focal point where full quality is guaranteed if VRS is used as a percentage of screen size.
Note: Mobile and Forward+ renderers only. Requires Viewport.vrs_mode to be set to Viewport.VRS_XR.
The strength used to calculate the VRS density map. The greater this value, the more noticeable VRS is. This improves performance at the cost of quality.
Note: Mobile and Forward+ renderers only. Requires Viewport.vrs_mode to be set to Viewport.VRS_XR.
Returns a list of 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.
If handtracking is enabled, returns the angular velocity of a joint (joint) of a hand (hand) as provided by OpenXR. This is relative to XROrigin3D!
If handtracking is enabled, returns flags that inform us of the validity of the tracking data.
If handtracking is enabled, returns the linear velocity of a joint (joint) of a hand (hand) as provided by OpenXR. This is relative to XROrigin3D without worldscale applied!
If handtracking is enabled, returns the position of a joint (joint) of a hand (hand) as provided by OpenXR. This is relative to XROrigin3D without worldscale applied!
If handtracking is enabled, returns the radius of a joint (joint) of a hand (hand) as provided by OpenXR. This is without worldscale applied!
If handtracking is enabled, returns the rotation of a joint (joint) of a hand (hand) as provided by OpenXR.
If handtracking is enabled and hand tracking source is supported, gets the source of the hand tracking data for hand.
If handtracking is enabled and motion range is supported, gets the currently configured motion range for hand.
Returns the capabilities of the eye gaze interaction extension.
Note: This only returns a valid value after OpenXR has been initialized.
Returns true if OpenXR's foveation extension is supported. The interface must be initialized before this returns a valid value.
Note: When using the Vulkan rendering driver, Viewport.vrs_mode must be set to Viewport.VRS_XR to support foveation.
Returns true if OpenXR's hand interaction profile is supported and enabled.
Note: This only returns a valid value after OpenXR has been initialized.
Returns true if OpenXR's hand tracking is supported and enabled.
Note: This only returns a valid value after OpenXR has been initialized.
Returns true if OpenXR's user presence extension is supported and enabled.
Note: This only returns a valid value after OpenXR has been initialized.
If handtracking is enabled and motion range is supported, sets the currently configured motion range for hand to motion_range.
Informs the user the HMD refresh rate has changed.
Note: Only emitted if XR runtime supports the refresh rate extension.
Informs our OpenXR session now has focus, for example output is sent to the HMD and we're receiving XR input.
Informs our OpenXR session is now visible, for example output is sent to the HMD but we don't receive XR input.
Signal emitted when the user presence value changes.
Note: This signal will not be emitted during application startup and application shutdown. Developers should assume user presence is gained on startup and lost on shutdown.
SESSION_STATE_UNKNOWN = 0The state of the session is unknown, we haven't tried setting up OpenXR yet.
SESSION_STATE_IDLE = 1The initial state after the OpenXR session is created or after the session is destroyed.
SESSION_STATE_READY = 2OpenXR is ready to begin our session. session_begun is emitted when we change to this state.
SESSION_STATE_SYNCHRONIZED = 3The application has synched its frame loop with the runtime but we're not rendering anything. session_synchronized is emitted when we change to this state.
SESSION_STATE_VISIBLE = 4The application has synched its frame loop with the runtime and we're rendering output to the user, however we receive no user input. session_visible is emitted when we change to this state.
Note: This is the current state just before we get the focused state, whenever the user opens a system menu, switches to another application, or takes off their headset.
SESSION_STATE_FOCUSED = 5The application has synched its frame loop with the runtime, we're rendering output to the user and we're receiving XR input. session_focussed is emitted when we change to this state.
Note: This is the state OpenXR will be in when the user can fully interact with your game.
SESSION_STATE_STOPPING = 6Our session is being stopped. session_stopping is emitted when we change to this state.
SESSION_STATE_LOSS_PENDING = 7The session is about to be lost. session_loss_pending is emitted when we change to this state.
SESSION_STATE_EXITING = 8The OpenXR instance is about to be destroyed and we're exiting. instance_exiting is emitted when we change to this state.
HAND_LEFT = 0Left hand.
HAND_RIGHT = 1Right hand.
HAND_MAX = 2Maximum value for the hand enum.
HAND_MOTION_RANGE_UNOBSTRUCTED = 0Full hand range, if user closes their hands, we make a full fist.
HAND_MOTION_RANGE_CONFORM_TO_CONTROLLER = 1Conform to controller, if user closes their hands, the tracked data conforms to the shape of the controller.
HAND_MOTION_RANGE_MAX = 2Maximum value for the motion range enum.
HAND_TRACKED_SOURCE_UNKNOWN = 0The source of hand tracking data is unknown (the extension is likely unsupported).
HAND_TRACKED_SOURCE_UNOBSTRUCTED = 1The source of hand tracking is unobstructed, this means that an accurate method of hand tracking is used, e.g. optical hand tracking, data gloves, etc.
HAND_TRACKED_SOURCE_CONTROLLER = 2The source of hand tracking is a controller, bone positions are inferred from controller inputs.
HAND_TRACKED_SOURCE_MAX = 3Represents the size of the HandTrackedSource enum.
HAND_JOINT_PALM = 0Palm joint.
HAND_JOINT_WRIST = 1Wrist joint.
HAND_JOINT_THUMB_METACARPAL = 2Thumb metacarpal joint.
HAND_JOINT_THUMB_PROXIMAL = 3Thumb proximal joint.
HAND_JOINT_THUMB_DISTAL = 4Thumb distal joint.
HAND_JOINT_THUMB_TIP = 5Thumb tip joint.
HAND_JOINT_INDEX_METACARPAL = 6Index finger metacarpal joint.
HAND_JOINT_INDEX_PROXIMAL = 7Index finger phalanx proximal joint.
HAND_JOINT_INDEX_INTERMEDIATE = 8Index finger phalanx intermediate joint.
HAND_JOINT_INDEX_DISTAL = 9Index finger phalanx distal joint.
HAND_JOINT_INDEX_TIP = 10Index finger tip joint.
HAND_JOINT_MIDDLE_METACARPAL = 11Middle finger metacarpal joint.
HAND_JOINT_MIDDLE_PROXIMAL = 12Middle finger phalanx proximal joint.
HAND_JOINT_MIDDLE_INTERMEDIATE = 13Middle finger phalanx intermediate joint.
HAND_JOINT_MIDDLE_DISTAL = 14Middle finger phalanx distal joint.
HAND_JOINT_MIDDLE_TIP = 15Middle finger tip joint.
HAND_JOINT_RING_METACARPAL = 16Ring finger metacarpal joint.
HAND_JOINT_RING_PROXIMAL = 17Ring finger phalanx proximal joint.
HAND_JOINT_RING_INTERMEDIATE = 18Ring finger phalanx intermediate joint.
HAND_JOINT_RING_DISTAL = 19Ring finger phalanx distal joint.
HAND_JOINT_RING_TIP = 20Ring finger tip joint.
HAND_JOINT_LITTLE_METACARPAL = 21Pinky finger metacarpal joint.
HAND_JOINT_LITTLE_PROXIMAL = 22Pinky finger phalanx proximal joint.
HAND_JOINT_LITTLE_INTERMEDIATE = 23Pinky finger phalanx intermediate joint.
HAND_JOINT_LITTLE_DISTAL = 24Pinky finger phalanx distal joint.
HAND_JOINT_LITTLE_TIP = 25Pinky finger tip joint.
HAND_JOINT_MAX = 26Represents the size of the HandJoints enum.
PERF_SETTINGS_LEVEL_POWER_SAVINGS = 0The application has entered a non-XR section (head-locked / static screen), during which power savings are to be prioritized.
PERF_SETTINGS_LEVEL_SUSTAINED_LOW = 1The application has entered a low and stable complexity section, during which reducing power is more important than occasional late rendering frames.
PERF_SETTINGS_LEVEL_SUSTAINED_HIGH = 2The application has entered a high or dynamic complexity section, during which the XR Runtime strives for consistent XR compositing and frame rendering within a thermally sustainable range.
PERF_SETTINGS_LEVEL_BOOST = 3The application has entered a section with very high complexity, during which the XR Runtime is allowed to step up beyond the thermally sustainable range.
PERF_SETTINGS_SUB_DOMAIN_COMPOSITING = 0The compositing performance within the runtime has reached a new level.
PERF_SETTINGS_SUB_DOMAIN_RENDERING = 1The application rendering performance has reached a new level.
PERF_SETTINGS_SUB_DOMAIN_THERMAL = 2The temperature of the device has reached a new level.
PERF_SETTINGS_NOTIF_LEVEL_NORMAL = 0The sub-domain has reached a level where no further actions other than currently applied are necessary.
PERF_SETTINGS_NOTIF_LEVEL_WARNING = 1The sub-domain has reached an early warning level where the application should start proactive mitigation actions.
PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED = 2The sub-domain has reached a critical level where the application should start drastic mitigation actions.
HAND_JOINT_NONE = 0No flags are set.
HAND_JOINT_ORIENTATION_VALID = 1If set, the orientation data is valid, otherwise, the orientation data is unreliable and should not be used.
HAND_JOINT_ORIENTATION_TRACKED = 2If set, the orientation data comes from tracking data, otherwise, the orientation data contains predicted data.
HAND_JOINT_POSITION_VALID = 4If set, the positional data is valid, otherwise, the positional data is unreliable and should not be used.
HAND_JOINT_POSITION_TRACKED = 8If set, the positional data comes from tracking data, otherwise, the positional data contains predicted data.
HAND_JOINT_LINEAR_VELOCITY_VALID = 16If set, our linear velocity data is valid, otherwise, the linear velocity data is unreliable and should not be used.
HAND_JOINT_ANGULAR_VELOCITY_VALID = 32If set, our angular velocity data is valid, otherwise, the angular velocity data is unreliable and should not be used.