Add MetalFX Spatial and Temporal scaling modes on macOS and iOS

This is only available on platforms where the Metal rendering driver is used. MetalFX can perform better than FSR1/FSR2 and look more stable, but it goes for a softer look which can give it a lower perceived resolution.
godotengine · Dec 23, 2024 · de079eb · de079eb
1 parent 3a92da2
commit de079eb
Show file tree

Hide file tree

Showing 45 changed files with 85 additions and 6 deletions.
diff --git a/door/door.gd.uid b/door/door.gd.uid
@@ -0,0 +1 @@
+uid://br72vxyn64gyu
diff --git a/door/model/door.dae.import b/door/model/door.dae.import
@@ -18,6 +18,7 @@ nodes/root_name="DoorModel"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/effects_shared/BlastMesh.glb.import b/effects_shared/BlastMesh.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/enemies/red_robot/laser/BarrelSmoke.glb.import b/enemies/red_robot/laser/BarrelSmoke.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/enemies/red_robot/laser/LaserShader.gdshader.uid b/enemies/red_robot/laser/LaserShader.gdshader.uid
@@ -0,0 +1 @@
+uid://b882lqxenu3nf
diff --git a/enemies/red_robot/laser/impact_effect/EmissionAlbedoParticle.gdshader.uid b/enemies/red_robot/laser/impact_effect/EmissionAlbedoParticle.gdshader.uid
@@ -0,0 +1 @@
+uid://ccj8k6fqeyeb4
diff --git a/enemies/red_robot/laser/impact_effect/EmissionEmbers.gdshader.uid b/enemies/red_robot/laser/impact_effect/EmissionEmbers.gdshader.uid
@@ -0,0 +1 @@
+uid://tolcywtohhug
diff --git a/enemies/red_robot/laser/impact_effect/LightRaysMesh.glb.import b/enemies/red_robot/laser/impact_effect/LightRaysMesh.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/enemies/red_robot/laser/impact_effect/blast.gd.uid b/enemies/red_robot/laser/impact_effect/blast.gd.uid
@@ -0,0 +1 @@
+uid://c8lbt6tarrbg4
diff --git a/enemies/red_robot/laser/smoke.gdshader.uid b/enemies/red_robot/laser/smoke.gdshader.uid
@@ -0,0 +1 @@
+uid://b25ibj6bxf8q6
diff --git a/enemies/red_robot/laser/smoke.tres b/enemies/red_robot/laser/smoke.tres
@@ -1,6 +1,6 @@
 [gd_resource type="ShaderMaterial" load_steps=5 format=3 uid="uid://bhf6kwdlc7f5h"]
 
-[ext_resource type="Shader" path="res://enemies/red_robot/laser/smoke.gdshader" id="1_j0r3f"]
+[ext_resource type="Shader" uid="uid://b25ibj6bxf8q6" path="res://enemies/red_robot/laser/smoke.gdshader" id="1_j0r3f"]
 [ext_resource type="Texture2D" uid="uid://i5ll5xqsm55y" path="res://enemies/red_robot/laser/BarrelSmokeTexture.png" id="2"]
 
 [sub_resource type="FastNoiseLite" id="29"]

diff --git a/enemies/red_robot/model/red_robot.glb.import b/enemies/red_robot/model/red_robot.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/enemies/red_robot/parts/part.gd.uid b/enemies/red_robot/parts/part.gd.uid
@@ -0,0 +1 @@
+uid://deqj128fqtw6g
diff --git a/enemies/red_robot/parts/part_disappear_effect/part_disappear.gd.uid b/enemies/red_robot/parts/part_disappear_effect/part_disappear.gd.uid
@@ -0,0 +1 @@
+uid://dna155554wont
diff --git a/enemies/red_robot/parts/part_head.glb.import b/enemies/red_robot/parts/part_head.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/enemies/red_robot/parts/part_shield.glb.import b/enemies/red_robot/parts/part_shield.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/enemies/red_robot/parts/ray.gdshader.uid b/enemies/red_robot/parts/ray.gdshader.uid
@@ -0,0 +1 @@
+uid://cpwguvft8s8tl
diff --git a/enemies/red_robot/parts/ray.glb.import b/enemies/red_robot/parts/ray.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/enemies/red_robot/parts/sparks_effect/SparkParticle.glb.import b/enemies/red_robot/parts/sparks_effect/SparkParticle.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/enemies/red_robot/parts/sparks_effect/SparkShader.gdshader.uid b/enemies/red_robot/parts/sparks_effect/SparkShader.gdshader.uid
@@ -0,0 +1 @@
+uid://dpdgb6ekiyexf
diff --git a/enemies/red_robot/red_robot.gd.uid b/enemies/red_robot/red_robot.gd.uid
@@ -0,0 +1 @@
+uid://ihw03fdo0t2p
diff --git a/enemies/red_robot/smoke.gdshader.uid b/enemies/red_robot/smoke.gdshader.uid
@@ -0,0 +1 @@
+uid://bs15gshimi8uk
diff --git a/level/debug.gd.uid b/level/debug.gd.uid
@@ -0,0 +1 @@
+uid://dfqmhjkivsc4p
diff --git a/level/forklift/flying_forklift.gd.uid b/level/forklift/flying_forklift.gd.uid
@@ -0,0 +1 @@
+uid://bqbx6m8pp61ut
diff --git a/level/forklift/flying_forklift.glb.import b/level/forklift/flying_forklift.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="FlyingForkliftModel"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/level/geometry/models/core.glb.import b/level/geometry/models/core.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="CoreModel"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/level/geometry/models/lights.glb.import b/level/geometry/models/lights.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="LightsModel"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/level/geometry/models/props.glb.import b/level/geometry/models/props.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="PropsModel"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/level/geometry/models/structure.glb.import b/level/geometry/models/structure.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="StructureModel"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/level/level.gd.uid b/level/level.gd.uid
@@ -0,0 +1 @@
+uid://d1785c3ifnalw
diff --git a/level/textures/structure/Core/CoreOutLight.glb.import b/level/textures/structure/Core/CoreOutLight.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/main/main.gd.uid b/main/main.gd.uid
@@ -0,0 +1 @@
+uid://bdqkvnclm506u
diff --git a/main/main.tscn b/main/main.tscn
@@ -1,6 +1,6 @@
 [gd_scene load_steps=2 format=3 uid="uid://dmp13e1xswsm0"]
 
-[ext_resource type="Script" path="res://main/main.gd" id="1"]
+[ext_resource type="Script" uid="uid://bdqkvnclm506u" path="res://main/main.gd" id="1"]
 
 [node name="main" type="Node"]
 script = ExtResource("1")
diff --git a/menu/font/PT_Sans-Web-Bold.ttf.import b/menu/font/PT_Sans-Web-Bold.ttf.import
@@ -23,6 +23,7 @@ allow_system_fallback=true
 force_autohinter=false
 hinting=1
 subpixel_positioning=1
+keep_rounding_remainders=true
 oversampling=0.0
 Fallbacks=null
 fallbacks=[]

diff --git a/menu/menu.gd b/menu/menu.gd
@@ -8,6 +8,8 @@ signal quit # Useless, but needed as there is no clean way to check if a node ex
 
 var peer : MultiplayerPeer = OfflineMultiplayerPeer.new()
 
+var metalfx_supported: bool = ProjectSettings.get_setting_with_override("rendering/rendering_device/driver") == "metal"
+
 @onready var world_environment = $WorldEnvironment
 
 @onready var ui = $UI
@@ -54,7 +56,9 @@ var peer : MultiplayerPeer = OfflineMultiplayerPeer.new()
 @onready var scale_filter_menu = settings_menu.get_node("ScaleFilter")
 @onready var scale_filter_bilinear = scale_filter_menu.get_node("Bilinear")
 @onready var scale_filter_fsr1 = scale_filter_menu.get_node("FSR1")
+@onready var scale_filter_metalfx_spatial = scale_filter_menu.get_node("MetalFXSpatial")
 @onready var scale_filter_fsr2 = scale_filter_menu.get_node("FSR2")
+@onready var scale_filter_metalfx_temporal = scale_filter_menu.get_node("MetalFXTemporal")
 
 @onready var taa_menu = settings_menu.get_node("TAA")
 @onready var taa_disabled = taa_menu.get_node("Disabled")
@@ -114,6 +118,11 @@ func _ready():
 		_on_host_pressed.call_deferred()
 
 	play_button.grab_focus()
+
+	if not metalfx_supported:
+		scale_filter_metalfx_spatial.hide()
+		scale_filter_metalfx_temporal.hide()
+
 	for menu in [
 		display_mode_menu, vsync_menu, max_fps_menu, resolution_scale_menu, scale_filter_menu,
 		taa_menu, msaa_menu, fxaa_menu, shadow_mapping_menu, gi_type_menu, gi_quality_menu,
@@ -210,8 +219,17 @@ func _on_settings_pressed():
 		scale_filter_bilinear.button_pressed = true
 	elif Settings.config_file.get_value("video", "scale_filter") == Viewport.SCALING_3D_MODE_FSR:
 		scale_filter_fsr1.button_pressed = true
-	else:
+	elif Settings.config_file.get_value("video", "scale_filter") == Viewport.SCALING_3D_MODE_FSR2:
 		scale_filter_fsr2.button_pressed = true
+	elif Settings.config_file.get_value("video", "scale_filter") == Viewport.SCALING_3D_MODE_METALFX_SPATIAL:
+		scale_filter_metalfx_spatial.button_pressed = true
+	elif Settings.config_file.get_value("video", "scale_filter") == Viewport.SCALING_3D_MODE_METALFX_TEMPORAL:
+		scale_filter_metalfx_temporal.button_pressed = true
+	else:
+		if metalfx_supported:
+			scale_filter_metalfx_temporal.button_pressed = true
+		else:
+			scale_filter_fsr2.button_pressed = true
 
 	if Settings.config_file.get_value("rendering", "gi_type") == Settings.GIType.LIGHTMAP_GI:
 		gi_lightmapgi.button_pressed = true
@@ -337,6 +355,10 @@ func _on_apply_pressed():
 		Settings.config_file.set_value("video", "scale_filter", Viewport.SCALING_3D_MODE_FSR)
 	elif scale_filter_fsr2.button_pressed:
 		Settings.config_file.set_value("video", "scale_filter", Viewport.SCALING_3D_MODE_FSR2)
+	elif scale_filter_metalfx_spatial.button_pressed:
+		Settings.config_file.set_value("video", "scale_filter", Viewport.SCALING_3D_MODE_METALFX_SPATIAL)
+	elif scale_filter_metalfx_temporal.button_pressed:
+		Settings.config_file.set_value("video", "scale_filter", Viewport.SCALING_3D_MODE_METALFX_TEMPORAL)
 
 	if gi_lightmapgi.button_pressed:
 		Settings.config_file.set_value("rendering", "gi_type", Settings.GIType.LIGHTMAP_GI)

diff --git a/menu/menu.gd.uid b/menu/menu.gd.uid
@@ -0,0 +1 @@
+uid://d01c0jp7txxst
diff --git a/menu/menu.tscn b/menu/menu.tscn
@@ -1,6 +1,6 @@
 [gd_scene load_steps=25 format=3 uid="uid://c80nbk7u633n6"]
 
-[ext_resource type="Script" path="res://menu/menu.gd" id="1"]
+[ext_resource type="Script" uid="uid://d01c0jp7txxst" path="res://menu/menu.gd" id="1"]
 [ext_resource type="Texture2D" uid="uid://gnsovrtic7g4" path="res://menu/experiment.hdr" id="2_bpuaq"]
 [ext_resource type="PackedScene" uid="uid://div25sd40yx1d" path="res://player/model/player.glb" id="3"]
 [ext_resource type="AudioStream" uid="uid://bfq26n228ipa" path="res://menu/menu_intro_music.ogg" id="5"]
@@ -471,13 +471,27 @@ size_flags_horizontal = 3
 toggle_mode = true
 text = "AMD FSR 1.0"
 
+[node name="MetalFXSpatial" type="Button" parent="UI/Settings/ScaleFilter"]
+modulate = Color(1, 1, 0.313726, 1)
+layout_mode = 2
+size_flags_horizontal = 3
+toggle_mode = true
+text = "MetalFX Spatial"
+
 [node name="FSR2" type="Button" parent="UI/Settings/ScaleFilter"]
 modulate = Color(1, 0.627451, 0.25098, 1)
 layout_mode = 2
 size_flags_horizontal = 3
 toggle_mode = true
 text = "AMD FSR 2.2"
 
+[node name="MetalFXTemporal" type="Button" parent="UI/Settings/ScaleFilter"]
+modulate = Color(1, 0.627451, 0.25098, 1)
+layout_mode = 2
+size_flags_horizontal = 3
+toggle_mode = true
+text = "MetalFX Temporal"
+
 [node name="HSeparator2" type="HSeparator" parent="UI/Settings"]
 layout_mode = 2
 

diff --git a/menu/settings.gd b/menu/settings.gd
@@ -14,13 +14,16 @@ enum GIQuality {
 
 const CONFIG_FILE_PATH = "user://settings.ini"
 
-const DEFAULTS = {
+# MetalFX is only supported when using the Metal rendering driver.
+var metalfx_supported: bool = ProjectSettings.get_setting_with_override("rendering/rendering_device/driver") == "metal"
+
+var DEFAULTS := {
 	video = {
 		display_mode = Window.MODE_EXCLUSIVE_FULLSCREEN,
 		vsync = DisplayServer.VSYNC_ENABLED,
 		max_fps = 0,
 		resolution_scale = 1.0,
-		scale_filter = Viewport.SCALING_3D_MODE_FSR2,
+		scale_filter = Viewport.SCALING_3D_MODE_METALFX_TEMPORAL if metalfx_supported else Viewport.SCALING_3D_MODE_FSR2,
 	},
 	rendering = {
 		taa = false,

diff --git a/menu/settings.gd.uid b/menu/settings.gd.uid
@@ -0,0 +1 @@
+uid://cqgjfsdrdi32u
diff --git a/player/bullet/bullet.gd.uid b/player/bullet/bullet.gd.uid
@@ -0,0 +1 @@
+uid://cxyytsgiom5t0
diff --git a/player/camera_noise_shake_effect.gd.uid b/player/camera_noise_shake_effect.gd.uid
@@ -0,0 +1 @@
+uid://bjsdb6te5tqtx
diff --git a/player/model/muzzle_flash_particle_mesh.glb.import b/player/model/muzzle_flash_particle_mesh.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/player/model/player.glb.import b/player/model/player.glb.import
@@ -18,6 +18,7 @@ nodes/root_name="Scene Root"
 nodes/apply_root_scale=true
 nodes/root_scale=1.0
 nodes/import_as_skeleton_bones=false
+nodes/use_node_type_suffixes=true
 meshes/ensure_tangents=true
 meshes/generate_lods=true
 meshes/create_shadow_meshes=true

diff --git a/player/player.gd.uid b/player/player.gd.uid
@@ -0,0 +1 @@
+uid://bdh4ypltx0nov
diff --git a/player/player_input.gd.uid b/player/player_input.gd.uid
@@ -0,0 +1 @@
+uid://bb1yx5mmt6u7s