Merge pull request #4764 from peppy/fix-unlimited-update-handling

Add better documentation and handling of update rate extremities
ppy · Sep 7, 2021 · 3739063 · 3739063
2 parents c8f0e4f + 52101f2
commit 3739063
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 7 deletions.
diff --git a/osu.Framework/Graphics/Performance/FrameTimeDisplay.cs b/osu.Framework/Graphics/Performance/FrameTimeDisplay.cs
@@ -99,7 +99,7 @@ private void updateDisplay()
             elapsedSinceLastUpdate = 0;
 
             counter.Text = $"{displayFps:0}fps ({rollingElapsed:0.00}ms)"
-                           + (clock.Throttling ? $"{(clock.MaximumUpdateHz < 10000 ? clock.MaximumUpdateHz.ToString("0") : "∞").PadLeft(4)}hz" : string.Empty);
+                           + (clock.Throttling ? $"{(clock.MaximumUpdateHz > 0 && clock.MaximumUpdateHz < 10000 ? clock.MaximumUpdateHz.ToString("0") : "∞").PadLeft(4)}hz" : string.Empty);
         }
 
         private class CounterText : SpriteText

diff --git a/osu.Framework/Platform/GameHost.cs b/osu.Framework/Platform/GameHost.cs
@@ -190,6 +190,12 @@ public void UnregisterThread(GameThread thread)
 
         private double maximumUpdateHz;
 
+        /// <summary>
+        /// The target number of update frames per second when the game window is active.
+        /// </summary>
+        /// <remarks>
+        /// A value of 0 is treated the same as "unlimited" or <see cref="double.MaxValue"/>.
+        /// </remarks>
         public double MaximumUpdateHz
         {
             get => maximumUpdateHz;
@@ -198,12 +204,25 @@ public double MaximumUpdateHz
 
         private double maximumDrawHz;
 
+        /// <summary>
+        /// The target number of draw frames per second when the game window is active.
+        /// </summary>
+        /// <remarks>
+        /// A value of 0 is treated the same as "unlimited" or <see cref="double.MaxValue"/>.
+        /// </remarks>
         public double MaximumDrawHz
         {
             get => maximumDrawHz;
             set => DrawThread.ActiveHz = maximumDrawHz = value;
         }
 
+        /// <summary>
+        /// The target number of updates per second when the game window is inactive.
+        /// This is applied to all threads.
+        /// </summary>
+        /// <remarks>
+        /// A value of 0 is treated the same as "unlimited" or <see cref="double.MaxValue"/>.
+        /// </remarks>
         public double MaximumInactiveHz
         {
             get => DrawThread.InactiveHz;

diff --git a/osu.Framework/Statistics/PerformanceMonitor.cs b/osu.Framework/Statistics/PerformanceMonitor.cs
@@ -57,7 +57,7 @@ public bool EnablePerformanceProfiling
 
         private Thread thread;
 
-        public double FrameAimTime => 1000.0 / (Clock?.MaximumUpdateHz ?? double.MaxValue);
+        public double FrameAimTime => 1000.0 / (Clock?.MaximumUpdateHz > 0 ? Clock.MaximumUpdateHz : double.MaxValue);
 
         internal PerformanceMonitor(GameThread thread, IEnumerable<StatisticsCounterType> counters)
         {

diff --git a/osu.Framework/Threading/GameThread.cs b/osu.Framework/Threading/GameThread.cs
@@ -97,8 +97,11 @@ public CultureInfo CurrentCulture
         private CultureInfo culture;
 
         /// <summary>
-        /// The refresh rate this thread should run at when active. Only applies when the underlying clock is throttling.
+        /// The target number of updates per second when the game window is active.
         /// </summary>
+        /// <remarks>
+        /// A value of 0 is treated the same as "unlimited" or <see cref="double.MaxValue"/>.
+        /// </remarks>
         public double ActiveHz
         {
             get => activeHz;
@@ -112,8 +115,11 @@ public double ActiveHz
         private double activeHz = DEFAULT_ACTIVE_HZ;
 
         /// <summary>
-        /// The refresh rate this thread should run at when inactive. Only applies when the underlying clock is throttling.
+        /// The target number of updates per second when the game window is inactive.
         /// </summary>
+        /// <remarks>
+        /// A value of 0 is treated the same as "unlimited" or <see cref="double.MaxValue"/>.
+        /// </remarks>
         public double InactiveHz
         {
             get => inactiveHz;

diff --git a/osu.Framework/Timing/ThrottledFrameClock.cs b/osu.Framework/Timing/ThrottledFrameClock.cs
@@ -15,12 +15,15 @@ namespace osu.Framework.Timing
     public class ThrottledFrameClock : FramedClock
     {
         /// <summary>
-        /// The number of updated per second which is permitted.
+        /// The target number of updates per second. Only used when <see cref="Throttling"/> is <c>true</c>.
         /// </summary>
+        /// <remarks>
+        /// A value of 0 is treated the same as "unlimited" or <see cref="double.MaxValue"/>.
+        /// </remarks>
         public double MaximumUpdateHz = 1000.0;
 
         /// <summary>
-        /// Whether throttling should be enabled. Defaults to true.
+        /// Whether throttling should be enabled. Defaults to <c>true</c>.
         /// </summary>
         public bool Throttling = true;
 
@@ -37,7 +40,7 @@ public override void ProcessFrame()
 
             if (Throttling)
             {
-                if (MaximumUpdateHz > 0)
+                if (MaximumUpdateHz > 0 && MaximumUpdateHz < double.MaxValue)
                 {
                     throttle();
                 }