Attention: Here be dragons
This is the
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
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.
get_action_sets ( ) const
get_available_display_refresh_rates ( ) const
is_foveation_supported ( ) const
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).
Hand HAND_LEFT =
Hand HAND_RIGHT =
Hand HAND_MAX =
Maximum value for the hand enum.
HandMotionRange HAND_MOTION_RANGE_UNOBSTRUCTED =
HandMotionRange HAND_MOTION_RANGE_CONFORM_TO_CONTROLLER =
HandMotionRange HAND_MOTION_RANGE_MAX =
HandJoints HAND_JOINT_PALM =
HandJoints HAND_JOINT_WRIST =
HandJoints HAND_JOINT_THUMB_METACARPAL =
Thumb metacarpal joint.
HandJoints HAND_JOINT_THUMB_PROXIMAL =
Thumb proximal joint.
HandJoints HAND_JOINT_THUMB_DISTAL =
Thumb distal joint.
HandJoints HAND_JOINT_THUMB_TIP =
Thumb tip joint.
HandJoints HAND_JOINT_INDEX_METACARPAL =
Index metacarpal joint.
HandJoints HAND_JOINT_INDEX_PROXIMAL =
Index proximal joint.
HandJoints HAND_JOINT_INDEX_INTERMEDIATE =
Index intermediate joint.
HandJoints HAND_JOINT_INDEX_DISTAL =
Index distal joint.
HandJoints HAND_JOINT_INDEX_TIP =
Index tip joint.
HandJoints HAND_JOINT_MIDDLE_METACARPAL =
Middle metacarpal joint.
HandJoints HAND_JOINT_MIDDLE_PROXIMAL =
Middle proximal joint.
HandJoints HAND_JOINT_MIDDLE_INTERMEDIATE =
Middle intermediate joint.
HandJoints HAND_JOINT_MIDDLE_DISTAL =
Middle distal joint.
HandJoints HAND_JOINT_MIDDLE_TIP =
Middle tip joint.
HandJoints HAND_JOINT_RING_METACARPAL =
Ring metacarpal joint.
HandJoints HAND_JOINT_RING_PROXIMAL =
Ring proximal joint.
HandJoints HAND_JOINT_RING_INTERMEDIATE =
Ring intermediate joint.
HandJoints HAND_JOINT_RING_DISTAL =
Ring distal joint.
HandJoints HAND_JOINT_RING_TIP =
Ring tip joint.
HandJoints HAND_JOINT_LITTLE_METACARPAL =
Little metacarpal joint.
HandJoints HAND_JOINT_LITTLE_PROXIMAL =
Little proximal joint.
HandJoints HAND_JOINT_LITTLE_INTERMEDIATE =
Little intermediate joint.
HandJoints HAND_JOINT_LITTLE_DISTAL =
Little distal joint.
HandJoints HAND_JOINT_LITTLE_TIP =
Little tip joint.
HandJoints HAND_JOINT_MAX =
Maximum value for the hand joint enum.
HandJointFlags HAND_JOINT_NONE =
No flags are set.
HandJointFlags HAND_JOINT_ORIENTATION_VALID =
If set, the orientation data is valid, otherwise, the orientation data is unreliable and should not be used.
HandJointFlags HAND_JOINT_ORIENTATION_TRACKED =
If set, the orientation data comes from tracking data, otherwise, the orientation data contains predicted data.
HandJointFlags HAND_JOINT_POSITION_VALID =
If set, the positional data is valid, otherwise, the positional data is unreliable and should not be used.
HandJointFlags HAND_JOINT_POSITION_TRACKED =
If set, the positional data comes from tracking data, otherwise, the positional data contains predicted data.
HandJointFlags HAND_JOINT_LINEAR_VELOCITY_VALID =
If set, our linear velocity data is valid, otherwise, the linear velocity data is unreliable and should not be used.
HandJointFlags HAND_JOINT_ANGULAR_VELOCITY_VALID =
If set, our angular velocity data is valid, otherwise, the angular velocity data is unreliable and should not be used.
float 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.
bool foveation_dynamic =
Enable dynamic foveation adjustment, the interface must be initialized before this is accessible. If enabled foveation will automatically adjusted between low and foveation_level.
int foveation_level =
Set foveation level from 0 (off) to 3 (high), the interface must be initialized before this is accessible.
float render_target_size_multiplier =
The render size multiplier for the current HMD. Must be set before the interface has been initialized.
Array get_action_sets ( ) const
Returns a list of action sets registered with Godot (loaded from the action map at runtime).
Array get_available_display_refresh_rates ( ) const
Returns display refresh rates supported by the current HMD. Only returned if th