Upgrade to SDL3 #6234

Susko3 · 2024-04-08T15:10:56Z

osu! changes: https://github.com/ppy/osu/compare/master...Susko3:osu:wip-SDL3?expand=1

Changes

(SDL3-CS) from namespace SDL2 & class SDL to namespace SDL & class SDL3 (made more sense as the functions are imported from SDL3.dll)
(SDL3-CS) structs and enums now live in the namespace instead of being nested in the SDL3 class
(SDL3-CS) pointer types are now proper pointers instead of IntPtr, which means more "unsafe" code
(SDL3-CS) minor changes to return/struct types, reducing need for casts
(SDL3-CS) simple function signature changes: from ref, in & out to pointers (unfortunate, but automatically generating these would be hell)
(SDL3-CS) function that take strings now take ReadOnlySpan<byte>, requiring Encoding.UTF8.GetBytes() calls or UTF-8 string literals
(SDL3-CS) function pointers instead of delegates in native callback functions
simple renames done via SDL-provided build-scripits/rename_symbols.py
migrations from the Migrating to SDL 3.0 guide
minor update of SDL3ControllerBindings logic (basically per SDL3 migration guide)
removal of borderless fullscreen on macOS and Linux (merged into fullscreen with SDL3)
updated windowing logic to account for SDL_DisplayID instead of previously used display index
osu!framework DisplayMode.RefreshRate changed from int to float
SDL relative mouse mode instead of custom WindowsMouseHandler mouse logic
- including removal of custom tablet handling logic. SDL_pen.h would be the replacement for that, but it's currently only supported on Linux
updated WindowsWindow to account for SDL_SYSWMEVENT removal
- has caused some minor regressions in IME handling (the new method isn't giving us all the expected messages)
updated JetBrains.Annotations to latest version
renamed SDL2 → SDL3

Issues

IOpenGLGraphicsSurface.BackbufferFramebuffer used to return useful information on iOS
- waiting un upstream: [SDL3 migration] Migration for SDL_SysWMinfo.info.uikit.framebuffer libsdl-org/SDL#9430
- OpenGL probably won't work on iOS?
minor IME regressions on windows
releasing mouse button outside window with relative mouse mode causes next click to be ignored (SDL issue, it seems)
(possible issue) non-OTD tablet input with relative mouse mode on windows (WindowsMouseHandler logic was removed)

Future work

add full support for async raw mouse + keyboard on windows Async mouse input on windows #6235
look into windows IME regressions (and maybe switch to SDL IME events)
update my currently open PRs to SDL3 (when I feel like it)

Testing

I've tested mouse, keyboard

This helps with migrating enums, as ClangSharp doesn't put them in the `SDL3` class.

This renames SDL2 symbols to SDL3 names.

Also adds a bunch of `unsafe` /shrug

`WindowsMouseHandler` is not updated as it's on the chopping block.

This is done by SDL now, and the raw input event don't get reported by `SDL_SetWindowsMessageHook`.

https://github.com/libsdl-org/SDL/blob/e3395a75858373ddea040aca2ea210dff2dbead7/docs/README-migration.md?plain=1#L400-L401

https://github.com/libsdl-org/SDL/blob/e3395a75858373ddea040aca2ea210dff2dbead7/docs/README-migration.md?plain=1#L1693

Both osuTK and SDL3 use floats.

Still doesn't fix all compile problems.

…at specific index

https://github.com/libsdl-org/SDL/blob/main/docs/README-migration.md#sdl_syswmh

smoogipoo · 2024-04-08T16:10:12Z

Code quality wise this looks good to me.

smoogipoo · 2024-04-08T16:38:36Z

Linux: Tested on Wayland, and via XWayland, with the configs:

OSU_GRAPHICS_RENDERER=deferred OSU_GRAPHICS_SURFACE=vulkan SDL_VIDEO_DRIVER=wayland
OSU_GRAPHICS_RENDERER=deferred OSU_GRAPHICS_SURFACE=vulkan SDL_VIDEO_DRIVER=x11
OSU_GRAPHICS_RENDERER=opengl OSU_GRAPHICS_SURFACE=opengl SDL_VIDEO_DRIVER=wayland
OSU_GRAPHICS_RENDERER=opengl OSU_GRAPHICS_SURFACE=opengl SDL_VIDEO_DRIVER=x11

Haven't tested native X11, but that's probably okay. Resolved one issue in the process.

smoogipoo · 2024-04-08T17:34:05Z

iOS: OpenGL is broken, but we've disabled that renderer. Metal works fine.

smoogipoo · 2024-04-08T17:34:11Z

Android: Works fine.

smoogipoo · 2024-04-08T17:36:58Z

@peppy Maybe look to merge after the next release?

peppy · 2024-04-09T00:23:35Z

I wouldn't be against getting it in this week's release, thoughts?

smoogipoo · 2024-04-09T00:43:08Z

Can give it a shot. My concern would be the issues mentioned in the OP that I'm not fully sure the scope of.

peppy · 2024-04-09T01:05:34Z

Yeah let's leave it one release.

peppy

Code quality pass ✅
Tested on macOS ✅

peppy · 2024-04-09T06:51:01Z

osu.Framework/Platform/Linux/LinuxGameHost.cs

        protected override void SetupForRun()
        {
-            SDL.SDL_SetHint(SDL.SDL_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR, BypassCompositor ? "1" : "0");
+            SDL3.SDL_SetHint(SDL3.SDL_HINT_VIDEO_X11_NET_WM_BYPASS_COMPOSITOR, BypassCompositor ? "1"u8 : "0"u8);


Never seen this before 🤯

peppy · 2024-04-09T06:53:25Z

I think we can merge this at any point. We won't be doing another framework release / update before the osu! release this week.

That said, I'd probably want @bdach to sign off on this one at whatever depth he feels comfortable doing so. A bit of secondary windows testing is probably most important here, if anything.

bdach · 2024-04-09T07:10:35Z

I'm just going to test that this launches in all environments that I have and call it a day. I don't think further review is productive.

bdach

doesn't die. have not read code. expecting 30 issues that were really upstream issues to be fixed and another 30 to regress

Susko3 added 30 commits April 7, 2024 12:24

Convert SDL2 usages to using static

392703f

This helps with migrating enums, as ClangSharp doesn't put them in the `SDL3` class.

Run SDL build-scripits/rename_symbols.py

dc7ce4e

This renames SDL2 symbols to SDL3 names.

Switch to ppy.SDL3-CS and update usings

e936173

Convert to regular using (from using static)

4172d68

Update pointer types from IntPtr to specific ones

95c9f57

Also adds a bunch of `unsafe` /shrug

Use UTF-8 literals and encoding when passing in strings

b3706de

Use function pointers for callback functions

57112d0

`WindowsMouseHandler` is not updated as it's on the chopping block.

Update display and window event types

efdd370

Use proper types

c473ac0

Update hint names

78ba63d

Use fixed when passing in arrays

ce55edf

Update to float mouse coordinates in pollMouse()

6302046

Simple function signature updates

66e8ea1

Remove manual Window raw mouse handling

0923e41

This is done by SDL now, and the raw input event don't get reported by `SDL_SetWindowsMessageHook`.

Migrate SDL_SYSWMEVENT events to SDL_SetWindowsMessageHook()

2fb51d0

https://github.com/libsdl-org/SDL/blob/e3395a75858373ddea040aca2ea210dff2dbead7/docs/README-migration.md?plain=1#L400-L401

Remove borderless fullscreen on non-Windows platforms

0e78180

https://github.com/libsdl-org/SDL/blob/e3395a75858373ddea040aca2ea210dff2dbead7/docs/README-migration.md?plain=1#L1693

Simplify TryGetTouchName() logic

731a0dc

Change DisplayMode.RefreshRate to float

eb734d2

Both osuTK and SDL3 use floats.

Migrate displays + modes fetch to SDL3

b0830de

Store display ID instead of index

6f8b5dc

Still doesn't fix all compile problems.

Get index from SDL_DisplayID

d19fa6e

Update ensureWindowOnDisplay() logic and add helper to fetch display …

47be5b6

…at specific index

Update tryFetchDisplayMode()

095a413

Update getClosestDisplayMode()

2e24e8f

Use friendly helpers for getting strings from events

e27bfc5

Update touch event handling to use proper types

f2c1f28

Update joystick/gamepad event handling to use proper types

3a63be8

Use proper enum type in mouse button handling

91e50aa

Migrate from SDL_GetWindowWMInfo() to window properties

1593e95

https://github.com/libsdl-org/SDL/blob/main/docs/README-migration.md#sdl_syswmh

Comment out iOS code without migration path

45473dd

Susko3 added 2 commits April 8, 2024 16:01

Replace SDL2 with SDL3 in comments / string literals

79d8e44

Remove native logic that supported raw mouse

668fa9c

pull-request-size bot added the size/XXL label Apr 8, 2024

Susko3 added the area:platform label Apr 8, 2024

Susko3 added 2 commits April 8, 2024 17:37

Fix code inspection

6b3a997

Enable NRT in SDL3Extensions

22af688

Susko3 mentioned this pull request Apr 8, 2024

Async mouse input on windows #6235

Merged

1 task

Fix Vulkan+X11 not working

d5af283

smoogipoo approved these changes Apr 8, 2024

View reviewed changes

smoogipoo requested a review from peppy April 8, 2024 17:36

peppy approved these changes Apr 9, 2024

View reviewed changes

bdach approved these changes Apr 9, 2024

View reviewed changes

bdach merged commit f950831 into ppy:master Apr 9, 2024

Susko3 deleted the upgrade-to-SDL3 branch April 9, 2024 07:42

Susko3 mentioned this pull request Apr 9, 2024

Upgrade to SDL3 ppy/osu#27815

Merged

1 task

natsukagami mentioned this pull request Apr 11, 2024

Add support for custom clipboard formats #6223

Open

This was referenced May 20, 2024

SDL3: external tablet driver bug with high precision mouse enabled ppy/osu#28223

Closed

SDL3: IME regressions ppy/osu#28261

Closed

longnguyen2004 mentioned this pull request May 21, 2024

SDL3 issue: Cannot finish typing a word when using IME ppy/osu#28274

Closed

smoogipoo mentioned this pull request May 21, 2024

Bring back SDL2 by default, lock SDL3 behind environment variable #6292

Merged

5 tasks

Upgrade to SDL3 #6234

Upgrade to SDL3 #6234

Uh oh!

Conversation

Susko3 commented Apr 8, 2024 • edited by smoogipoo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Issues

Future work

Testing

Uh oh!

smoogipoo commented Apr 8, 2024

Uh oh!

smoogipoo commented Apr 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smoogipoo commented Apr 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smoogipoo commented Apr 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smoogipoo commented Apr 8, 2024

Uh oh!

peppy commented Apr 9, 2024

Uh oh!

smoogipoo commented Apr 9, 2024

Uh oh!

peppy commented Apr 9, 2024

Uh oh!

peppy left a comment

Choose a reason for hiding this comment

Uh oh!

peppy Apr 9, 2024

Choose a reason for hiding this comment

Uh oh!

peppy commented Apr 9, 2024

Uh oh!

bdach commented Apr 9, 2024

Uh oh!

bdach left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Susko3 commented Apr 8, 2024 •

edited by smoogipoo

Loading

smoogipoo commented Apr 8, 2024 •

edited

Loading

smoogipoo commented Apr 8, 2024 •

edited

Loading

smoogipoo commented Apr 8, 2024 •

edited

Loading