Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

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¶

Setting up XR

Properties¶

float	display_refresh_rate	`0.0`
bool	foveation_dynamic	`false`
int	foveation_level	`0`
float	render_target_size_multiplier	`1.0`

Methods¶

Array	get_action_sets ( ) const
Array	get_available_display_refresh_rates ( ) const
Vector3	get_hand_joint_angular_velocity ( Hand hand, HandJoints joint ) const
Vector3	get_hand_joint_linear_velocity ( Hand hand, HandJoints joint ) const
Vector3	get_hand_joint_position ( Hand hand, HandJoints joint ) const
float	get_hand_joint_radius ( Hand hand, HandJoints joint ) const
Quaternion	get_hand_joint_rotation ( Hand hand, HandJoints joint ) const
HandMotionRange	get_motion_range ( Hand hand ) const
bool	is_action_set_active ( String name ) const
bool	is_foveation_supported ( ) const
void	set_action_set_active ( String name, bool active )
void	set_motion_range ( Hand hand, HandMotionRange motion_range )

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).

Enumerations¶

enum Hand:

Hand HAND_LEFT = 0

Left hand.

Hand HAND_RIGHT = 1

Right hand.

Hand HAND_MAX = 2

Maximum value for the hand enum.

enum HandMotionRange:

HandMotionRange HAND_MOTION_RANGE_UNOBSTRUCTED = 0

HandMotionRange HAND_MOTION_RANGE_CONFORM_TO_CONTROLLER = 1

HandMotionRange HAND_MOTION_RANGE_MAX = 2

enum HandJoints:

HandJoints HAND_JOINT_PALM = 0

Palm joint.

HandJoints HAND_JOINT_WRIST = 1

Wrist joint.

HandJoints HAND_JOINT_THUMB_METACARPAL = 2

Thumb metacarpal joint.