OpenXRInterface
繼承： XRInterface < RefCounted < Object
OpenXR 介面。
說明
OpenXR 介面允許 Godot 與 OpenXR 運作時進行互動，並使建立 XR 體驗和遊戲成為可能。
由於 OpenXR 的需要，該介面的工作方式與其他基於外掛程式的 XR 介面略有不同。它需要在 Godot 啟動時被初始化。若需要啟用 OpenXR，相關設定可以在遊戲專案設定中的 XR 標題下找到。你確實需要標記一個視口以與 XR 一起使用，以便 Godot 知道應該將哪個算繪結果輸出到頭戴式裝置。
教學
屬性
|
||
|
||
|
||
|
||
|
||
|
方法
get_action_sets() const |
|
get_hand_joint_angular_velocity(hand: Hand, joint: HandJoints) const |
|
BitField[HandJointFlags] |
get_hand_joint_flags(hand: Hand, joint: HandJoints) const |
get_hand_joint_linear_velocity(hand: Hand, joint: HandJoints) const |
|
get_hand_joint_position(hand: Hand, joint: HandJoints) const |
|
get_hand_joint_radius(hand: Hand, joint: HandJoints) const |
|
get_hand_joint_rotation(hand: Hand, joint: HandJoints) const |
|
get_hand_tracking_source(hand: Hand) const |
|
get_motion_range(hand: Hand) const |
|
is_action_set_active(name: String) const |
|
is_foveation_supported() const |
|
is_hand_interaction_supported() const |
|
void |
set_action_set_active(name: String, active: bool) |
void |
set_cpu_level(level: PerfSettingsLevel) |
void |
set_gpu_level(level: PerfSettingsLevel) |
void |
set_motion_range(hand: Hand, motion_range: HandMotionRange) |
訊號
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(sub_domain: int, from_level: int, to_level: int) 🔗
Informs the device GPU performance level has changed in the specified subdomain.
instance_exiting() 🔗
Informs our OpenXR instance is exiting.
pose_recentered() 🔗
通知使用者佇列玩家位置的重新居中。
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() 🔗
通知我們的 OpenXR 會話已經開始。
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() 🔗
Informs our OpenXR session is in the process of being lost.
session_stopping() 🔗
通知我們的 OpenXR 會話正在停止。
session_synchronized() 🔗
Informs our OpenXR session has been synchronized.
session_visible() 🔗
Informs our OpenXR session is now visible, for example output is sent to the HMD but we don't receive XR input.
列舉
enum SessionState: 🔗
SessionState SESSION_STATE_UNKNOWN = 0
The state of the session is unknown, we haven't tried setting up OpenXR yet.
SessionState SESSION_STATE_IDLE = 1
The initial state after the OpenXR session is created or after the session is destroyed.
SessionState SESSION_STATE_READY = 2
OpenXR is ready to begin our session. session_begun is emitted when we change to this state.
SessionState SESSION_STATE_SYNCHRONIZED = 3
The 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.
SessionState 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_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.
SessionState 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_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.
SessionState SESSION_STATE_STOPPING = 6
Our session is being stopped. session_stopping is emitted when we change to this state.
SessionState SESSION_STATE_LOSS_PENDING = 7
The session is about to be lost. session_loss_pending is emitted when we change to this state.
SessionState SESSION_STATE_EXITING = 8
The OpenXR instance is about to be destroyed and we're existing. instance_exiting is emitted when we change to this state.
enum Hand: 🔗
Hand HAND_LEFT = 0
左手。
Hand HAND_RIGHT = 1
右手。
Hand HAND_MAX = 2
模式列舉的最大值。
enum HandMotionRange: 🔗
HandMotionRange HAND_MOTION_RANGE_UNOBSTRUCTED = 0
Full hand range, if user closes their hands, we make a full fist.
HandMotionRange 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.
HandMotionRange HAND_MOTION_RANGE_MAX = 2
Maximum value for the motion range enum.
enum HandTrackedSource: 🔗
HandTrackedSource HAND_TRACKED_SOURCE_UNKNOWN = 0
The source of hand tracking data is unknown (the extension is likely unsupported).
HandTrackedSource 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.
HandTrackedSource HAND_TRACKED_SOURCE_CONTROLLER = 2
The source of hand tracking is a controller, bone positions are inferred from controller inputs.
HandTrackedSource HAND_TRACKED_SOURCE_MAX = 3
Represents the size of the HandTrackedSource enum.
enum HandJoints: 🔗
HandJoints HAND_JOINT_PALM = 0
掌關節。
HandJoints HAND_JOINT_WRIST = 1
腕關節。
HandJoints HAND_JOINT_THUMB_METACARPAL = 2
掌骨拇指關節。
HandJoints HAND_JOINT_THUMB_PROXIMAL = 3
拇指近端關節。
HandJoints HAND_JOINT_THUMB_DISTAL = 4
拇指遠端關節。
HandJoints HAND_JOINT_THUMB_TIP = 5
拇指尖端關節。
HandJoints HAND_JOINT_INDEX_METACARPAL = 6
Index finger metacarpal joint.
HandJoints HAND_JOINT_INDEX_PROXIMAL = 7
Index finger phalanx proximal joint.
HandJoints HAND_JOINT_INDEX_INTERMEDIATE = 8
Index finger phalanx intermediate joint.
HandJoints HAND_JOINT_INDEX_DISTAL = 9
Index finger phalanx distal joint.
HandJoints HAND_JOINT_INDEX_TIP = 10
Index finger tip joint.
HandJoints HAND_JOINT_MIDDLE_METACARPAL = 11
Middle finger metacarpal joint.
HandJoints HAND_JOINT_MIDDLE_PROXIMAL = 12
Middle finger phalanx proximal joint.
HandJoints HAND_JOINT_MIDDLE_INTERMEDIATE = 13
Middle finger phalanx intermediate joint.
HandJoints HAND_JOINT_MIDDLE_DISTAL = 14
Middle finger phalanx distal joint.
HandJoints HAND_JOINT_MIDDLE_TIP = 15
Middle finger tip joint.
HandJoints HAND_JOINT_RING_METACARPAL = 16
Ring finger metacarpal joint.
HandJoints HAND_JOINT_RING_PROXIMAL = 17
Ring finger phalanx proximal joint.
HandJoints HAND_JOINT_RING_INTERMEDIATE = 18
Ring finger phalanx intermediate joint.
HandJoints HAND_JOINT_RING_DISTAL = 19
Ring finger phalanx distal joint.
HandJoints HAND_JOINT_RING_TIP = 20
Ring finger tip joint.
HandJoints HAND_JOINT_LITTLE_METACARPAL = 21
Pinky finger metacarpal joint.
HandJoints HAND_JOINT_LITTLE_PROXIMAL = 22
Pinky finger phalanx proximal joint.
HandJoints HAND_JOINT_LITTLE_INTERMEDIATE = 23
Pinky finger phalanx intermediate joint.
HandJoints HAND_JOINT_LITTLE_DISTAL = 24
Pinky finger phalanx distal joint.
HandJoints HAND_JOINT_LITTLE_TIP = 25
Pinky finger tip joint.
HandJoints HAND_JOINT_MAX = 26
Represents the size of the HandJoints enum.
enum PerfSettingsLevel: 🔗
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.
PerfSettingsLevel 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.
PerfSettingsLevel 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.
PerfSettingsLevel 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: 🔗
PerfSettingsSubDomain PERF_SETTINGS_SUB_DOMAIN_COMPOSITING = 0
The compositing performance within the runtime has reached a new level.
PerfSettingsSubDomain PERF_SETTINGS_SUB_DOMAIN_RENDERING = 1
The application rendering performance has reached a new level.
PerfSettingsSubDomain PERF_SETTINGS_SUB_DOMAIN_THERMAL = 2
The temperature of the device has reached a new level.
enum PerfSettingsNotificationLevel: 🔗
PerfSettingsNotificationLevel PERF_SETTINGS_NOTIF_LEVEL_NORMAL = 0
The sub-domain has reached a level where no further actions other than currently applied are necessary.
PerfSettingsNotificationLevel PERF_SETTINGS_NOTIF_LEVEL_WARNING = 1
The sub-domain has reached an early warning level where the application should start proactive mitigation actions.
PerfSettingsNotificationLevel PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED = 2
The sub-domain has reached a critical level where the application should start drastic mitigation actions.
flags HandJointFlags: 🔗
HandJointFlags HAND_JOINT_NONE = 0
No flags are set.
HandJointFlags HAND_JOINT_ORIENTATION_VALID = 1
If set, the orientation data is valid, otherwise, the orientation data is unreliable and should not be used.
HandJointFlags HAND_JOINT_ORIENTATION_TRACKED = 2
If set, the orientation data comes from tracking data, otherwise, the orientation data contains predicted data.
HandJointFlags HAND_JOINT_POSITION_VALID = 4
If set, the positional data is valid, otherwise, the positional data is unreliable and should not be used.
HandJointFlags HAND_JOINT_POSITION_TRACKED = 8
If set, the positional data comes from tracking data, otherwise, the positional data contains predicted data.
HandJointFlags 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.
HandJointFlags 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.
屬性說明
float display_refresh_rate = 0.0 🔗
目前 HMD 的顯示更新率。僅當 OpenXR 運作時支援該功能並且介面已被初始化後才會有效。
bool foveation_dynamic = false 🔗
Enable dynamic foveation adjustment, the interface must be initialized before this is accessible. If enabled foveation will automatically adjusted between low and foveation_level.
Note: Only works on the Compatibility renderer.
Set foveation level from 0 (off) to 3 (high), the interface must be initialized before this is accessible.
Note: Only works on the Compatibility renderer.
float render_target_size_multiplier = 1.0 🔗
目前 HMD 的算繪大小乘數。必須在接觸初始化之前設定。
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.
方法說明
Array get_action_sets() const 🔗
返回向 Godot 註冊的動作集的列表（在運作時從動作對應載入）。
Array get_available_display_refresh_rates() const 🔗
返回目前 HMD 支援的顯示更新率。僅當 OpenXR 運作時支援該功能並且介面已被初始化後才會返回。
Vector3 get_hand_joint_angular_velocity(hand: Hand, joint: HandJoints) const 🔗
已棄用： Use XRHandTracker.get_hand_joint_angular_velocity() obtained from XRServer.get_tracker() instead.
如果啟用了手部追踪，則返回由 OpenXR 提供的手 (hand) 的關節 (joint) 的角速度。這是相對於 XROrigin3D！
BitField[HandJointFlags] get_hand_joint_flags(hand: Hand, joint: HandJoints) const 🔗
已棄用： Use XRHandTracker.get_hand_joint_flags() obtained from XRServer.get_tracker() instead.
If handtracking is enabled, returns flags that inform us of the validity of the tracking data.
Vector3 get_hand_joint_linear_velocity(hand: Hand, joint: HandJoints) const 🔗
已棄用： Use XRHandTracker.get_hand_joint_linear_velocity() obtained from XRServer.get_tracker() instead.
如果啟用手部追踪，則返回由 OpenXR 提供的手 (hand) 的關節 (joint) 的線速度。這是相對於 XROrigin3D 沒有應用世界尺度！
Vector3 get_hand_joint_position(hand: Hand, joint: HandJoints) const 🔗
已棄用： Use XRHandTracker.get_hand_joint_transform() obtained from XRServer.get_tracker() instead.
如果啟用手部追踪，則返回 OpenXR 提供的手 (hand) 的關節 (joint) 的位置。這是相對於 XROrigin3D 沒有應用世界尺度！
float get_hand_joint_radius(hand: Hand, joint: HandJoints) const 🔗
已棄用： Use XRHandTracker.get_hand_joint_radius() obtained from XRServer.get_tracker() instead.
如果啟用了手部追踪，則返回由 OpenXR 提供的手 (hand) 的關節 (joint) 的半徑。這沒有應用世界尺度！
Quaternion get_hand_joint_rotation(hand: Hand, joint: HandJoints) const 🔗
已棄用： Use XRHandTracker.get_hand_joint_transform() obtained from XRServer.get_tracker() instead.
如果啟用手部追踪，則返回 OpenXR 提供的手 (hand) 的關節 (joint) 的旋轉。
HandTrackedSource get_hand_tracking_source(hand: Hand) const 🔗
已棄用： Use XRHandTracker.hand_tracking_source obtained from XRServer.get_tracker() instead.
If handtracking is enabled and hand tracking source is supported, gets the source of the hand tracking data for hand.
HandMotionRange get_motion_range(hand: Hand) const 🔗
如果啟用了手部追蹤並且支援運動範圍，則取得hand 目前配置的運動範圍。
SessionState get_session_state() 🔗
Returns the current state of our OpenXR session.
bool is_action_set_active(name: String) const 🔗
如果給定的動作集處於活動狀態，則返回 true。
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.
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: This feature is only available on the Compatibility renderer and currently only available on some stand alone headsets. For Vulkan set Viewport.vrs_mode to VRS_XR on desktop.
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.
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.
void set_action_set_active(name: String, active: bool) 🔗
將給定的動作集設定為活動或非活動。
void set_cpu_level(level: PerfSettingsLevel) 🔗
Sets the CPU performance level of the OpenXR device.
void set_gpu_level(level: PerfSettingsLevel) 🔗
Sets the GPU performance level of the OpenXR device.
void set_motion_range(hand: Hand, motion_range: HandMotionRange) 🔗
如果啟用了手部追蹤並且支援運動範圍，則將hand 目前配置的運動範圍設為motion_range。