Merge 6d78e71fc7 into 9c226dcc7a

You can now access the *entire* play report data in any given value formatter.
The input types have been restructured and, notably, not every instance of Value has an ApplicationMetadata on it. It's now on the container type that also contains the matched values and the entire play report.

Directory.Packages.props

@@ -3,6 +3,7 @@
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
   </PropertyGroup>
   <ItemGroup>
+    <PackageVersion Include="Alimer.Bindings.SDL" Version="3.7.1" />
     <PackageVersion Include="Avalonia" Version="11.0.13" />
     <PackageVersion Include="Avalonia.Controls.DataGrid" Version="11.0.13" />
     <PackageVersion Include="Avalonia.Desktop" Version="11.0.13" />

Ryujinx.sln

@@ -75,6 +75,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ryujinx.Horizon", "src\Ryuj
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ryujinx.Horizon.Kernel.Generators", "src\Ryujinx.Horizon.Kernel.Generators\Ryujinx.Horizon.Kernel.Generators.csproj", "{7F55A45D-4E1D-4A36-ADD3-87F29A285AA2}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Ryujinx.Input.SDL3", "src\Ryujinx.Input.SDL3\Ryujinx.Input.SDL3.csproj", "{3BF24278-547D-42C2-9D43-182B978F54DD}"
+EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ryujinx.HLE.Generators", "src\Ryujinx.HLE.Generators\Ryujinx.HLE.Generators.csproj", "{B575BCDE-2FD8-4A5D-8756-31CDD7FE81F0}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Ryujinx.Graphics.Metal", "src\Ryujinx.Graphics.Metal\Ryujinx.Graphics.Metal.csproj", "{C08931FA-1191-417A-864F-3882D93E683B}"
@@ -259,6 +261,10 @@ Global
 		{81EA598C-DBA1-40B0-8DA4-4796B78F2037}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{81EA598C-DBA1-40B0-8DA4-4796B78F2037}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{81EA598C-DBA1-40B0-8DA4-4796B78F2037}.Release|Any CPU.Build.0 = Release|Any CPU
+		{3BF24278-547D-42C2-9D43-182B978F54DD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{3BF24278-547D-42C2-9D43-182B978F54DD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{3BF24278-547D-42C2-9D43-182B978F54DD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{3BF24278-547D-42C2-9D43-182B978F54DD}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

src/Ryujinx.Common/Configuration/Hid/Controller/Motion/JsonMotionConfigControllerConverter.cs

@@ -56,6 +56,7 @@ namespace Ryujinx.Common.Configuration.Hid.Controller.Motion
             return motionBackendType switch
             {
                 MotionInputBackendType.GamepadDriver => JsonSerializer.Deserialize(ref reader, _serializerContext.StandardMotionConfigController),
+                MotionInputBackendType.Handheld => JsonSerializer.Deserialize(ref reader, _serializerContext.StandardMotionConfigController),
                 MotionInputBackendType.CemuHook => JsonSerializer.Deserialize(ref reader, _serializerContext.CemuHookMotionConfigController),
                 _ => throw new InvalidOperationException($"Unknown backend type {motionBackendType}"),
             };
@@ -66,6 +67,7 @@ namespace Ryujinx.Common.Configuration.Hid.Controller.Motion
             switch (value.MotionBackend)
             {
                 case MotionInputBackendType.GamepadDriver:
+                case MotionInputBackendType.Handheld:
                     JsonSerializer.Serialize(writer, value as StandardMotionConfigController, _serializerContext.StandardMotionConfigController);
                     break;
                 case MotionInputBackendType.CemuHook:

src/Ryujinx.Common/Configuration/Hid/Controller/Motion/MotionInputBackendType.cs

@@ -9,5 +9,6 @@ namespace Ryujinx.Common.Configuration.Hid.Controller.Motion
         Invalid,
         GamepadDriver,
         CemuHook,
+        Handheld,
     }
 }

src/Ryujinx.Horizon/HorizonStatic.cs

@@ -1,5 +1,6 @@
 using MsgPack;
 using Ryujinx.Horizon.Common;
+using Ryujinx.Horizon.Prepo.Types;
 using Ryujinx.Memory;
 using System;
 using System.Threading;
@@ -8,7 +9,7 @@ namespace Ryujinx.Horizon
 {
     public static class HorizonStatic
     {
-        internal static void HandlePlayReport(MessagePackObject report) => 
+        internal static void HandlePlayReport(PlayReport report) => 
             new Thread(() => PlayReport?.Invoke(report))
             {
                 Name = "HLE.PlayReportEvent", 
@@ -16,7 +17,7 @@ namespace Ryujinx.Horizon
                 Priority = ThreadPriority.AboveNormal
             }.Start();
         
-        public static event Action<MessagePackObject> PlayReport;
+        public static event Action<PlayReport> PlayReport;
 
         [field: ThreadStatic]
         public static HorizonOptions Options { get; private set; }

src/Ryujinx.Horizon/Prepo/Ipc/PrepoService.cs

@@ -1,4 +1,3 @@
-using Gommon;
 using MsgPack;
 using MsgPack.Serialization;
 using Ryujinx.Common.Logging;
@@ -12,19 +11,12 @@ using Ryujinx.Horizon.Sdk.Sf;
 using Ryujinx.Horizon.Sdk.Sf.Hipc;
 using System;
 using System.Text;
-using System.Threading;
 using ApplicationId = Ryujinx.Horizon.Sdk.Ncm.ApplicationId;
 
 namespace Ryujinx.Horizon.Prepo.Ipc
 {
     partial class PrepoService : IPrepoService
     {
-        enum PlayReportKind
-        {
-            Normal,
-            System,
-        }
-
         private readonly ArpApi _arp;
         private readonly PrepoServicePermissionLevel _permissionLevel;
         private ulong _systemSessionId;
@@ -196,10 +188,17 @@ namespace Ryujinx.Horizon.Prepo.Ipc
             {
                 return PrepoResult.InvalidBufferSize;
             }
-
+            
             StringBuilder builder = new();
             MessagePackObject deserializedReport = MessagePackSerializer.UnpackMessagePackObject(reportBuffer.ToArray());
 
+            PlayReport playReport = new()
+            {
+                Kind = playReportKind, 
+                Room = gameRoom,
+                ReportData = deserializedReport
+            };
+            
             builder.AppendLine();
             builder.AppendLine("PlayReport log:");
             builder.AppendLine($" Kind: {playReportKind}");
@@ -209,10 +208,12 @@ namespace Ryujinx.Horizon.Prepo.Ipc
             if (pid != 0)
             {
                 builder.AppendLine($" Pid: {pid}");
+                playReport.Pid = pid;
             }
             else
             {
                 builder.AppendLine($" ApplicationId: {applicationId}");
+                playReport.AppId = applicationId;
             }
 
             Result result = _arp.GetApplicationInstanceId(out ulong applicationInstanceId, pid);
@@ -223,17 +224,20 @@ namespace Ryujinx.Horizon.Prepo.Ipc
 
             _arp.GetApplicationLaunchProperty(out ApplicationLaunchProperty applicationLaunchProperty, applicationInstanceId).AbortOnFailure();
 
+            playReport.Version = applicationLaunchProperty.Version;
+            
             builder.AppendLine($" ApplicationVersion: {applicationLaunchProperty.Version}");
 
             if (!userId.IsNull)
             {
                 builder.AppendLine($" UserId: {userId}");
+                playReport.UserId = userId;
             }
 
             builder.AppendLine($" Room: {gameRoom}");
             builder.AppendLine($" Report: {MessagePackObjectFormatter.Format(deserializedReport)}");
             
-            HorizonStatic.HandlePlayReport(deserializedReport);
+            HorizonStatic.HandlePlayReport(playReport);
 
             Logger.Info?.Print(LogClass.ServicePrepo, builder.ToString());
 

src/Ryujinx.Horizon/Prepo/Types/PlayReport.cs

@@ -0,0 +1,24 @@
+using MsgPack;
+using Ryujinx.Horizon.Sdk.Account;
+using Ryujinx.Horizon.Sdk.Ncm;
+
+namespace Ryujinx.Horizon.Prepo.Types
+{
+    public struct PlayReport
+    {
+        public PlayReportKind Kind { get; init; }
+        public string Room { get; init; }
+        public MessagePackObject ReportData { get; init; }
+        
+        public ApplicationId? AppId;
+        public ulong? Pid;
+        public uint Version;
+        public Uid? UserId;
+    }
+    
+    public enum PlayReportKind
+    {
+        Normal,
+        System,
+    }
+}

src/Ryujinx.Input.SDL3/Ryujinx.Input.SDL3.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Ryujinx.Input\Ryujinx.Input.csproj" />
+    <PackageReference Include="Alimer.Bindings.SDL" />
+  </ItemGroup>
+
+</Project>

src/Ryujinx.Input.SDL3/SDL3MotionDriver.cs

@@ -0,0 +1,85 @@
+using SDL3;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Numerics;
+using static SDL3.SDL3;
+
+namespace Ryujinx.Input.SDL3
+{
+    public unsafe class SDL3MotionDriver : IHandheld, IDisposable
+    {
+        private readonly Dictionary<SDL_SensorType, SDL_Sensor> sensors;
+        private bool _disposed;
+
+        public SDL3MotionDriver()
+        {
+            int result = SDL_Init(SDL_InitFlags.Sensor);
+            if (result < 0)
+            {
+                throw new InvalidOperationException($"SDL sensor initialization failed: {SDL_GetError()}");
+            }
+            sensors = SDL_GetSensors().ToArray().ToDictionary(SDL_GetSensorTypeForID, SDL_OpenSensor);
+        }
+
+        ~SDL3MotionDriver()
+        {
+            Dispose(false);
+        }
+
+        public void Dispose()
+        {
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (_disposed)
+            {
+                return;
+            }
+
+            if (disposing && sensors != null)
+            {
+                foreach (var sensor in sensors.Values)
+                {
+                    if (sensor != IntPtr.Zero)
+                    {
+                        SDL_CloseSensor(sensor);
+                    }
+                }
+            }
+
+            _disposed = true;
+        }
+
+        public Vector3 GetMotionData(MotionInputId inputType)
+        {
+            ObjectDisposedException.ThrowIf(_disposed, this);
+
+            return inputType switch
+            {
+                MotionInputId.Gyroscope => GetSensorVector(SDL_SensorType.Gyro) * 180 / MathF.PI,
+                MotionInputId.Accelerometer => GetSensorVector(SDL_SensorType.Accel) / SDL_STANDARD_GRAVITY,
+                _ => Vector3.Zero
+            };
+        }
+
+        private Vector3 GetSensorVector(SDL_SensorType sensorType)
+        {
+            if (!sensors.TryGetValue(sensorType, out SDL_Sensor sensor))
+            {
+                return Vector3.Zero;
+            }
+
+            var data = stackalloc float[3];
+            if (SDL_GetSensorData(sensor, data, 3) < 0)
+            {
+                return Vector3.Zero;
+            }
+
+            return new Vector3(data[0], data[1], data[2]);
+        }
+    }
+}

src/Ryujinx.Input/HLE/InputManager.cs

@@ -2,12 +2,13 @@ using System;
 
 namespace Ryujinx.Input.HLE
 {
-    public class InputManager(IGamepadDriver keyboardDriver, IGamepadDriver gamepadDriver)
+    public class InputManager(IGamepadDriver keyboardDriver, IGamepadDriver gamepadDriver, IHandheld handheld)
         : IDisposable
     {
         public IGamepadDriver KeyboardDriver { get; } = keyboardDriver;
         public IGamepadDriver GamepadDriver { get; } = gamepadDriver;
         public IGamepadDriver MouseDriver { get; private set; }
+        public IHandheld Handheld { get; } = handheld;
 
         public void SetMouseDriver(IGamepadDriver mouseDriver)
         {
@@ -18,7 +19,7 @@ namespace Ryujinx.Input.HLE
 
         public NpadManager CreateNpadManager()
         {
-            return new NpadManager(KeyboardDriver, GamepadDriver, MouseDriver);
+            return new NpadManager(KeyboardDriver, GamepadDriver, MouseDriver, Handheld);
         }
 
         public TouchScreenManager CreateTouchScreenManager()
@@ -38,6 +39,7 @@ namespace Ryujinx.Input.HLE
                 KeyboardDriver?.Dispose();
                 GamepadDriver?.Dispose();
                 MouseDriver?.Dispose();
+                Handheld?.Dispose();
             }
         }
 

src/Ryujinx.Input/HLE/NpadController.cs

@@ -218,12 +218,14 @@ namespace Ryujinx.Input.HLE
         public string Id { get; private set; }
 
         private readonly CemuHookClient _cemuHookClient;
+        private readonly IHandheld _handheld;
 
-        public NpadController(CemuHookClient cemuHookClient)
+        public NpadController(CemuHookClient cemuHookClient, IHandheld handheld)
         {
             State = default;
             Id = null;
             _cemuHookClient = cemuHookClient;
+            _handheld = handheld;
         }
 
         public bool UpdateDriverConfiguration(IGamepadDriver gamepadDriver, InputConfig config)
@@ -287,6 +289,18 @@ namespace Ryujinx.Input.HLE
 
                 if (_config is StandardControllerInputConfig controllerConfig && controllerConfig.Motion.EnableMotion)
                 {
+                    if (controllerConfig.Motion.MotionBackend == MotionInputBackendType.Handheld)
+                    {
+                        Vector3 accelerometer = _handheld.GetMotionData(MotionInputId.Accelerometer);
+                        Vector3 gyroscope = _handheld.GetMotionData(MotionInputId.Gyroscope);
+
+                        accelerometer = new Vector3(accelerometer.X, -accelerometer.Z, accelerometer.Y);
+                        gyroscope = new Vector3(gyroscope.X, -gyroscope.Z, gyroscope.Y);
+
+                        _leftMotionInput.Update(accelerometer, gyroscope, (ulong)PerformanceCounter.ElapsedNanoseconds / 1000, controllerConfig.Motion.Sensitivity, (float)controllerConfig.Motion.GyroDeadzone);
+                        _rightMotionInput = _leftMotionInput;
+                    }
+
                     if (controllerConfig.Motion.MotionBackend == MotionInputBackendType.GamepadDriver)
                     {
                         if (gamepad.Features.HasFlag(GamepadFeaturesFlag.Motion))

src/Ryujinx.Input/HLE/NpadManager.cs

@@ -31,6 +31,7 @@ namespace Ryujinx.Input.HLE
         private readonly IGamepadDriver _keyboardDriver;
         private readonly IGamepadDriver _gamepadDriver;
         private readonly IGamepadDriver _mouseDriver;
+        private readonly IHandheld _handheld;
         private bool _isDisposed;
 
         private List<InputConfig> _inputConfig;
@@ -38,7 +39,7 @@ namespace Ryujinx.Input.HLE
         private bool _enableMouse;
         private Switch _device;
 
-        public NpadManager(IGamepadDriver keyboardDriver, IGamepadDriver gamepadDriver, IGamepadDriver mouseDriver)
+        public NpadManager(IGamepadDriver keyboardDriver, IGamepadDriver gamepadDriver, IGamepadDriver mouseDriver, IHandheld handheld)
         {
             _controllers = new NpadController[MaxControllers];
             _cemuHookClient = new CemuHookClient(this);
@@ -47,6 +48,7 @@ namespace Ryujinx.Input.HLE
             _gamepadDriver = gamepadDriver;
             _mouseDriver = mouseDriver;
             _inputConfig = [];
+            _handheld = handheld;
 
             _gamepadDriver.OnGamepadConnected += HandleOnGamepadConnected;
             _gamepadDriver.OnGamepadDisconnected += HandleOnGamepadDisconnected;
@@ -139,7 +141,7 @@ namespace Ryujinx.Input.HLE
                     }
                     else
                     {
-                        controller = new(_cemuHookClient);
+                        controller = new(_cemuHookClient, _handheld);
                     }
 
                     bool isValid = DriverConfigurationUpdate(ref controller, inputConfigEntry);

src/Ryujinx.Input/IHandheld.cs

@@ -0,0 +1,10 @@
+using System;
+using System.Numerics;
+
+namespace Ryujinx.Input
+{
+    public interface IHandheld : IDisposable
+    {
+        Vector3 GetMotionData(MotionInputId gyroscope);
+    }
+}

src/Ryujinx/Assets/locales.json

@@ -7897,6 +7897,31 @@
         "zh_TW": "使用與 CemuHook 相容的體感"
       }
     },
+    {
+      "ID": "ControllerSettingsMotionUseHandheldCompatibleMotion",
+      "Translations": {
+        "ar_SA": "استخدام الحركة المتوافقة مع Hendheld",
+        "de_DE": "Hendheld kompatible Bewegungssteuerung",
+        "el_GR": "Κίνηση συμβατή με Hendheld",
+        "en_US": "Use Hendheld compatible motion",
+        "es_ES": "Usar movimiento compatible con Hendheld",
+        "fr_FR": "Utiliser un capteur de mouvements Hendheld",
+        "he_IL": "השתמש בתנועת Hendheld תואמת ",
+        "it_IT": "Usa sensore compatibile con Hendheld",
+        "ja_JP": "Hendheld 互換モーションを使用",
+        "ko_KR": "Hendheld 호환 모션 사용",
+        "no_NO": "Bruk Hendheld kompatibel bevegelse",
+        "pl_PL": "Użyj ruchu zgodnego z Hendheld",
+        "pt_BR": "Usar sensor compatível com Hendheld",
+        "ru_RU": "Включить совместимость с Hendheld",
+        "sv_SE": "Använd Hendheld-kompatibel rörelse",
+        "th_TH": "ใช้การเคลื่อนไหวที่เข้ากันได้กับ Hendheld",
+        "tr_TR": "Hendheld uyumlu hareket kullan",
+        "uk_UA": "Використовувати рух, сумісний з Hendheld",
+        "zh_CN": "使用 Hendheld 兼容的体感协议",
+        "zh_TW": "使用與 Hendheld 相容的體感"
+      }
+    },
     {
       "ID": "ControllerSettingsMotionControllerSlot",
       "Translations": {
@@ -23748,4 +23773,4 @@
       }
     }
   ]
-}
+}

src/Ryujinx/DiscordIntegrationModule.cs

@@ -10,6 +10,7 @@ using Ryujinx.Common.Logging;
 using Ryujinx.HLE;
 using Ryujinx.HLE.Loaders.Processes;
 using Ryujinx.Horizon;
+using Ryujinx.Horizon.Prepo.Types;
 using System.Linq;
 using System.Text;
 
@@ -124,7 +125,7 @@ namespace Ryujinx.Ava
             _currentApp = null;
         }
 
-        private static void HandlePlayReport(MessagePackObject playReport)
+        private static void HandlePlayReport(PlayReport playReport)
         {
             if (_discordClient is null) return;
             if (!TitleIDs.CurrentApplication.Value.HasValue) return;

src/Ryujinx/Headless/HeadlessRyujinx.cs

@@ -23,6 +23,7 @@ using Ryujinx.HLE.HOS.Services.Account.Acc;
 using Ryujinx.Input;
 using Ryujinx.Input.HLE;
 using Ryujinx.Input.SDL2;
+using Ryujinx.Input.SDL3;
 using Ryujinx.SDL2.Common;
 using System;
 using System.Collections.Generic;
@@ -182,7 +183,7 @@ namespace Ryujinx.Headless
             _accountManager = new AccountManager(_libHacHorizonManager.RyujinxClient, option.UserProfile);
             _userChannelPersistence = new UserChannelPersistence();
 
-            _inputManager = new InputManager(new SDL2KeyboardDriver(), new SDL2GamepadDriver());
+            _inputManager = new InputManager(new SDL2KeyboardDriver(), new SDL2GamepadDriver(), new SDL3MotionDriver());
 
             GraphicsConfig.EnableShaderCache = !option.DisableShaderCache;
 

src/Ryujinx/Ryujinx.csproj

@@ -76,6 +76,7 @@
     <ProjectReference Include="..\Ryujinx.Graphics.Metal\Ryujinx.Graphics.Metal.csproj" />
     <ProjectReference Include="..\Ryujinx.Input\Ryujinx.Input.csproj" />
     <ProjectReference Include="..\Ryujinx.Input.SDL2\Ryujinx.Input.SDL2.csproj" />
+    <ProjectReference Include="..\Ryujinx.Input.SDL3\Ryujinx.Input.SDL3.csproj" />
     <ProjectReference Include="..\Ryujinx.Audio.Backends.OpenAL\Ryujinx.Audio.Backends.OpenAL.csproj" />
     <ProjectReference Include="..\Ryujinx.Audio.Backends.SoundIo\Ryujinx.Audio.Backends.SoundIo.csproj" />
     <ProjectReference Include="..\Ryujinx.Common\Ryujinx.Common.csproj" />

src/Ryujinx/UI/Models/Input/GamepadInputConfig.cs

@@ -10,6 +10,7 @@ namespace Ryujinx.Ava.UI.Models.Input
     public partial class GamepadInputConfig : BaseModel
     {
         public bool EnableCemuHookMotion { get; set; }
+        public bool EnableHandheldMotion { get; set; }
         public string DsuServerHost { get; set; }
         public int DsuServerPort { get; set; }
         public int Slot { get; set; }
@@ -162,7 +163,7 @@ namespace Ryujinx.Ava.UI.Models.Input
                     EnableMotion = controllerInput.Motion.EnableMotion;
                     GyroDeadzone = controllerInput.Motion.GyroDeadzone;
                     Sensitivity = controllerInput.Motion.Sensitivity;
-
+                    EnableHandheldMotion = controllerInput.Motion.MotionBackend == MotionInputBackendType.Handheld;
                     if (controllerInput.Motion is CemuHookMotionConfigController cemuHook)
                     {
                         EnableCemuHookMotion = true;
@@ -285,7 +286,7 @@ namespace Ryujinx.Ava.UI.Models.Input
                 config.Motion = new StandardMotionConfigController
                 {
                     EnableMotion = EnableMotion,
-                    MotionBackend = MotionInputBackendType.GamepadDriver,
+                    MotionBackend = EnableHandheldMotion ? MotionInputBackendType.Handheld : MotionInputBackendType.GamepadDriver,
                     GyroDeadzone = GyroDeadzone,
                     Sensitivity = Sensitivity,
                 };

src/Ryujinx/UI/ViewModels/Input/MotionInputViewModel.cs

@@ -18,6 +18,34 @@ namespace Ryujinx.Ava.UI.ViewModels.Input
 
         [ObservableProperty] private double _gyroDeadzone;
 
-        [ObservableProperty] private bool _enableCemuHookMotion;
+        private bool _enableCemuHookMotion;
+        public bool EnableCemuHookMotion
+        {
+            get => _enableCemuHookMotion;
+            set
+            {
+                if (value)
+                {
+                    EnableHandheldMotion = false;
+                }
+                _enableCemuHookMotion = value;
+                OnPropertyChanged();
+            }
+        }
+
+        private bool _enableHandheldMotion;
+        public bool EnableHandheldMotion
+        {
+            get => _enableHandheldMotion;
+            set
+            {
+                if (value)
+                {
+                    EnableCemuHookMotion = false;
+                }
+                _enableHandheldMotion = value;
+                OnPropertyChanged();
+            }
+        }
     }
 }

src/Ryujinx/UI/Views/Input/MotionInputView.axaml

@@ -61,6 +61,17 @@
                     Margin="5, 0"
                     Text="{Binding GyroDeadzone, StringFormat=\{0:0.00\}}" />
             </StackPanel>
+            <Separator
+                Height="1"
+                Margin="0,5" />
+            <CheckBox
+                Margin="5"
+                IsChecked="{Binding EnableHandheldMotion}">
+                <TextBlock
+                    Margin="0,3,0,0"
+                    VerticalAlignment="Center"
+                    Text="{ext:Locale ControllerSettingsMotionUseHandheldCompatibleMotion}" />
+            </CheckBox>
             <Separator
                 Height="1"
                 Margin="0,5" />

src/Ryujinx/UI/Views/Input/MotionInputView.axaml.cs

@@ -30,6 +30,7 @@ namespace Ryujinx.Ava.UI.Views.Input
                 Sensitivity = config.Sensitivity,
                 GyroDeadzone = config.GyroDeadzone,
                 EnableCemuHookMotion = config.EnableCemuHookMotion,
+                EnableHandheldMotion = config.EnableHandheldMotion,
             };
 
             InitializeComponent();
@@ -58,6 +59,7 @@ namespace Ryujinx.Ava.UI.Views.Input
                 config.DsuServerHost = content._viewModel.DsuServerHost;
                 config.DsuServerPort = content._viewModel.DsuServerPort;
                 config.EnableCemuHookMotion = content._viewModel.EnableCemuHookMotion;
+                config.EnableHandheldMotion = content._viewModel.EnableHandheldMotion;
                 config.MirrorInput = content._viewModel.MirrorInput;
             };
 

src/Ryujinx/UI/Windows/MainWindow.axaml.cs

@@ -29,6 +29,7 @@ using Ryujinx.HLE.HOS;
 using Ryujinx.HLE.HOS.Services.Account.Acc;
 using Ryujinx.Input.HLE;
 using Ryujinx.Input.SDL2;
+using Ryujinx.Input.SDL3;
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -107,7 +108,7 @@ namespace Ryujinx.Ava.UI.Windows
 
             if (Program.PreviewerDetached)
             {
-                InputManager = new InputManager(new AvaloniaKeyboardDriver(this), new SDL2GamepadDriver());
+                InputManager = new InputManager(new AvaloniaKeyboardDriver(this), new SDL2GamepadDriver(), new SDL3MotionDriver());
 
                 _ = this.GetObservable(IsActiveProperty).Subscribe(it => ViewModel.IsActive = it);
                 this.ScalingChanged += OnScalingChanged;

src/Ryujinx/Utilities/PlayReport/Analyzer.cs

@@ -85,7 +85,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport
 
 
         /// <summary>
-        /// Runs the configured <see cref="GameSpec.FormatterSpec"/> for the specified game title ID.
+        /// Runs the configured <see cref="FormatterSpec"/> for the specified game title ID.
         /// </summary>
         /// <param name="runningGameId">The game currently running.</param>
         /// <param name="appMeta">The Application metadata information, including localized game name and play time information.</param>
@@ -94,54 +94,21 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         public FormattedValue Format(
             string runningGameId,
             ApplicationMetadata appMeta,
-            MessagePackObject playReport
+            Horizon.Prepo.Types.PlayReport playReport
         )
         {
-            if (!playReport.IsDictionary)
+            if (!playReport.ReportData.IsDictionary)
                 return FormattedValue.Unhandled;
 
             if (!_specs.TryGetFirst(s => runningGameId.EqualsAnyIgnoreCase(s.TitleIds), out GameSpec spec))
                 return FormattedValue.Unhandled;
 
-            foreach (FormatterSpec formatSpec in spec.SimpleValueFormatters.OrderBy(x => x.Priority))
+            foreach (FormatterSpecBase formatSpec in spec.ValueFormatters.OrderBy(x => x.Priority))
             {
-                if (!playReport.AsDictionary().TryGetValue(formatSpec.ReportKey, out MessagePackObject valuePackObject))
+                if (!formatSpec.Format(appMeta, playReport, out FormattedValue value))
                     continue;
 
-                return formatSpec.Formatter(new Value { Application = appMeta, PackedValue = valuePackObject });
-            }
-
-            foreach (MultiFormatterSpec formatSpec in spec.MultiValueFormatters.OrderBy(x => x.Priority))
-            {
-                List<MessagePackObject> packedObjects = [];
-                foreach (var reportKey in formatSpec.ReportKeys)
-                {
-                    if (!playReport.AsDictionary().TryGetValue(reportKey, out MessagePackObject valuePackObject))
-                        continue;
-
-                    packedObjects.Add(valuePackObject);
-                }
-
-                if (packedObjects.Count != formatSpec.ReportKeys.Length)
-                    return FormattedValue.Unhandled;
-
-                return formatSpec.Formatter(packedObjects
-                    .Select(packObject => new Value { Application = appMeta, PackedValue = packObject })
-                    .ToArray());
-            }
-
-            foreach (SparseMultiFormatterSpec formatSpec in spec.SparseMultiValueFormatters.OrderBy(x => x.Priority))
-            {
-                Dictionary<string, Value> packedObjects = [];
-                foreach (var reportKey in formatSpec.ReportKeys)
-                {
-                    if (!playReport.AsDictionary().TryGetValue(reportKey, out MessagePackObject valuePackObject))
-                        continue;
-
-                    packedObjects.Add(reportKey, new Value { Application = appMeta, PackedValue = valuePackObject });
-                }
-
-                return formatSpec.Formatter(packedObjects);
+                return value;
             }
 
             return FormattedValue.Unhandled;

src/Ryujinx/Utilities/PlayReport/Delegates.cs

@@ -1,6 +1,4 @@
-using System.Collections.Generic;
-
-namespace Ryujinx.Ava.Utilities.PlayReport
+namespace Ryujinx.Ava.Utilities.PlayReport
 {
     /// <summary>
     /// The delegate type that powers single value formatters.<br/>
@@ -12,7 +10,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport
     /// <br/>
     /// OR a signal to reset the value that the caller is using the <see cref="Analyzer"/> for. 
     /// </summary>
-    public delegate FormattedValue ValueFormatter(Value value);
+    public delegate FormattedValue SingleValueFormatter(SingleValue value);
 
     /// <summary>
     /// The delegate type that powers multiple value formatters.<br/>
@@ -24,7 +22,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport
     /// <br/>
     /// OR a signal to reset the value that the caller is using the <see cref="Analyzer"/> for. 
     /// </summary>
-    public delegate FormattedValue MultiValueFormatter(Value[] value);
+    public delegate FormattedValue MultiValueFormatter(MultiValue value);
 
     /// <summary>
     /// The delegate type that powers multiple value formatters.
@@ -38,5 +36,5 @@ namespace Ryujinx.Ava.Utilities.PlayReport
     /// <br/>
     /// OR a signal to reset the value that the caller is using the <see cref="Analyzer"/> for. 
     /// </summary>
-    public delegate FormattedValue SparseMultiValueFormatter(Dictionary<string, Value> values);
+    public delegate FormattedValue SparseMultiValueFormatter(SparseMultiValue value);
 }

src/Ryujinx/Utilities/PlayReport/MatchedValues.cs

@@ -0,0 +1,74 @@
+using MsgPack;
+using Ryujinx.Ava.Utilities.AppLibrary;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Ryujinx.Ava.Utilities.PlayReport
+{
+    public abstract class MatchedValue<T>
+    {
+        protected MatchedValue(T matched)
+        {
+            Matched = matched;
+        }
+        
+        /// <summary>
+        /// The currently running application's <see cref="ApplicationMetadata"/>.
+        /// </summary>
+        public ApplicationMetadata Application { get; init; }
+        
+        /// <summary>
+        /// The entire play report.
+        /// </summary>
+        public Horizon.Prepo.Types.PlayReport PlayReport { get; init; }
+
+        /// <summary>
+        /// The matched value from the Play Report.
+        /// </summary>
+        public T Matched { get; init; }
+    }
+    
+    /// <summary>
+    /// The input data to a <see cref="SingleValueFormatter"/>,
+    /// containing the currently running application's <see cref="ApplicationMetadata"/>,
+    /// and the matched <see cref="MessagePackObject"/> from the Play Report.
+    /// </summary>
+    public class SingleValue : MatchedValue<Value>
+    {
+        public SingleValue(Value matched) : base(matched)
+        {
+        }
+    }
+
+    /// <summary>
+    /// The input data to a <see cref="MultiValueFormatter"/>,
+    /// containing the currently running application's <see cref="ApplicationMetadata"/>,
+    /// and the matched <see cref="MessagePackObject"/>s from the Play Report.
+    /// </summary>
+    public class MultiValue : MatchedValue<Value[]>
+    {
+        public MultiValue(Value[] matched) : base(matched)
+        {
+        }
+
+        public MultiValue(IEnumerable<MessagePackObject> matched) : base(Value.ConvertPackedObjects(matched))
+        {
+        }
+    }
+
+    /// <summary>
+    /// The input data to a <see cref="SparseMultiValueFormatter"/>,
+    /// containing the currently running application's <see cref="ApplicationMetadata"/>,
+    /// and the matched <see cref="MessagePackObject"/>s from the Play Report.
+    /// </summary>
+    public class SparseMultiValue : MatchedValue<Dictionary<string, Value>>
+    {
+        public SparseMultiValue(Dictionary<string, Value> matched) : base(matched)
+        {
+        }
+        
+        public SparseMultiValue(Dictionary<string, MessagePackObject> matched) : base(Value.ConvertPackedObjectMap(matched))
+        {
+        }
+    }
+}

src/Ryujinx/Utilities/PlayReport/PlayReports.cs

@@ -39,28 +39,28 @@
                     .AddValueFormatter("team_circle", PokemonSVUnionCircle)
             );
 
-        private static FormattedValue BreathOfTheWild_MasterMode(Value value)
-            => value.BoxedValue is 1 ? "Playing Master Mode" : FormattedValue.ForceReset;
+        private static FormattedValue BreathOfTheWild_MasterMode(SingleValue value)
+            => value.Matched.BoxedValue is 1 ? "Playing Master Mode" : FormattedValue.ForceReset;
 
-        private static FormattedValue TearsOfTheKingdom_CurrentField(Value value) =>
-            value.DoubleValue switch
+        private static FormattedValue TearsOfTheKingdom_CurrentField(SingleValue value) =>
+            value.Matched.DoubleValue switch
             {
                 > 800d => "Exploring the Sky Islands",
                 < -201d => "Exploring the Depths",
                 _ => "Roaming Hyrule"
             };
 
-        private static FormattedValue SuperMarioOdyssey_AssistMode(Value value)
-            => value.BoxedValue is 1 ? "Playing in Assist Mode" : "Playing in Regular Mode";
+        private static FormattedValue SuperMarioOdyssey_AssistMode(SingleValue value)
+            => value.Matched.BoxedValue is 1 ? "Playing in Assist Mode" : "Playing in Regular Mode";
 
-        private static FormattedValue SuperMarioOdysseyChina_AssistMode(Value value)
-            => value.BoxedValue is 1 ? "Playing in 帮助模式" : "Playing in 普通模式";
+        private static FormattedValue SuperMarioOdysseyChina_AssistMode(SingleValue value)
+            => value.Matched.BoxedValue is 1 ? "Playing in 帮助模式" : "Playing in 普通模式";
 
-        private static FormattedValue SuperMario3DWorldOrBowsersFury(Value value)
-            => value.BoxedValue is 0 ? "Playing Super Mario 3D World" : "Playing Bowser's Fury";
+        private static FormattedValue SuperMario3DWorldOrBowsersFury(SingleValue value)
+            => value.Matched.BoxedValue is 0 ? "Playing Super Mario 3D World" : "Playing Bowser's Fury";
         
-        private static FormattedValue MarioKart8Deluxe_Mode(Value value) 
-            => value.StringValue switch
+        private static FormattedValue MarioKart8Deluxe_Mode(SingleValue value) 
+            => value.Matched.StringValue switch
             {
                 // Single Player
                 "Single" => "Single Player",
@@ -87,11 +87,11 @@
                 _ => FormattedValue.ForceReset
             };
 
-        private static FormattedValue PokemonSVUnionCircle(Value value)
-            => value.BoxedValue is 0 ? "Playing Alone" : "Playing in a group";
+        private static FormattedValue PokemonSVUnionCircle(SingleValue value)
+            => value.Matched.BoxedValue is 0 ? "Playing Alone" : "Playing in a group";
 
-        private static FormattedValue PokemonSVArea(Value value) 
-            => value.StringValue switch
+        private static FormattedValue PokemonSVArea(SingleValue value) 
+            => value.Matched.StringValue switch
             {
                 // Base Game Locations
                 "a_w01" => "South Area One",

src/Ryujinx/Utilities/PlayReport/Specs.cs

@@ -1,4 +1,7 @@
 using FluentAvalonia.Core;
+using MsgPack;
+using Ryujinx.Ava.Utilities.AppLibrary;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -11,10 +14,11 @@ namespace Ryujinx.Ava.Utilities.PlayReport
     /// </summary>
     public class GameSpec
     {
+        private int _lastPriority;
+        
         public required string[] TitleIds { get; init; }
-        public List<FormatterSpec> SimpleValueFormatters { get; } = [];
-        public List<MultiFormatterSpec> MultiValueFormatters { get; } = [];
-        public List<SparseMultiFormatterSpec> SparseMultiValueFormatters { get; } = [];
+
+        public List<FormatterSpecBase> ValueFormatters { get; } = [];
 
 
         /// <summary>
@@ -24,8 +28,8 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         /// <param name="reportKey">The key name to match.</param>
         /// <param name="valueFormatter">The function which can return a potential formatted value.</param>
         /// <returns>The current <see cref="GameSpec"/>, for chaining convenience.</returns>
-        public GameSpec AddValueFormatter(string reportKey, ValueFormatter valueFormatter)
-            => AddValueFormatter(SimpleValueFormatters.Count, reportKey, valueFormatter);
+        public GameSpec AddValueFormatter(string reportKey, SingleValueFormatter valueFormatter)
+            => AddValueFormatter(_lastPriority++, reportKey, valueFormatter);
 
         /// <summary>
         /// Add a value formatter at a specific priority to the current <see cref="GameSpec"/>
@@ -36,11 +40,11 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         /// <param name="valueFormatter">The function which can return a potential formatted value.</param>
         /// <returns>The current <see cref="GameSpec"/>, for chaining convenience.</returns>
         public GameSpec AddValueFormatter(int priority, string reportKey,
-            ValueFormatter valueFormatter)
+            SingleValueFormatter valueFormatter)
         {
-            SimpleValueFormatters.Add(new FormatterSpec
+            ValueFormatters.Add(new FormatterSpec
             {
-                Priority = priority, ReportKey = reportKey, Formatter = valueFormatter
+                Priority = priority, ReportKeys = [reportKey], Formatter = valueFormatter
             });
             return this;
         }
@@ -53,7 +57,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         /// <param name="valueFormatter">The function which can format the values.</param>
         /// <returns>The current <see cref="GameSpec"/>, for chaining convenience.</returns>
         public GameSpec AddMultiValueFormatter(string[] reportKeys, MultiValueFormatter valueFormatter)
-            => AddMultiValueFormatter(MultiValueFormatters.Count, reportKeys, valueFormatter);
+            => AddMultiValueFormatter(_lastPriority++, reportKeys, valueFormatter);
 
         /// <summary>
         /// Add a multi-value formatter at a specific priority to the current <see cref="GameSpec"/>
@@ -66,7 +70,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         public GameSpec AddMultiValueFormatter(int priority, string[] reportKeys,
             MultiValueFormatter valueFormatter)
         {
-            MultiValueFormatters.Add(new MultiFormatterSpec
+            ValueFormatters.Add(new MultiFormatterSpec
             {
                 Priority = priority, ReportKeys = reportKeys, Formatter = valueFormatter
             });
@@ -84,7 +88,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         /// <param name="valueFormatter">The function which can format the values.</param>
         /// <returns>The current <see cref="GameSpec"/>, for chaining convenience.</returns>
         public GameSpec AddSparseMultiValueFormatter(string[] reportKeys, SparseMultiValueFormatter valueFormatter)
-            => AddSparseMultiValueFormatter(SparseMultiValueFormatters.Count, reportKeys, valueFormatter);
+            => AddSparseMultiValueFormatter(_lastPriority++, reportKeys, valueFormatter);
 
         /// <summary>
         /// Add a multi-value formatter at a specific priority to the current <see cref="GameSpec"/>
@@ -100,7 +104,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         public GameSpec AddSparseMultiValueFormatter(int priority, string[] reportKeys,
             SparseMultiValueFormatter valueFormatter)
         {
-            SparseMultiValueFormatters.Add(new SparseMultiFormatterSpec
+            ValueFormatters.Add(new SparseMultiFormatterSpec
             {
                 Priority = priority, ReportKeys = reportKeys, Formatter = valueFormatter
             });
@@ -111,30 +115,101 @@ namespace Ryujinx.Ava.Utilities.PlayReport
     /// <summary>
     /// A struct containing the data for a mapping of a key in a Play Report to a formatter for its potential value.
     /// </summary>
-    public struct FormatterSpec
+    public class FormatterSpec : FormatterSpecBase
     {
-        public required int Priority { get; init; }
-        public required string ReportKey { get; init; }
-        public ValueFormatter Formatter { get; init; }
+        public override bool GetData(Horizon.Prepo.Types.PlayReport playReport, out object result)
+        {
+            if (!playReport.ReportData.AsDictionary().TryGetValue(ReportKeys[0], out MessagePackObject valuePackObject))
+            {
+                result = null;
+                return false;
+            }
+
+            result = valuePackObject;
+            return true;
+        }
     }
 
     /// <summary>
     /// A struct containing the data for a mapping of an arbitrary key set in a Play Report to a formatter for their potential values.
     /// </summary>
-    public struct MultiFormatterSpec
+    public class MultiFormatterSpec : FormatterSpecBase
     {
-        public required int Priority { get; init; }
-        public required string[] ReportKeys { get; init; }
-        public MultiValueFormatter Formatter { get; init; }
+        public override bool GetData(Horizon.Prepo.Types.PlayReport playReport, out object result)
+        {
+            List<MessagePackObject> packedObjects = [];
+            foreach (var reportKey in ReportKeys)
+            {
+                if (!playReport.ReportData.AsDictionary().TryGetValue(reportKey, out MessagePackObject valuePackObject))
+                {
+                    result = null;
+                    return false;
+                }
+
+                packedObjects.Add(valuePackObject);
+            }
+
+            result = packedObjects;
+            return true;
+        }
     }
 
     /// <summary>
     /// A struct containing the data for a mapping of an arbitrary key set in a Play Report to a formatter for their sparsely populated potential values.
     /// </summary>
-    public struct SparseMultiFormatterSpec
+    public class SparseMultiFormatterSpec : FormatterSpecBase
     {
-        public required int Priority { get; init; }
-        public required string[] ReportKeys { get; init; }
-        public SparseMultiValueFormatter Formatter { get; init; }
+        public override bool GetData(Horizon.Prepo.Types.PlayReport playReport, out object result)
+        {
+            Dictionary<string, MessagePackObject> packedObjects = [];
+            foreach (var reportKey in ReportKeys)
+            {
+                if (!playReport.ReportData.AsDictionary().TryGetValue(reportKey, out MessagePackObject valuePackObject))
+                    continue;
+
+                packedObjects.Add(reportKey, valuePackObject);
+            }
+
+            result = packedObjects;
+            return true;
+        }
+    }
+    
+    public abstract class FormatterSpecBase
+    {
+        public abstract bool GetData(Horizon.Prepo.Types.PlayReport playReport, out object data);
+        
+        public int Priority { get; init; }
+        public string[] ReportKeys { get; init; }
+        public Delegate Formatter { get; init; }
+
+        public bool Format(ApplicationMetadata appMeta, Horizon.Prepo.Types.PlayReport playReport, out FormattedValue formattedValue)
+        {
+            formattedValue = default;
+            if (!GetData(playReport, out object data))
+                return false;
+
+            if (data is FormattedValue fv)
+            {
+                formattedValue = fv;
+                return true;
+            }
+
+            switch (Formatter)
+            {
+                case SingleValueFormatter svf when data is MessagePackObject mpo:
+                    formattedValue = svf(new SingleValue(mpo) { Application = appMeta, PlayReport = playReport });
+                    return true;
+                case MultiValueFormatter mvf when data is List<MessagePackObject> messagePackObjects:
+                    formattedValue = mvf(new MultiValue(messagePackObjects) { Application = appMeta, PlayReport = playReport });
+                    return true;
+                case SparseMultiValueFormatter smvf when
+                    data is Dictionary<string, MessagePackObject> sparseMessagePackObjects:
+                    formattedValue = smvf(new SparseMultiValue(sparseMessagePackObjects) { Application = appMeta, PlayReport = playReport });
+                    return true;
+                default:
+                    throw new InvalidOperationException("Formatter delegate is not of a known type!");
+            }
+        }
     }
 }

src/Ryujinx/Utilities/PlayReport/Value.cs

@@ -1,20 +1,20 @@
 using MsgPack;
-using Ryujinx.Ava.Utilities.AppLibrary;
 using System;
+using System.Collections.Generic;
+using System.Linq;
 
 namespace Ryujinx.Ava.Utilities.PlayReport
 {
     /// <summary>
-    /// The input data to a <see cref="ValueFormatter"/>,
-    /// containing the currently running application's <see cref="ApplicationMetadata"/>,
+    /// The base input data to a ValueFormatter delegate,
     /// and the matched <see cref="MessagePackObject"/> from the Play Report.
     /// </summary>
-    public class Value
+    public readonly struct Value
     {
-        /// <summary>
-        /// The currently running application's <see cref="ApplicationMetadata"/>.
-        /// </summary>
-        public ApplicationMetadata Application { get; init; }
+        public Value(MessagePackObject packedValue)
+        {
+            PackedValue = packedValue;
+        }
 
         /// <summary>
         /// The matched value from the Play Report.
@@ -37,6 +37,17 @@ namespace Ryujinx.Ava.Utilities.PlayReport
                 : boxed.ToString();
         }
 
+        public static implicit operator Value(MessagePackObject matched) => new(matched);
+
+        public static Value[] ConvertPackedObjects(IEnumerable<MessagePackObject> packObjects)
+            => packObjects.Select(packObject => new Value(packObject)).ToArray();
+
+        public static Dictionary<string, Value> ConvertPackedObjectMap(Dictionary<string, MessagePackObject> packObjects)
+            => packObjects.ToDictionary(
+                x => x.Key,
+                x => new Value(x.Value)
+            );
+
         #region AsX accessors
 
         public bool BooleanValue => PackedValue.AsBoolean();
@@ -57,7 +68,7 @@ namespace Ryujinx.Ava.Utilities.PlayReport
     }
 
     /// <summary>
-    /// A potential formatted value returned by a <see cref="ValueFormatter"/>.
+    /// A potential formatted value returned by a ValueFormatter delegate.
     /// </summary>
     public readonly struct FormattedValue
     {
@@ -103,28 +114,47 @@ namespace Ryujinx.Ava.Utilities.PlayReport
         /// <summary>
         /// Return this to tell the caller there is no value to return.
         /// </summary>
-        public static FormattedValue Unhandled => default;
+        public static readonly FormattedValue Unhandled = default;
 
         /// <summary>
         /// Return this to suggest the caller reset the value it's using the <see cref="Analyzer"/> for.
         /// </summary>
-        public static FormattedValue ForceReset => new() { Handled = true, Reset = true };
+        public static readonly FormattedValue ForceReset = new() { Handled = true, Reset = true };
 
         /// <summary>
-        /// A delegate singleton you can use to always return <see cref="ForceReset"/> in a <see cref="ValueFormatter"/>.
+        /// A delegate singleton you can use to always return <see cref="ForceReset"/> in a <see cref="SingleValueFormatter"/>.
         /// </summary>
-        public static readonly ValueFormatter SingleAlwaysResets = _ => ForceReset;
+        public static readonly SingleValueFormatter SingleAlwaysResets = _ => ForceReset;
 
         /// <summary>
         /// A delegate singleton you can use to always return <see cref="ForceReset"/> in a <see cref="MultiValueFormatter"/>.
         /// </summary>
         public static readonly MultiValueFormatter MultiAlwaysResets = _ => ForceReset;
+        
+        /// <summary>
+        /// A delegate singleton you can use to always return <see cref="ForceReset"/> in a <see cref="SparseMultiValueFormatter"/>.
+        /// </summary>
+        public static readonly SparseMultiValueFormatter SparseMultiAlwaysResets = _ => ForceReset;
 
         /// <summary>
         /// A delegate factory you can use to always return the specified
-        /// <paramref name="formattedValue"/> in a <see cref="ValueFormatter"/>.
+        /// <paramref name="formattedValue"/> in a <see cref="SingleValueFormatter"/>.
         /// </summary>
         /// <param name="formattedValue">The string to always return for this delegate instance.</param>
-        public static ValueFormatter AlwaysReturns(string formattedValue) => _ => formattedValue;
+        public static SingleValueFormatter SingleAlwaysReturns(string formattedValue) => _ => formattedValue;
+        
+        /// <summary>
+        /// A delegate factory you can use to always return the specified
+        /// <paramref name="formattedValue"/> in a <see cref="MultiValueFormatter"/>.
+        /// </summary>
+        /// <param name="formattedValue">The string to always return for this delegate instance.</param>
+        public static MultiValueFormatter MultiAlwaysReturns(string formattedValue) => _ => formattedValue;
+        
+        /// <summary>
+        /// A delegate factory you can use to always return the specified
+        /// <paramref name="formattedValue"/> in a <see cref="SparseMultiValueFormatter"/>.
+        /// </summary>
+        /// <param name="formattedValue">The string to always return for this delegate instance.</param>
+        public static SparseMultiValueFormatter SparseMultiAlwaysReturns(string formattedValue) => _ => formattedValue;
     }
 }