Merge pull request #6686 from Susko3/log-sdl-errors

Log SDL3 errors if function calls fail and the error is not checked

Author: bdach

osu.Framework.iOS/IOSWindow.cs

@@ -38,7 +38,7 @@ public IOSWindow(GraphicsSurfaceType surfaceType, string appName)
 
         public override void Create()
         {
-            SDL_SetHint(SDL_HINT_IOS_HIDE_HOME_INDICATOR, "2"u8);
+            SDL_SetHint(SDL_HINT_IOS_HIDE_HOME_INDICATOR, "2"u8).LogErrorIfFailed();
 
             base.Create();
 
@@ -59,7 +59,7 @@ protected override unsafe void RunMainLoop()
             // iOS may be a good forward direction if this ever comes up, as a user may see a potentially higher
             // frame rate with multi-threaded mode turned on, but it is going to give them worse input latency
             // and higher power usage.
-            SDL_SetiOSAnimationCallback(SDLWindowHandle, 1, &runFrame, ObjectHandle.Handle);
+            SDL_SetiOSAnimationCallback(SDLWindowHandle, 1, &runFrame, ObjectHandle.Handle).ThrowIfFailed();
         }
 
         [UnmanagedCallersOnly(CallConvs = new[] { typeof(CallConvCdecl) })]

osu.Framework/Platform/Linux/SDL3LinuxWindow.cs

@@ -11,7 +11,7 @@ internal class SDL3LinuxWindow : SDL3DesktopWindow
         public SDL3LinuxWindow(GraphicsSurfaceType surfaceType, string appName, bool bypassCompositor)
             : base(surfaceType, appName)
         {
-            SDL_SetHint(SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR, bypassCompositor ? "1"u8 : "0"u8);
+            SDL_SetHint(SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR, bypassCompositor ? "1"u8 : "0"u8).LogErrorIfFailed();
         }
     }
 }

osu.Framework/Platform/SDL3/SDL3Clipboard.cs

@@ -42,7 +42,7 @@ public SDL3Clipboard(IImageFormat imageFormat)
         // assume that empty text means no text.
         public override string? GetText() => SDL_HasClipboardText() ? SDL_GetClipboardText() : null;
 
-        public override void SetText(string text) => SDL_SetClipboardText(text);
+        public override void SetText(string text) => SDL_SetClipboardText(text).LogErrorIfFailed();
 
         public override Image<TPixel>? GetImage<TPixel>()
         {

osu.Framework/Platform/SDL3/SDL3DesktopWindow.cs

@@ -17,9 +17,9 @@ protected override unsafe void UpdateWindowStateAndSize(WindowState state, Displ
             // this reset is required even on changing from one fullscreen resolution to another.
             // if it is not included, the GL context will not get the correct size.
             // this is mentioned by multiple sources as an SDL issue, which seems to resolve by similar means (see https://discourse.libsdl.org/t/sdl-setwindowsize-does-not-work-in-fullscreen/20711/4).
-            SDL_SetWindowBordered(SDLWindowHandle, true);
-            SDL_SetWindowFullscreen(SDLWindowHandle, false);
-            SDL_RestoreWindow(SDLWindowHandle);
+            SDL_SetWindowBordered(SDLWindowHandle, true).LogErrorIfFailed();
+            SDL_SetWindowFullscreen(SDLWindowHandle, false).LogErrorIfFailed();
+            SDL_RestoreWindow(SDLWindowHandle).LogErrorIfFailed();
 
             base.UpdateWindowStateAndSize(state, display, displayMode);
         }

osu.Framework/Platform/SDL3/SDL3Exception.cs

@@ -0,0 +1,10 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System;
+using static SDL.SDL3;
+
+namespace osu.Framework.Platform.SDL3
+{
+    internal class SDL3Exception(string? expression) : Exception($"{SDL_GetError()} (at {expression})");
+}

osu.Framework/Platform/SDL3/SDL3Extensions.cs

@@ -1,12 +1,15 @@
 // Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System;
 using System.Drawing;
+using System.Runtime.CompilerServices;
 using osu.Framework.Extensions.EnumExtensions;
 using osu.Framework.Graphics.Primitives;
 using osu.Framework.Input;
 using osu.Framework.Input.Bindings;
 using osu.Framework.Input.StateChanges;
+using osu.Framework.Logging;
 using osuTK.Input;
 using SDL;
 using static SDL.SDL3;
@@ -1045,7 +1048,7 @@ public static unsafe DisplayMode ToDisplayMode(this SDL_DisplayMode mode, int di
         {
             int bpp;
             uint unused;
-            SDL_GetMasksForPixelFormat(mode.format, &bpp, &unused, &unused, &unused, &unused);
+            SDL_GetMasksForPixelFormat(mode.format, &bpp, &unused, &unused, &unused, &unused).ThrowIfFailed();
             return new DisplayMode(SDL_GetPixelFormatName(mode.format), new Size(mode.w, mode.h), bpp, mode.refresh_rate, displayIndex);
         }
 
@@ -1144,5 +1147,100 @@ public static string ReadableName(this SDL_LogPriority priority)
             SDL_ClearError();
             return error;
         }
+
+        private static void logError(string? expression)
+        {
+            Logger.Log($"SDL error: {SDL_GetError()}");
+            if (!string.IsNullOrEmpty(expression))
+                Logger.Log($"at {expression}");
+        }
+
+        public static SDLBool LogErrorIfFailed(this SDLBool returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+        {
+            if (!returnValue)
+                logError(expression);
+
+            return returnValue;
+        }
+
+        public static void ThrowIfFailed(this SDLBool returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+        {
+            if (!returnValue)
+                throw new SDL3Exception(expression);
+        }
+
+        public static SDL_PropertiesID ThrowIfFailed(this SDL_PropertiesID returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+        {
+            if (returnValue == 0)
+                throw new SDL3Exception(expression);
+
+            return returnValue;
+        }
+
+        public static int LogErrorIfFailed(this int returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+        {
+            if (returnValue == -1)
+                logError(expression);
+
+            return returnValue;
+        }
+
+        public static IntPtr ThrowIfFailed(this IntPtr returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+        {
+            if (returnValue == IntPtr.Zero)
+                throw new SDL3Exception(expression);
+
+            return returnValue;
+        }
+
+        public static SDLArray<T>? LogErrorIfFailed<T>(this SDLArray<T>? returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+            where T : unmanaged
+        {
+            if (returnValue == null)
+                logError(expression);
+
+            return returnValue;
+        }
+
+        public static SDL_PenDeviceType ThrowIfFailed(this SDL_PenDeviceType returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+        {
+            if (returnValue == SDL_PenDeviceType.SDL_PEN_DEVICE_TYPE_INVALID)
+                throw new SDL3Exception(expression);
+
+            return returnValue;
+        }
+
+        public static string? LogErrorIfFailed(this string? returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+        {
+            if (returnValue == null)
+                logError(expression);
+
+            return returnValue;
+        }
+
+        public static SDL_DisplayID LogErrorIfFailed(this SDL_DisplayID returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+        {
+            if (returnValue == 0)
+                logError(expression);
+
+            return returnValue;
+        }
+
+        public static SDL_DisplayID ThrowIfFailed(this SDL_DisplayID returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+        {
+            if (returnValue == 0)
+                throw new SDL3Exception(expression);
+
+            return returnValue;
+        }
+
+        public static unsafe T* LogErrorIfFailed<T>(T* returnValue, [CallerArgumentExpression("returnValue")] string? expression = null)
+            where T : unmanaged
+        {
+            if (returnValue == null)
+                logError(expression);
+
+            return returnValue;
+        }
     }
 }

osu.Framework/Platform/SDL3/SDL3GraphicsSurface.cs

@@ -33,12 +33,12 @@ public SDL3GraphicsSurface(SDL3Window window, GraphicsSurfaceType surfaceType)
             switch (surfaceType)
             {
                 case GraphicsSurfaceType.OpenGL:
-                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_RED_SIZE, 8);
-                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_GREEN_SIZE, 8);
-                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_BLUE_SIZE, 8);
-                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_ACCUM_ALPHA_SIZE, 0);
-                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_DEPTH_SIZE, 16);
-                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_STENCIL_SIZE, 8);
+                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_RED_SIZE, 8).ThrowIfFailed();
+                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_GREEN_SIZE, 8).ThrowIfFailed();
+                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_BLUE_SIZE, 8).ThrowIfFailed();
+                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_ACCUM_ALPHA_SIZE, 0).ThrowIfFailed();
+                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_DEPTH_SIZE, 16).ThrowIfFailed();
+                    SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_STENCIL_SIZE, 8).ThrowIfFailed();
                     break;
 
                 case GraphicsSurfaceType.Vulkan:
@@ -60,7 +60,7 @@ public void Initialise()
         public Size GetDrawableSize()
         {
             int width, height;
-            SDL_GetWindowSizeInPixels(window.SDLWindowHandle, &width, &height);
+            SDL_GetWindowSizeInPixels(window.SDLWindowHandle, &width, &height).ThrowIfFailed();
             return new Size(width, height);
         }
 
@@ -70,27 +70,27 @@ private void initialiseOpenGL()
         {
             if (RuntimeInfo.IsMobile)
             {
-                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_PROFILE_MASK, (int)SDL_GLProfile.SDL_GL_CONTEXT_PROFILE_ES);
+                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_PROFILE_MASK, (int)SDL_GLProfile.SDL_GL_CONTEXT_PROFILE_ES).ThrowIfFailed();
 
                 // Minimum OpenGL version for ES profile:
-                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_MAJOR_VERSION, 3);
-                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_MINOR_VERSION, 0);
+                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_MAJOR_VERSION, 3).ThrowIfFailed();
+                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_MINOR_VERSION, 0).ThrowIfFailed();
             }
             else
             {
-                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_PROFILE_MASK, (int)SDL_GLProfile.SDL_GL_CONTEXT_PROFILE_CORE);
+                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_PROFILE_MASK, (int)SDL_GLProfile.SDL_GL_CONTEXT_PROFILE_CORE).ThrowIfFailed();
 
                 // Minimum OpenGL version for core profile:
-                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_MAJOR_VERSION, 3);
-                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_MINOR_VERSION, 2);
+                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_MAJOR_VERSION, 3).ThrowIfFailed();
+                SDL_GL_SetAttribute(SDL_GLAttr.SDL_GL_CONTEXT_MINOR_VERSION, 2).ThrowIfFailed();
             }
 
             context = SDL_GL_CreateContext(window.SDLWindowHandle);
 
             if (context == null)
                 throw new InvalidOperationException($"Failed to create an SDL3 GL context ({SDL_GetError()})");
 
-            SDL_GL_MakeCurrent(window.SDLWindowHandle, context);
+            SDL_GL_MakeCurrent(window.SDLWindowHandle, context).ThrowIfFailed();
 
             loadBindings();
         }
@@ -126,29 +126,13 @@ private void loadEntryPoints(GraphicsBindingsBase bindings)
                     string? str = Marshal.PtrToStringAnsi(new IntPtr(ptr));
 
                     Debug.Assert(str != null);
-                    entryPointsInstance[i] = getProcAddress(str);
+                    entryPointsInstance[i] = SDL_GL_GetProcAddress(str);
                 }
             }
 
             pointsInfo.SetValue(bindings, entryPointsInstance);
         }
 
-        private IntPtr getProcAddress(string symbol)
-        {
-            const SDL_LogCategory error_category = SDL_LogCategory.SDL_LOG_CATEGORY_ERROR;
-            SDL_LogPriority oldPriority = SDL_GetLogPriority(error_category);
-
-            // Prevent logging calls to SDL_GL_GetProcAddress() that fail on systems which don't have the requested symbol (typically macOS).
-            SDL_SetLogPriority(error_category, SDL_LogPriority.SDL_LOG_PRIORITY_INFO);
-
-            IntPtr ret = SDL_GL_GetProcAddress(symbol);
-
-            // Reset the logging behaviour.
-            SDL_SetLogPriority(error_category, oldPriority);
-
-            return ret;
-        }
-
         int? IOpenGLGraphicsSurface.BackbufferFramebuffer
         {
             get
@@ -195,7 +179,7 @@ bool IOpenGLGraphicsSurface.VerticalSync
         void IOpenGLGraphicsSurface.DeleteContext(IntPtr context) => SDL_GL_DestroyContext((SDL_GLContextState*)context);
         void IOpenGLGraphicsSurface.MakeCurrent(IntPtr context) => SDL_GL_MakeCurrent(window.SDLWindowHandle, (SDL_GLContextState*)context);
         void IOpenGLGraphicsSurface.ClearCurrent() => SDL_GL_MakeCurrent(window.SDLWindowHandle, null);
-        IntPtr IOpenGLGraphicsSurface.GetProcAddress(string symbol) => getProcAddress(symbol);
+        IntPtr IOpenGLGraphicsSurface.GetProcAddress(string symbol) => SDL_GL_GetProcAddress(symbol);
 
         #endregion
 
@@ -217,7 +201,7 @@ bool IOpenGLGraphicsSurface.VerticalSync
         #region Android-specific implementation
 
         [SupportedOSPlatform("android")]
-        IntPtr IAndroidGraphicsSurface.JniEnvHandle => SDL_GetAndroidJNIEnv();
+        IntPtr IAndroidGraphicsSurface.JniEnvHandle => SDL_GetAndroidJNIEnv().ThrowIfFailed();
 
         [SupportedOSPlatform("android")]
         IntPtr IAndroidGraphicsSurface.SurfaceHandle => window.SurfaceHandle;

osu.Framework/Platform/SDL3/SDL3MobileWindow.cs

@@ -15,7 +15,7 @@ public SDL3MobileWindow(GraphicsSurfaceType surfaceType, string appName)
         protected override unsafe void UpdateWindowStateAndSize(WindowState state, Display display, DisplayMode displayMode)
         {
             // This sets the status bar to hidden.
-            SDL_SetWindowFullscreen(SDLWindowHandle, true);
+            SDL_SetWindowFullscreen(SDLWindowHandle, true).LogErrorIfFailed();
 
             // Don't run base logic at all. Let's keep things simple.
         }