Add XR Environment Blend Mode Support

2 files changed, 25 insertions, 0 deletions

diff --git a/servers/xr/xr_interface.cpp b/servers/xr/xr_interface.cpp
index 9968a47b0c..7f3d8668a4 100644
--- a/servers/xr/xr_interface.cpp
+++ b/servers/xr/xr_interface.cpp
@@ -75,6 +75,10 @@ void XRInterface::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_transform_for_view", "view", "cam_transform"), &XRInterface::get_transform_for_view);
 	ClassDB::bind_method(D_METHOD("get_projection_for_view", "view", "aspect", "near", "far"), &XRInterface::get_projection_for_view);
 
+	/** environment blend mode. */
+	ClassDB::bind_method(D_METHOD("get_supported_environment_blend_modes"), &XRInterface::get_supported_environment_blend_modes);
+	ClassDB::bind_method(D_METHOD("set_environment_blend_mode", "mode"), &XRInterface::set_environment_blend_mode);
+
 	ADD_GROUP("AR", "ar_");
 	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "ar_is_anchor_detection_enabled"), "set_anchor_detection_is_enabled", "get_anchor_detection_is_enabled");
 
@@ -97,6 +101,10 @@ void XRInterface::_bind_methods() {
 	BIND_ENUM_CONSTANT(XR_PLAY_AREA_SITTING);
 	BIND_ENUM_CONSTANT(XR_PLAY_AREA_ROOMSCALE);
 	BIND_ENUM_CONSTANT(XR_PLAY_AREA_STAGE);
+
+	BIND_ENUM_CONSTANT(XR_ENV_BLEND_MODE_OPAQUE);
+	BIND_ENUM_CONSTANT(XR_ENV_BLEND_MODE_ADDITIVE);
+	BIND_ENUM_CONSTANT(XR_ENV_BLEND_MODE_ALPHA_BLEND);
 };
 
 bool XRInterface::is_primary() {
@@ -273,3 +281,9 @@ XRInterface::TrackingStatus XRInterface::get_tracking_status() const {
 
 void XRInterface::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) {
 }
+
+Array XRInterface::get_supported_environment_blend_modes() {
+	Array default_blend_modes;
+	default_blend_modes.push_back(XR_ENV_BLEND_MODE_OPAQUE);
+	return default_blend_modes;
+}
diff --git a/servers/xr/xr_interface.h b/servers/xr/xr_interface.h
index 6f70f75772..c32455f466 100644
--- a/servers/xr/xr_interface.h
+++ b/servers/xr/xr_interface.h
@@ -78,6 +78,12 @@ public:
 		XR_PLAY_AREA_STAGE, /* Same as roomscale but origin point is fixed to the center of the physical space, XRServer.center_on_hmd disabled */
 	};
 
+	enum EnvironmentBlendMode {
+		XR_ENV_BLEND_MODE_OPAQUE, /* You cannot see the real world, VR like */
+		XR_ENV_BLEND_MODE_ADDITIVE, /* You can see the real world, AR like */
+		XR_ENV_BLEND_MODE_ALPHA_BLEND, /* Real world is passed through where alpha channel is 0.0 and gradually blends to opaque for value 1.0. */
+	};
+
 protected:
 	_THREAD_SAFE_CLASS_
 
@@ -138,6 +144,10 @@ public:
 	virtual bool start_passthrough() { return false; }
 	virtual void stop_passthrough() {}
 
+	/** environment blend mode. */
+	virtual Array get_supported_environment_blend_modes();
+	virtual bool set_environment_blend_mode(EnvironmentBlendMode mode) { return false; }
+
 	XRInterface();
 	~XRInterface();
 
@@ -151,5 +161,6 @@ private:
 VARIANT_ENUM_CAST(XRInterface::Capabilities);
 VARIANT_ENUM_CAST(XRInterface::TrackingStatus);
 VARIANT_ENUM_CAST(XRInterface::PlayAreaMode);
+VARIANT_ENUM_CAST(XRInterface::EnvironmentBlendMode);
 
 #endif // XR_INTERFACE_H