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...
OpenXRAPIExtension
繼承: RefCounted < Object
使 OpenXR API 可用於 GDExtension。
說明
OpenXRAPIExtension 使 OpenXR 可用於 GDExtension。它通過 get_instance_proc_addr() 方法向 GDExtension 提供 OpenXR API,並通過 get_instance() 提供 OpenXR 實例。
它還提供了用於查詢 OpenXR 初始化狀態的方法,以及便於通過 GDExtension 使用 API 的輔助方法。
教學
方法
列舉
enum OpenXRAlphaBlendModeSupport: 🔗
OpenXRAlphaBlendModeSupport OPENXR_ALPHA_BLEND_MODE_SUPPORT_NONE = 0
表示完全不支援 XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND。
OpenXRAlphaBlendModeSupport OPENXR_ALPHA_BLEND_MODE_SUPPORT_REAL = 1
表示確實支援 XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND。
OpenXRAlphaBlendModeSupport OPENXR_ALPHA_BLEND_MODE_SUPPORT_EMULATING = 2
方法說明
int action_get_handle(action: RID) 🔗
回傳與給定動作 RID 對應的 XrAction OpenXR 控制代碼。
void begin_debug_label_region(label_name: String) 🔗
開啟新的除錯標籤區域,此後的呼叫所產生的除錯資訊中會彙報該標籤,直到呼叫 end_debug_label_region()。可以堆疊除錯標籤。
如果通訊端是打開的,並且在監聽埠,則返回 true。
void end_debug_label_region() 🔗
標記除錯標籤區域的末尾。移除最新的通過呼叫 begin_debug_label_region() 新增的除錯標籤區域。
RID find_action(name: String, action_set: RID) 🔗
回傳與名稱匹配的動作所對應的 RID,還可以將匹配範圍限制在指定的動作集中。
String get_error_string(result: int) 🔗
回傳給定XrResult.
int get_hand_tracker(hand_index: int) 🔗
回傳給定手索引值的相應 XRHandTrackerEXT 控制代碼。
回傳 OpenXR API 初始化過程中建立的 XrInstance。
int get_instance_proc_addr(name: String) 🔗
傳回指定名稱的OpenXR函式的函式指針,轉換為整數。如果指定名稱的函式不存在,則該方法傳回0。
注意: openxr/util.h 包含用於取得OpenXR 函式的實用宏,例如GDEXTENSION_INIT_XR_FUNC_V(xrCreateAction)。
回傳下一影格的預測顯示時間。
回傳已初始化的 OpenXR 版本。僅在 OpenXR 實例建立後有效。有關版本計算方法,請參閱 XR_MAKE_VERSION。
回傳播放空間,這是一個 XrSpace 轉換為整數。
int get_predicted_display_time() 🔗
回傳目前影格的預測顯示時間。
int get_primary_view_count() const 🔗
Returns the view count for the primary viewport.
回傳指向渲染狀態中 XrCompositionLayerProjection 結構體的指針。
注意:該方法只應從渲染執行緒呼叫。
float get_render_state_z_far() 🔗
回傳相機視錐的遠端邊界值。
注意:只能在渲染執行緒中存取。
float get_render_state_z_near() 🔗
回傳相機視錐的近端邊界值。
注意:只能在渲染執行緒中存取。
回傳 OpenXR 會話,它是一個 XrSession 轉換為整數。
PackedInt64Array get_supported_swapchain_formats() 🔗
回傳支援的交換鏈格式的陣列。
String get_swapchain_format_name(swapchain_format: int) 🔗
返回指定參數的值。
回傳系統的 ID,該 ID 是一個被轉換為整數的 XrSystemId 型別值。
int get_view_configuration() const 🔗
回傳檢視設定型別,它是一個被強制轉換為整數的 XrViewConfigurationType。
回傳檢視的數量。通常為兩個(每隻眼睛對應一個),但在不同的檢視設定下可能會有所不同。
void insert_debug_label(label_name: String) 🔗
插入除錯標籤,此後的 OpenXR 呼叫所產生的除錯資訊中會彙報該標籤,直到呼叫 begin_debug_label_region()、end_debug_label_region() 或 insert_debug_label()。
OpenXRAlphaBlendModeSupport is_environment_blend_mode_alpha_supported() 🔗
回傳 OpenXRAlphaBlendModeSupport 表示 XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND 是否確實受支援、模擬或根本不支援。
如果 OpenXR 已初始化,則返回 true。
如果OpenXR 正在運作,則傳回true (xrBeginSession 已成功呼叫並建立了交換鏈)。
bool openxr_is_enabled(check_run_in_editor: bool) static 🔗
如果啟用 OpenXR,則返回 true。
void openxr_swapchain_acquire(swapchain: int) 🔗
取得給定交換鏈的影像。
int openxr_swapchain_create(create_flags: int, usage_flags: int, swapchain_format: int, width: int, height: int, sample_count: int, array_size: int) 🔗
回傳一個指針,指向使用給定參數建立的新交換鏈。
void openxr_swapchain_free(swapchain: int) 🔗
銷毀給定的交換鏈並在記憶體中將其釋放。
RID openxr_swapchain_get_image(swapchain: int) 🔗
回傳給定交換鏈影像的 RID。
int openxr_swapchain_get_swapchain(swapchain: int) 🔗
回傳給定交換鏈的 XrSwapchain 控制代碼。
void openxr_swapchain_release(swapchain: int) 🔗
釋放給定交換鏈的影像。
void register_composition_layer_provider(extension: OpenXRExtensionWrapper) 🔗
將給定的擴充注冊為合成層提供程式。
注意:該方法不能在 OpenXR 會話啟動後呼叫。但是,可以在 OpenXRExtensionWrapper._on_session_created() 方法中呼叫它。
void register_frame_info_extension(extension: OpenXRExtensionWrapper) 🔗
將給定擴充注冊為會通過 OpenXRExtensionWrapper._set_frame_wait_info_and_get_next_pointer()、OpenXRExtensionWrapper._set_view_locate_info_and_get_next_pointer()、OpenXRExtensionWrapper._set_frame_end_info_and_get_next_pointer() 等虛方法修改影格資訊。
注意:該方法不能在 OpenXR 會話啟動後呼叫。但是,可以在 OpenXRExtensionWrapper._on_session_created() 方法中呼叫它。
void register_projection_layer_extension(extension: OpenXRExtensionWrapper) 🔗
通過 OpenXRExtensionWrapper._set_projection_layer_and_get_next_pointer() 虛方法,注冊給定的擴充以用於修改 XrCompositionLayerProjection。
注意: 此方法不能在 OpenXR 會話啟動後被呼叫。不過,可以在 OpenXRExtensionWrapper._on_session_created() 中呼叫它。
void register_projection_views_extension(extension: OpenXRExtensionWrapper) 🔗
將給定的擴充程式注冊為向投影檢視提供附加資料結構的提供程式。
注意:該方法不能在 OpenXR 會話啟動後呼叫。但是,可以在 OpenXRExtensionWrapper._on_session_created() 方法中呼叫它。
void set_custom_play_space(space: const void*) 🔗
將 OpenXR 所使用的參考空間設定為給定的 XrSpace(轉換為 void *)。
void set_emulate_environment_blend_mode_alpha_blend(enabled: bool) 🔗
如果設定為 true,則會載入 OpenXR 擴充,該擴充能夠模擬 XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND 混合模式。
void set_object_name(object_type: int, object_handle: int, object_name: String) 🔗
設定 OpenXR 物件的物件名稱,用於除錯輸出。object_type 必須是有效的 OpenXR XrObjectType 列舉,object_handle 必須是有效的 OpenXR 物件控制代碼。
void set_render_region(render_region: Rect2i) 🔗
將渲染區域設定為 render_region,覆蓋常規渲染目標的矩形區域。
void set_velocity_depth_texture(render_target: RID) 🔗
設定速度深度紋理的渲染目標。
void set_velocity_target_size(target_size: Vector2i) 🔗
設定速度紋理和速度深度紋理的目標大小。
void set_velocity_texture(render_target: RID) 🔗
設定速度紋理的渲染目標。
Transform3D transform_from_pose(pose: const void*) 🔗
從 XrPosef.
void unregister_composition_layer_provider(extension: OpenXRExtensionWrapper) 🔗
將給定的擴充取消注冊為合成層提供器。
注意:它無法在 OpenXR 會話仍在執行時被呼叫。
void unregister_frame_info_extension(extension: OpenXRExtensionWrapper) 🔗
將給定的擴充程式取消注冊為修改影格資訊的功能。
注意:它無法在 OpenXR 會話仍在執行時被呼叫。
void unregister_projection_layer_extension(extension: OpenXRExtensionWrapper) 🔗
注銷(取消注冊)給定的擴充,使其不再對 XrCompositionLayerProjection 進行修改。
注意: 不能在 OpenXR 會話仍在執行時呼叫此方法。
void unregister_projection_views_extension(extension: OpenXRExtensionWrapper) 🔗
將給定的擴充取消注冊為投影檢視的附加資料結構提供器。
注意:它無法在 OpenXR 會話仍在執行時被呼叫。
void update_main_swapchain_size() 🔗
從 OpenXR 執行時請求推薦的解析度,如果解析度發生變化,則更新主交換鏈的大小。
bool xr_result(result: int, format: String, args: Array) 🔗
如果提供的 XrResult(轉換為整數)成功則回傳true。否則返回 false 並列印 XrResult 轉換為字串,帶有指定的附加資訊。