Fix IWindow.Resized being invoked with invalid data during `WindowM…

…ode` switch
Susko3 · Jul 1, 2023 · ab30bfa · ab30bfa
1 parent 2b4f248
commit ab30bfa
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/osu.Framework/Platform/SDL2Window.cs b/osu.Framework/Platform/SDL2Window.cs
@@ -326,7 +326,7 @@ protected virtual void HandleEventFromFilter(SDL.SDL_Event evt)
 
                 case SDL.SDL_EventType.SDL_WINDOWEVENT:
                     // polling via SDL_PollEvent blocks on resizes (https://stackoverflow.com/a/50858339)
-                    if (evt.window.windowEvent == SDL.SDL_WindowEventID.SDL_WINDOWEVENT_RESIZED)
+                    if (evt.window.windowEvent == SDL.SDL_WindowEventID.SDL_WINDOWEVENT_RESIZED && !updatingWindowStateAndSize)
                         fetchWindowSize();
 
                     break;

diff --git a/osu.Framework/Platform/SDL2Window_Windowing.cs b/osu.Framework/Platform/SDL2Window_Windowing.cs
@@ -534,7 +534,9 @@ private void updateAndFetchWindowSpecifics()
                 windowState = pendingWindowState.Value;
                 pendingWindowState = null;
 
+                updatingWindowStateAndSize = true;
                 UpdateWindowStateAndSize(windowState, currentDisplay, currentDisplayMode.Value);
+                updatingWindowStateAndSize = false;
 
                 fetchWindowSize();
 
@@ -722,6 +724,15 @@ private void storeWindowPositionToConfig()
         /// </summary>
         private bool storingSizeToConfig;
 
+        /// <summary>
+        /// Set when <see cref="UpdateWindowStateAndSize"/> is in progress to avoid <see cref="fetchWindowSize"/> being called with invalid data.
+        /// </summary>
+        /// <remarks>
+        /// Since <see cref="UpdateWindowStateAndSize"/> is a multi-step process, intermediary windows size changes might be invalid.
+        /// This is usually not a problem, but since <see cref="HandleEventFromFilter"/> runs out-of-band, invalid data might appear in those events.
+        /// </remarks>
+        private bool updatingWindowStateAndSize;
+
         private void storeWindowSizeToConfig()
         {
             if (WindowState != WindowState.Normal)