From e31c2e42774f0b56608662f239a32f7734513a99 Mon Sep 17 00:00:00 2001 From: Bastiaan Olij Date: Mon, 13 Mar 2023 12:26:10 +1100 Subject: [PATCH] Add a get_system_info method to XRInterface --- doc/classes/XRInterface.xml | 7 +++++++ doc/classes/XRInterfaceExtension.xml | 6 ++++++ modules/mobile_vr/mobile_vr_interface.cpp | 9 +++++++++ modules/mobile_vr/mobile_vr_interface.h | 1 + modules/openxr/openxr_api.cpp | 7 ++++++- modules/openxr/openxr_api.h | 6 ++++++ modules/openxr/openxr_interface.cpp | 11 +++++++++++ modules/openxr/openxr_interface.h | 1 + modules/webxr/webxr_interface_js.cpp | 10 ++++++++++ modules/webxr/webxr_interface_js.h | 1 + servers/xr/xr_interface.cpp | 1 + servers/xr/xr_interface.h | 1 + servers/xr/xr_interface_extension.cpp | 7 +++++++ servers/xr/xr_interface_extension.h | 2 ++ 14 files changed, 69 insertions(+), 1 deletion(-) diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index d8776fee39a..911e0f6bf69 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -57,6 +57,13 @@ Returns the an array of supported environment blend modes, see [enum XRInterface.EnvironmentBlendMode]. + + + + Returns a [Dictionary] with extra system info. Interfaces are expected to return [code]XRRuntimeName[/code] and [code]XRRuntimeVersion[/code] providing info about the used XR runtime. Additional entries may be provided specific to an interface. + [b]Note:[/b]This information may only be available after [method initialize] was successfully called. + + diff --git a/doc/classes/XRInterfaceExtension.xml b/doc/classes/XRInterfaceExtension.xml index 217cde269e4..129465c2ada 100644 --- a/doc/classes/XRInterfaceExtension.xml +++ b/doc/classes/XRInterfaceExtension.xml @@ -98,6 +98,12 @@ Returns a [PackedStringArray] with tracker names configured by this interface. Note that user configuration can override this list. + + + + Returns a [Dictionary] with system informationr elated to this interface. + + diff --git a/modules/mobile_vr/mobile_vr_interface.cpp b/modules/mobile_vr/mobile_vr_interface.cpp index 5fab53441c0..94a3f0777ea 100644 --- a/modules/mobile_vr/mobile_vr_interface.cpp +++ b/modules/mobile_vr/mobile_vr_interface.cpp @@ -372,6 +372,15 @@ void MobileVRInterface::uninitialize() { }; }; +Dictionary MobileVRInterface::get_system_info() { + Dictionary dict; + + dict[SNAME("XRRuntimeName")] = String("Godot mobile VR interface"); + dict[SNAME("XRRuntimeVersion")] = String(""); + + return dict; +} + bool MobileVRInterface::supports_play_area_mode(XRInterface::PlayAreaMode p_mode) { // This interface has no positional tracking so fix this to 3DOF return p_mode == XR_PLAY_AREA_3DOF; diff --git a/modules/mobile_vr/mobile_vr_interface.h b/modules/mobile_vr/mobile_vr_interface.h index 12075eda82e..f680d8aa115 100644 --- a/modules/mobile_vr/mobile_vr_interface.h +++ b/modules/mobile_vr/mobile_vr_interface.h @@ -141,6 +141,7 @@ public: virtual bool is_initialized() const override; virtual bool initialize() override; virtual void uninitialize() override; + virtual Dictionary get_system_info() override; virtual bool supports_play_area_mode(XRInterface::PlayAreaMode p_mode) override; virtual XRInterface::PlayAreaMode get_play_area_mode() const override; diff --git a/modules/openxr/openxr_api.cpp b/modules/openxr/openxr_api.cpp index ddb3114b595..85095710128 100644 --- a/modules/openxr/openxr_api.cpp +++ b/modules/openxr/openxr_api.cpp @@ -385,8 +385,13 @@ bool OpenXRAPI::create_instance() { if (XR_FAILED(result)) { // not fatal probably print_line("OpenXR: Failed to get XR instance properties [", get_error_string(result), "]"); + + runtime_name = ""; + runtime_version = ""; } else { - print_line("OpenXR: Running on OpenXR runtime: ", instanceProps.runtimeName, " ", OpenXRUtil::make_xr_version_string(instanceProps.runtimeVersion)); + runtime_name = instanceProps.runtimeName; + runtime_version = OpenXRUtil::make_xr_version_string(instanceProps.runtimeVersion); + print_line("OpenXR: Running on OpenXR runtime: ", runtime_name, " ", runtime_version); } for (OpenXRExtensionWrapper *wrapper : registered_extension_wrappers) { diff --git a/modules/openxr/openxr_api.h b/modules/openxr/openxr_api.h index 8c642c4ff43..c8bef5d420c 100644 --- a/modules/openxr/openxr_api.h +++ b/modules/openxr/openxr_api.h @@ -95,6 +95,10 @@ private: uint32_t num_swapchain_formats = 0; int64_t *supported_swapchain_formats = nullptr; + // system info + String runtime_name; + String runtime_version; + // configuration XrFormFactor form_factor = XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY; XrViewConfigurationType view_configuration = XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO; @@ -294,6 +298,8 @@ public: XrInstance get_instance() const { return instance; }; XrSystemId get_system_id() const { return system_id; }; XrSession get_session() const { return session; }; + String get_runtime_name() const { return runtime_name; }; + String get_runtime_version() const { return runtime_version; }; // helper method to convert an XrPosef to a Transform3D Transform3D transform_from_pose(const XrPosef &p_pose); diff --git a/modules/openxr/openxr_interface.cpp b/modules/openxr/openxr_interface.cpp index 51de9b913af..27344c9da74 100644 --- a/modules/openxr/openxr_interface.cpp +++ b/modules/openxr/openxr_interface.cpp @@ -583,6 +583,17 @@ void OpenXRInterface::uninitialize() { initialized = false; } +Dictionary OpenXRInterface::get_system_info() { + Dictionary dict; + + if (openxr_api) { + dict[SNAME("XRRuntimeName")] = openxr_api->get_runtime_name(); + dict[SNAME("XRRuntimeVersion")] = openxr_api->get_runtime_version(); + } + + return dict; +} + bool OpenXRInterface::supports_play_area_mode(XRInterface::PlayAreaMode p_mode) { return false; } diff --git a/modules/openxr/openxr_interface.h b/modules/openxr/openxr_interface.h index 40ee95f02fc..de758a8c2d6 100644 --- a/modules/openxr/openxr_interface.h +++ b/modules/openxr/openxr_interface.h @@ -112,6 +112,7 @@ public: virtual bool is_initialized() const override; virtual bool initialize() override; virtual void uninitialize() override; + virtual Dictionary get_system_info() override; virtual void trigger_haptic_pulse(const String &p_action_name, const StringName &p_tracker_name, double p_frequency, double p_amplitude, double p_duration_sec, double p_delay_sec = 0) override; diff --git a/modules/webxr/webxr_interface_js.cpp b/modules/webxr/webxr_interface_js.cpp index 97b2eea4d76..d3710bd0dff 100644 --- a/modules/webxr/webxr_interface_js.cpp +++ b/modules/webxr/webxr_interface_js.cpp @@ -301,6 +301,16 @@ void WebXRInterfaceJS::uninitialize() { }; }; +Dictionary WebXRInterfaceJS::get_system_info() { + Dictionary dict; + + // TODO get actual information from WebXR to return here + dict[SNAME("XRRuntimeName")] = String("WebXR"); + dict[SNAME("XRRuntimeVersion")] = String(""); + + return dict; +} + Transform3D WebXRInterfaceJS::_js_matrix_to_transform(float *p_js_matrix) { Transform3D transform; diff --git a/modules/webxr/webxr_interface_js.h b/modules/webxr/webxr_interface_js.h index 31d2e200c0f..20516e89e29 100644 --- a/modules/webxr/webxr_interface_js.h +++ b/modules/webxr/webxr_interface_js.h @@ -108,6 +108,7 @@ public: virtual bool is_initialized() const override; virtual bool initialize() override; virtual void uninitialize() override; + virtual Dictionary get_system_info() override; virtual Size2 get_render_target_size() override; virtual uint32_t get_view_count() override; diff --git a/servers/xr/xr_interface.cpp b/servers/xr/xr_interface.cpp index 7f3d8668a46..416f08dbb6e 100644 --- a/servers/xr/xr_interface.cpp +++ b/servers/xr/xr_interface.cpp @@ -43,6 +43,7 @@ void XRInterface::_bind_methods() { ClassDB::bind_method(D_METHOD("is_initialized"), &XRInterface::is_initialized); ClassDB::bind_method(D_METHOD("initialize"), &XRInterface::initialize); ClassDB::bind_method(D_METHOD("uninitialize"), &XRInterface::uninitialize); + ClassDB::bind_method(D_METHOD("get_system_info"), &XRInterface::get_system_info); ClassDB::bind_method(D_METHOD("get_tracking_status"), &XRInterface::get_tracking_status); diff --git a/servers/xr/xr_interface.h b/servers/xr/xr_interface.h index c32455f4663..44275285c83 100644 --- a/servers/xr/xr_interface.h +++ b/servers/xr/xr_interface.h @@ -100,6 +100,7 @@ public: virtual bool is_initialized() const = 0; /* returns true if we've initialized this interface */ virtual bool initialize() = 0; /* initialize this interface, if this has an HMD it becomes the primary interface */ virtual void uninitialize() = 0; /* deinitialize this interface */ + virtual Dictionary get_system_info() = 0; /* return a dictionary with info about our system */ /** input and output **/ diff --git a/servers/xr/xr_interface_extension.cpp b/servers/xr/xr_interface_extension.cpp index 0ff59d2a39c..93042baec54 100644 --- a/servers/xr/xr_interface_extension.cpp +++ b/servers/xr/xr_interface_extension.cpp @@ -39,6 +39,7 @@ void XRInterfaceExtension::_bind_methods() { GDVIRTUAL_BIND(_is_initialized); GDVIRTUAL_BIND(_initialize); GDVIRTUAL_BIND(_uninitialize); + GDVIRTUAL_BIND(_get_system_info); GDVIRTUAL_BIND(_supports_play_area_mode, "mode"); GDVIRTUAL_BIND(_get_play_area_mode); @@ -119,6 +120,12 @@ void XRInterfaceExtension::uninitialize() { GDVIRTUAL_CALL(_uninitialize); } +Dictionary XRInterfaceExtension::get_system_info() { + Dictionary dict; + GDVIRTUAL_CALL(_get_system_info, dict); + return dict; +} + PackedStringArray XRInterfaceExtension::get_suggested_tracker_names() const { PackedStringArray arr; diff --git a/servers/xr/xr_interface_extension.h b/servers/xr/xr_interface_extension.h index 454a50cb287..5ec19a975d2 100644 --- a/servers/xr/xr_interface_extension.h +++ b/servers/xr/xr_interface_extension.h @@ -57,10 +57,12 @@ public: virtual bool is_initialized() const override; virtual bool initialize() override; virtual void uninitialize() override; + virtual Dictionary get_system_info() override; GDVIRTUAL0RC(bool, _is_initialized); GDVIRTUAL0R(bool, _initialize); GDVIRTUAL0(_uninitialize); + GDVIRTUAL0RC(Dictionary, _get_system_info); /** input and output **/