OpenXR: Support alternative reference spaces from extensions

m4gr3d · Mar 3, 2025 · 7d6e6e9 · 7d6e6e9
1 parent 4c311cb
commit 7d6e6e9
Show file tree

Hide file tree

Showing 13 changed files with 237 additions and 17 deletions.
diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml
@@ -263,6 +263,8 @@
 		<constant name="XR_PLAY_AREA_STAGE" value="4" enum="PlayAreaMode">
 			Same as [constant XR_PLAY_AREA_ROOMSCALE] but origin point is fixed to the center of the physical space. In this mode, system-level recentering may be disabled, requiring the use of [method XRServer.center_on_hmd].
 		</constant>
+		<constant name="XR_PLAY_AREA_CUSTOM" value="2147483647" enum="PlayAreaMode">
+		</constant>
 		<constant name="XR_ENV_BLEND_MODE_OPAQUE" value="0" enum="EnvironmentBlendMode">
 			Opaque blend mode. This is typically used for VR devices.
 		</constant>

diff --git a/modules/openxr/doc_classes/OpenXRAPIExtension.xml b/modules/openxr/doc_classes/OpenXRAPIExtension.xml
@@ -230,13 +230,25 @@
 				Registers the given extension as a composition layer provider.
 			</description>
 		</method>
+		<method name="register_frame_info_extension">
+			<return type="void" />
+			<param index="0" name="extension" type="OpenXRExtensionWrapperExtension" />
+			<description>
+			</description>
+		</method>
 		<method name="register_projection_views_extension">
 			<return type="void" />
 			<param index="0" name="extension" type="OpenXRExtensionWrapperExtension" />
 			<description>
 				Registers the given extension as a provider of additional data structures to projections views.
 			</description>
 		</method>
+		<method name="set_custom_play_space">
+			<return type="void" />
+			<param index="0" name="_unnamed_arg0" type="const void*" />
+			<description>
+			</description>
+		</method>
 		<method name="set_emulate_environment_blend_mode_alpha_blend">
 			<return type="void" />
 			<param index="0" name="enabled" type="bool" />
@@ -295,6 +307,12 @@
 				Unregisters the given extension as a composition layer provider.
 			</description>
 		</method>
+		<method name="unregister_frame_info_extension">
+			<return type="void" />
+			<param index="0" name="extension" type="OpenXRExtensionWrapperExtension" />
+			<description>
+			</description>
+		</method>
 		<method name="unregister_projection_views_extension">
 			<return type="void" />
 			<param index="0" name="extension" type="OpenXRExtensionWrapperExtension" />

diff --git a/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml b/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml
@@ -202,6 +202,18 @@
 				[param property_values] contains the values of the properties returned by [method _get_viewport_composition_layer_extension_properties].
 			</description>
 		</method>
+		<method name="_set_frame_end_info_and_get_next_pointer" qualifiers="virtual">
+			<return type="int" />
+			<param index="0" name="next_pointer" type="void*" />
+			<description>
+			</description>
+		</method>
+		<method name="_set_frame_wait_info_and_get_next_pointer" qualifiers="virtual">
+			<return type="int" />
+			<param index="0" name="next_pointer" type="void*" />
+			<description>
+			</description>
+		</method>
 		<method name="_set_hand_joint_locations_and_get_next_pointer" qualifiers="virtual">
 			<return type="int" />
 			<param index="0" name="hand_index" type="int" />
@@ -225,6 +237,13 @@
 				Adds additional data structures to the projection view of the given [param view_index].
 			</description>
 		</method>
+		<method name="_set_reference_space_create_info_and_get_next_pointer" qualifiers="virtual">
+			<return type="int" />
+			<param index="0" name="reference_space_type" type="int" />
+			<param index="1" name="next_pointer" type="void*" />
+			<description>
+			</description>
+		</method>
 		<method name="_set_session_create_and_get_next_pointer" qualifiers="virtual">
 			<return type="int" />
 			<param index="0" name="next_pointer" type="void*" />
@@ -246,6 +265,12 @@
 				Adds additional data structures when querying OpenXR system abilities.
 			</description>
 		</method>
+		<method name="_set_view_locate_info_and_get_next_pointer" qualifiers="virtual">
+			<return type="int" />
+			<param index="0" name="next_pointer" type="void*" />
+			<description>
+			</description>
+		</method>
 		<method name="_set_viewport_composition_layer_and_get_next_pointer" qualifiers="virtual">
 			<return type="int" />
 			<param index="0" name="layer" type="const void*" />

diff --git a/modules/openxr/extensions/openxr_extension_wrapper.h b/modules/openxr/extensions/openxr_extension_wrapper.h
@@ -63,6 +63,11 @@ class OpenXRExtensionWrapper {
 	virtual void *set_swapchain_create_info_and_get_next_pointer(void *p_next_pointer) { return p_next_pointer; } // Add additional data structures when creating OpenXR swap chains.
 	virtual void *set_hand_joint_locations_and_get_next_pointer(int p_hand_index, void *p_next_pointer) { return p_next_pointer; }
 	virtual void *set_projection_views_and_get_next_pointer(int p_view_index, void *p_next_pointer) { return p_next_pointer; }
+	virtual void *set_reference_space_create_info_and_get_next_pointer(int p_reference_space_type, void *p_next_pointer) { return p_next_pointer; }
+	// These will only be called for extensions registered via OpenXRApi::register_frame_info_extension().
+	virtual void *set_frame_wait_info_and_get_next_pointer(void *p_next_pointer) { return p_next_pointer; } // Add additional data structures when calling xrWaitFrame
+	virtual void *set_view_locate_info_and_get_next_pointer(void *p_next_pointer) { return p_next_pointer; } // Add additional data structures when calling xrLocateViews
+	virtual void *set_frame_end_info_and_get_next_pointer(void *p_next_pointer) { return p_next_pointer; } // Add additional data structures when calling xrEndFrame
 
 	virtual PackedStringArray get_suggested_tracker_names() { return PackedStringArray(); }
 

diff --git a/modules/openxr/extensions/openxr_extension_wrapper_extension.cpp b/modules/openxr/extensions/openxr_extension_wrapper_extension.cpp
@@ -40,6 +40,10 @@ void OpenXRExtensionWrapperExtension::_bind_methods() {
 	GDVIRTUAL_BIND(_set_swapchain_create_info_and_get_next_pointer, "next_pointer");
 	GDVIRTUAL_BIND(_set_hand_joint_locations_and_get_next_pointer, "hand_index", "next_pointer");
 	GDVIRTUAL_BIND(_set_projection_views_and_get_next_pointer, "view_index", "next_pointer");
+	GDVIRTUAL_BIND(_set_frame_wait_info_and_get_next_pointer, "next_pointer");
+	GDVIRTUAL_BIND(_set_frame_end_info_and_get_next_pointer, "next_pointer");
+	GDVIRTUAL_BIND(_set_view_locate_info_and_get_next_pointer, "next_pointer");
+	GDVIRTUAL_BIND(_set_reference_space_create_info_and_get_next_pointer, "reference_space_type", "next_pointer");
 	GDVIRTUAL_BIND(_get_composition_layer_count);
 	GDVIRTUAL_BIND(_get_composition_layer, "index");
 	GDVIRTUAL_BIND(_get_composition_layer_order, "index");
@@ -151,6 +155,46 @@ void *OpenXRExtensionWrapperExtension::set_projection_views_and_get_next_pointer
 	return nullptr;
 }
 
+void *OpenXRExtensionWrapperExtension::set_reference_space_create_info_and_get_next_pointer(int p_reference_space_type, void *p_next_pointer) {
+	uint64_t pointer;
+
+	if (GDVIRTUAL_CALL(_set_reference_space_create_info_and_get_next_pointer, p_reference_space_type, GDExtensionPtr<void>(p_next_pointer), pointer)) {
+		return reinterpret_cast<void *>(pointer);
+	}
+
+	return nullptr;
+}
+
+void *OpenXRExtensionWrapperExtension::set_frame_wait_info_and_get_next_pointer(void *p_next_pointer) {
+	uint64_t pointer;
+
+	if (GDVIRTUAL_CALL(_set_frame_wait_info_and_get_next_pointer, GDExtensionPtr<void>(p_next_pointer), pointer)) {
+		return reinterpret_cast<void *>(pointer);
+	}
+
+	return nullptr;
+}
+
+void *OpenXRExtensionWrapperExtension::set_frame_end_info_and_get_next_pointer(void *p_next_pointer) {
+	uint64_t pointer;
+
+	if (GDVIRTUAL_CALL(_set_frame_end_info_and_get_next_pointer, GDExtensionPtr<void>(p_next_pointer), pointer)) {
+		return reinterpret_cast<void *>(pointer);
+	}
+
+	return nullptr;
+}
+
+void *OpenXRExtensionWrapperExtension::set_view_locate_info_and_get_next_pointer(void *p_next_pointer) {
+	uint64_t pointer;
+
+	if (GDVIRTUAL_CALL(_set_view_locate_info_and_get_next_pointer, GDExtensionPtr<void>(p_next_pointer), pointer)) {
+		return reinterpret_cast<void *>(pointer);
+	}
+
+	return nullptr;
+}
+
 PackedStringArray OpenXRExtensionWrapperExtension::get_suggested_tracker_names() {
 	PackedStringArray ret;
 

diff --git a/modules/openxr/extensions/openxr_extension_wrapper_extension.h b/modules/openxr/extensions/openxr_extension_wrapper_extension.h
@@ -60,6 +60,10 @@ class OpenXRExtensionWrapperExtension : public Object, public OpenXRExtensionWra
 	virtual void *set_swapchain_create_info_and_get_next_pointer(void *p_next_pointer) override;
 	virtual void *set_hand_joint_locations_and_get_next_pointer(int p_hand_index, void *p_next_pointer) override;
 	virtual void *set_projection_views_and_get_next_pointer(int p_view_index, void *p_next_pointer) override;
+	virtual void *set_frame_wait_info_and_get_next_pointer(void *p_next_pointer) override;
+	virtual void *set_view_locate_info_and_get_next_pointer(void *p_next_pointer) override;
+	virtual void *set_frame_end_info_and_get_next_pointer(void *p_next_pointer) override;
+	virtual void *set_reference_space_create_info_and_get_next_pointer(int p_reference_space_type, void *p_next_pointer) override;
 
 	virtual int get_composition_layer_count() override;
 	virtual XrCompositionLayerBaseHeader *get_composition_layer(int p_index) override;
@@ -72,6 +76,10 @@ class OpenXRExtensionWrapperExtension : public Object, public OpenXRExtensionWra
 	GDVIRTUAL1R(uint64_t, _set_swapchain_create_info_and_get_next_pointer, GDExtensionPtr<void>);
 	GDVIRTUAL2R(uint64_t, _set_hand_joint_locations_and_get_next_pointer, int, GDExtensionPtr<void>);
 	GDVIRTUAL2R(uint64_t, _set_projection_views_and_get_next_pointer, int, GDExtensionPtr<void>);
+	GDVIRTUAL1R(uint64_t, _set_frame_wait_info_and_get_next_pointer, GDExtensionPtr<void>);
+	GDVIRTUAL1R(uint64_t, _set_frame_end_info_and_get_next_pointer, GDExtensionPtr<void>);
+	GDVIRTUAL1R(uint64_t, _set_view_locate_info_and_get_next_pointer, GDExtensionPtr<void>);
+	GDVIRTUAL2R(uint64_t, _set_reference_space_create_info_and_get_next_pointer, int, GDExtensionPtr<void>);
 	GDVIRTUAL0R(int, _get_composition_layer_count);
 	GDVIRTUAL1R(uint64_t, _get_composition_layer, int);
 	GDVIRTUAL1R(int, _get_composition_layer_order, int);