OpenXRInterface
Inherits: XRInterface < Shared < Object
Our OpenXR interface.
Description
Section titled “Description”The OpenXR interface allows Gobu 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 Gobu 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 Gobu to know which render result should be output to the headset.
Properties
Section titled “Properties”Methods
Section titled “Methods”| Returns | Method |
|---|---|
| Array | get_action_sets() |
| Array | get_available_display_refresh_rates() |
| Vector3 | get_hand_joint_angular_velocity(hand, joint) |
| OpenXRInterface.HandJointFlags | get_hand_joint_flags(hand, joint) |
| Vector3 | get_hand_joint_linear_velocity(hand, joint) |
| Vector3 | get_hand_joint_position(hand, joint) |
| float | get_hand_joint_radius(hand, joint) |
| Quaternion | get_hand_joint_rotation(hand, joint) |
| OpenXRInterface.HandTrackedSource | get_hand_tracking_source(hand) |
| OpenXRInterface.HandMotionRange | get_motion_range(hand) |
| OpenXRInterface.SessionState | get_session_state() |
| bool | is_action_set_active(name) |
| bool | is_eye_gaze_interaction_supported() |
| bool | is_foveation_supported() |
| bool | is_hand_interaction_supported() |
| bool | is_hand_tracking_supported() |
| bool | is_user_presence_supported() |
| bool | is_user_present() |
| void | set_action_set_active(name, active) |
| void | set_cpu_level(level) |
| void | set_gpu_level(level) |
| void | set_motion_range(hand, motion_range) |
Signals
Section titled “Signals”cpu_level_changed
Section titled “cpu_level_changed”cpu_level_changed(sub_domain: int, from_level: int, to_level: int)Informs the device CPU performance level has changed in the specified subdomain.
gpu_level_changed
Section titled “gpu_level_changed”gpu_level_changed(sub_domain: int, from_level: int, to_level: int)Informs the device GPU performance level has changed in the specified subdomain.
instance_exiting
Section titled “instance_exiting”instance_exiting()Informs our OpenXR instance is exiting.
pose_recentered
Section titled “pose_recentered”pose_recentered()Informs the user queued a recenter of the player position.
refresh_rate_changed
Section titled “refresh_rate_changed”refresh_rate_changed(refresh_rate: float)Informs the user the HMD refresh rate has changed.
Note: Only emitted if XR runtime supports the refresh rate extension.
session_begun
Section titled “session_begun”session_begun()Informs our OpenXR session has been started.
session_focussed
Section titled “session_focussed”session_focussed()Informs our OpenXR session now has focus, for example output is sent to the HMD and we’re receiving XR input.
session_loss_pending
Section titled “session_loss_pending”session_loss_pending()Informs our OpenXR session is in the process of being lost.
session_stopping
Section titled “session_stopping”session_stopping()Informs our OpenXR session is stopping.
session_synchronized
Section titled “session_synchronized”session_synchronized()Informs our OpenXR session has been synchronized.
session_visible
Section titled “session_visible”session_visible()Informs our OpenXR session is now visible, for example output is sent to the HMD but we don’t receive XR input.
user_presence_changed
Section titled “user_presence_changed”user_presence_changed(is_user_present: bool)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.
Enumerations and constants
Section titled “Enumerations and constants”enum SessionState
Section titled “enum SessionState”- SESSION_STATE_UNKNOWN =
0— The state of the session is unknown, we haven’t tried setting up OpenXR yet.
- SESSION_STATE_IDLE =
1— The initial state after the OpenXR session is created or after the session is destroyed.
- SESSION_STATE_READY =
2— OpenXR is ready to begin our session.session_begunis emitted when we change to this state.
- SESSION_STATE_SYNCHRONIZED =
3— The application has synched its frame loop with the runtime but we’re not rendering anything.session_synchronizedis emitted when we change to this state.
- SESSION_STATE_VISIBLE =
4— The application has synched its frame loop with the runtime and we’re rendering output to the user, however we receive no user input.session_visibleis 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 =
5— The application has synched its frame loop with the runtime, we’re rendering output to the user and we’re receiving XR input.session_focussedis 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 =
6— Our session is being stopped.session_stoppingis emitted when we change to this state.
- SESSION_STATE_LOSS_PENDING =
7— The session is about to be lost.session_loss_pendingis emitted when we change to this state.
- SESSION_STATE_EXITING =
8— The OpenXR instance is about to be destroyed and we’re exiting.instance_exitingis emitted when we change to this state.
enum Hand
Section titled “enum Hand”- HAND_LEFT =
0— Left hand.
- HAND_RIGHT =
1— Right hand.
- HAND_MAX =
2— Maximum value for the hand enum.
enum HandMotionRange
Section titled “enum HandMotionRange”- HAND_MOTION_RANGE_UNOBSTRUCTED =
0— Full hand range, if user closes their hands, we make a full fist.
- HAND_MOTION_RANGE_CONFORM_TO_CONTROLLER =
1— Conform to controller, if user closes their hands, the tracked data conforms to the shape of the controller.
- HAND_MOTION_RANGE_MAX =
2— Maximum value for the motion range enum.
enum HandTrackedSource
Section titled “enum HandTrackedSource”- HAND_TRACKED_SOURCE_UNKNOWN =
0— The source of hand tracking data is unknown (the extension is likely unsupported).
- HAND_TRACKED_SOURCE_UNOBSTRUCTED =
1— The 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 =
2— The source of hand tracking is a controller, bone positions are inferred from controller inputs.
- HAND_TRACKED_SOURCE_MAX =
3— Represents the size of theHandTrackedSourceenum.
enum HandJoints
Section titled “enum HandJoints”- HAND_JOINT_PALM =
0— Palm joint.
- HAND_JOINT_WRIST =
1— Wrist joint.
- HAND_JOINT_THUMB_METACARPAL =
2— Thumb metacarpal joint.
- HAND_JOINT_THUMB_PROXIMAL =
3— Thumb proximal joint.
- HAND_JOINT_THUMB_DISTAL =
4— Thumb distal joint.
- HAND_JOINT_THUMB_TIP =
5— Thumb tip joint.
- HAND_JOINT_INDEX_METACARPAL =
6— Index finger metacarpal joint.
- HAND_JOINT_INDEX_PROXIMAL =
7— Index finger phalanx proximal joint.
- HAND_JOINT_INDEX_INTERMEDIATE =
8— Index finger phalanx intermediate joint.
- HAND_JOINT_INDEX_DISTAL =
9— Index finger phalanx distal joint.
- HAND_JOINT_INDEX_TIP =
10— Index finger tip joint.
- HAND_JOINT_MIDDLE_METACARPAL =
11— Middle finger metacarpal joint.
- HAND_JOINT_MIDDLE_PROXIMAL =
12— Middle finger phalanx proximal joint.
- HAND_JOINT_MIDDLE_INTERMEDIATE =
13— Middle finger phalanx intermediate joint.
- HAND_JOINT_MIDDLE_DISTAL =
14— Middle finger phalanx distal joint.
- HAND_JOINT_MIDDLE_TIP =
15— Middle finger tip joint.
- HAND_JOINT_RING_METACARPAL =
16— Ring finger metacarpal joint.
- HAND_JOINT_RING_PROXIMAL =
17— Ring finger phalanx proximal joint.
- HAND_JOINT_RING_INTERMEDIATE =
18— Ring finger phalanx intermediate joint.
- HAND_JOINT_RING_DISTAL =
19— Ring finger phalanx distal joint.
- HAND_JOINT_RING_TIP =
20— Ring finger tip joint.
- HAND_JOINT_LITTLE_METACARPAL =
21— Pinky finger metacarpal joint.
- HAND_JOINT_LITTLE_PROXIMAL =
22— Pinky finger phalanx proximal joint.
- HAND_JOINT_LITTLE_INTERMEDIATE =
23— Pinky finger phalanx intermediate joint.
- HAND_JOINT_LITTLE_DISTAL =
24— Pinky finger phalanx distal joint.
- HAND_JOINT_LITTLE_TIP =
25— Pinky finger tip joint.
- HAND_JOINT_MAX =
26— Represents the size of theHandJointsenum.
enum PerfSettingsLevel
Section titled “enum PerfSettingsLevel”- PERF_SETTINGS_LEVEL_POWER_SAVINGS =
0— The application has entered a non-XR section (head-locked / static screen), during which power savings are to be prioritized.
- PERF_SETTINGS_LEVEL_SUSTAINED_LOW =
1— The 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 =
2— The 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 =
3— The application has entered a section with very high complexity, during which the XR Runtime is allowed to step up beyond the thermally sustainable range.
enum PerfSettingsSubDomain
Section titled “enum PerfSettingsSubDomain”- PERF_SETTINGS_SUB_DOMAIN_COMPOSITING =
0— The compositing performance within the runtime has reached a new level.
- PERF_SETTINGS_SUB_DOMAIN_RENDERING =
1— The application rendering performance has reached a new level.
- PERF_SETTINGS_SUB_DOMAIN_THERMAL =
2— The temperature of the device has reached a new level.
enum PerfSettingsNotificationLevel
Section titled “enum PerfSettingsNotificationLevel”- PERF_SETTINGS_NOTIF_LEVEL_NORMAL =
0— The sub-domain has reached a level where no further actions other than currently applied are necessary.
- PERF_SETTINGS_NOTIF_LEVEL_WARNING =
1— The sub-domain has reached an early warning level where the application should start proactive mitigation actions.
- PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED =
2— The sub-domain has reached a critical level where the application should start drastic mitigation actions.
enum HandJointFlags
Section titled “enum HandJointFlags”- HAND_JOINT_NONE =
0— No flags are set.
- HAND_JOINT_ORIENTATION_VALID =
1— If set, the orientation data is valid, otherwise, the orientation data is unreliable and should not be used.
- HAND_JOINT_ORIENTATION_TRACKED =
2— If set, the orientation data comes from tracking data, otherwise, the orientation data contains predicted data.
- HAND_JOINT_POSITION_VALID =
4— If set, the positional data is valid, otherwise, the positional data is unreliable and should not be used.
- HAND_JOINT_POSITION_TRACKED =
8— If set, the positional data comes from tracking data, otherwise, the positional data contains predicted data.
- HAND_JOINT_LINEAR_VELOCITY_VALID =
16— If set, our linear velocity data is valid, otherwise, the linear velocity data is unreliable and should not be used.
- HAND_JOINT_ANGULAR_VELOCITY_VALID =
32— If set, our angular velocity data is valid, otherwise, the angular velocity data is unreliable and should not be used.
Property descriptions
Section titled “Property descriptions”display_refresh_rate
Section titled “display_refresh_rate”float display_refresh_rate = 0.0
Setter/getter: set_display_refresh_rate(), 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.
foveation_dynamic
Section titled “foveation_dynamic”bool foveation_dynamic = false
Setter/getter: set_foveation_dynamic(), get_foveation_dynamic()
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.
foveation_level
Section titled “foveation_level”int foveation_level = 0
Setter/getter: set_foveation_level(), get_foveation_level()
The foveation level, from 0 (off) to 3 (high). The interface must be initialized before this is accessible.
foveation_with_subsampled_images
Section titled “foveation_with_subsampled_images”bool foveation_with_subsampled_images = false
Setter/getter: set_foveation_with_subsampled_images(), get_foveation_with_subsampled_images()
If true, enables subsampled images with foveation, which can provide a performance boost on Vulkan.
render_target_size_multiplier
Section titled “render_target_size_multiplier”float render_target_size_multiplier = 1.0
Setter/getter: set_render_target_size_multiplier(), get_render_target_size_multiplier()
The render size multiplier for the current HMD. Must be set before the interface has been initialized.
vrs_min_radius
Section titled “vrs_min_radius”float vrs_min_radius = 20.0
Setter/getter: set_vrs_min_radius(), get_vrs_min_radius()
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.
vrs_strength
Section titled “vrs_strength”float vrs_strength = 1.0
Setter/getter: set_vrs_strength(), get_vrs_strength()
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.
xr_play_area_mode
Section titled “xr_play_area_mode”XRInterface.PlayAreaMode xr_play_area_mode = 0
Setter/getter: set_play_area_mode(), get_play_area_mode()
No description yet.
Method descriptions
Section titled “Method descriptions”get_action_sets
Section titled “get_action_sets”Array get_action_sets() const
Returns a list of action sets registered with Gobu (loaded from the action map at runtime).
get_available_display_refresh_rates
Section titled “get_available_display_refresh_rates”Array get_available_display_refresh_rates() const
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.
get_hand_joint_angular_velocity
Section titled “get_hand_joint_angular_velocity”Vector3 get_hand_joint_angular_velocity(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints) const
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!
get_hand_joint_flags
Section titled “get_hand_joint_flags”OpenXRInterface.HandJointFlags get_hand_joint_flags(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints) const
If handtracking is enabled, returns flags that inform us of the validity of the tracking data.
get_hand_joint_linear_velocity
Section titled “get_hand_joint_linear_velocity”Vector3 get_hand_joint_linear_velocity(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints) const
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!
get_hand_joint_position
Section titled “get_hand_joint_position”Vector3 get_hand_joint_position(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints) const
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!
get_hand_joint_radius
Section titled “get_hand_joint_radius”float get_hand_joint_radius(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints) const
If handtracking is enabled, returns the radius of a joint (joint) of a hand (hand) as provided by OpenXR. This is without worldscale applied!
get_hand_joint_rotation
Section titled “get_hand_joint_rotation”Quaternion get_hand_joint_rotation(hand: OpenXRInterface.Hand, joint: OpenXRInterface.HandJoints) const
If handtracking is enabled, returns the rotation of a joint (joint) of a hand (hand) as provided by OpenXR.
get_hand_tracking_source
Section titled “get_hand_tracking_source”OpenXRInterface.HandTrackedSource get_hand_tracking_source(hand: OpenXRInterface.Hand) const
If handtracking is enabled and hand tracking source is supported, gets the source of the hand tracking data for hand.
get_motion_range
Section titled “get_motion_range”OpenXRInterface.HandMotionRange get_motion_range(hand: OpenXRInterface.Hand) const
If handtracking is enabled and motion range is supported, gets the currently configured motion range for hand.
get_session_state
Section titled “get_session_state”OpenXRInterface.SessionState get_session_state()
Returns the current state of our OpenXR session.
is_action_set_active
Section titled “is_action_set_active”bool is_action_set_active(name: String) const
Returns true if the given action set is active.
is_eye_gaze_interaction_supported
Section titled “is_eye_gaze_interaction_supported”bool is_eye_gaze_interaction_supported()
Returns the capabilities of the eye gaze interaction extension.
Note: This only returns a valid value after OpenXR has been initialized.
is_foveation_supported
Section titled “is_foveation_supported”bool is_foveation_supported() const
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.
is_hand_interaction_supported
Section titled “is_hand_interaction_supported”bool is_hand_interaction_supported() const
Returns true if OpenXR’s hand interaction profile is supported and enabled.
Note: This only returns a valid value after OpenXR has been initialized.
is_hand_tracking_supported
Section titled “is_hand_tracking_supported”bool is_hand_tracking_supported()
Returns true if OpenXR’s hand tracking is supported and enabled.
Note: This only returns a valid value after OpenXR has been initialized.
is_user_presence_supported
Section titled “is_user_presence_supported”bool is_user_presence_supported() const
Returns true if OpenXR’s user presence extension is supported and enabled.
Note: This only returns a valid value after OpenXR has been initialized.
is_user_present
Section titled “is_user_present”bool is_user_present() const
Returns true if system has detected the presence of a user in the XR experience.
set_action_set_active
Section titled “set_action_set_active”void set_action_set_active(name: String, active: bool)
Sets the given action set as active or inactive.
set_cpu_level
Section titled “set_cpu_level”void set_cpu_level(level: OpenXRInterface.PerfSettingsLevel)
Sets the CPU performance level of the OpenXR device.
set_gpu_level
Section titled “set_gpu_level”void set_gpu_level(level: OpenXRInterface.PerfSettingsLevel)
Sets the GPU performance level of the OpenXR device.
set_motion_range
Section titled “set_motion_range”void set_motion_range(hand: OpenXRInterface.Hand, motion_range: OpenXRInterface.HandMotionRange)
If handtracking is enabled and motion range is supported, sets the currently configured motion range for hand to motion_range.