sdl3: init at 3.1.8

[getchoo]

Description of changes

Closes #324694

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[pbsds]

freebsd has the version at 3.1.2, and that version seems to be the case in te rev you've selected as well:

https://github.com/libsdl-org/SDL/blob/730d5cf2f889b553852bd02b2d56dedf8690872a/include/SDL3/SDL_version.h#L41-L66

[getchoo]

Looks like these tags were yanked. See libsdl-org/SDL#10367

Quoting from upstream:

Because the API is changing daily and we don't want people to freeze on a specific version. We have an ABI stable release coming soon, and we'll tag that for people to play with.

Based on this, the package here could be merged as is (though i'll give it a commit rev bump) IMO. An equally good alternative would be waiting for that stable ABI release soon ™️. Feedback welcome :)

[pbsbot]

Result of nixpkgs-review pr 326699 run on x86_64-linux 1

3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

[pbsds]

sorry for the delay. This LGTM for the most part, but i think this expression risks being bumped down to SDL2 by nix-update or r-ryantm. Could you set updateScript?

[OPNA2608]

Configure warns about some things that are still missing:

-- Could NOT find OpenGL (missing: OPENGL_opengl_LIBRARY OPENGL_glx_LIBRARY OPENGL_INCLUDE_DIR)
[...]
-- Checking for modules 'wayland-client>=1.18;wayland-egl;wayland-cursor;egl;xkbcommon>=0.5.0'
--   No package 'egl' found
[...]
-- Checking for modules 'libunwind;libunwind-generic'
--   No package 'libunwind' found
--   No package 'libunwind-generic' found
-- Checking for module 'libusb-1.0>=1.0.16'
--   No package 'libusb-1.0' found
-- Could NOT find LibUSB (missing: LibUSB_LIBRARY LibUSB_INCLUDE_PATH) (found version "LibUSB_VERSION-NOTFOUND")

I think this also needs the dlopen workaround from our SDL2 packaging, so sdl3 users don't need to worry about adding all the dlopened dependencies to their LD_LIBRARY_PATH / rpath?

There's also a test subdirectory with tests that we could run via

  cmakeFlags = [
    (lib.cmakeBool "SDL_TESTS" finalAttrs.finalPackage.doCheck)
  ];

  doCheck = stdenv.buildPlatform.canExecute stdenv.hostPlatform;

Can we get them working? (Though I don't think sdl2 runs them either, so 🤷‍♀️)

[getchoo]

Sorry for the wait. I've updated upstream's latest preview tag, (hopefully) applied the correct RPATH changes, and made a ton of overrides for build options similar to the current SDL2 package

Configure warns about some things that are still missing:

-- Could NOT find OpenGL (missing: OPENGL_opengl_LIBRARY OPENGL_glx_LIBRARY OPENGL_INCLUDE_DIR)
[...]
-- Checking for modules 'wayland-client>=1.18;wayland-egl;wayland-cursor;egl;xkbcommon>=0.5.0'
--   No package 'egl' found
[...]
-- Checking for modules 'libunwind;libunwind-generic'
--   No package 'libunwind' found
--   No package 'libunwind-generic' found
-- Checking for module 'libusb-1.0>=1.0.16'
--   No package 'libusb-1.0' found
-- Could NOT find LibUSB (missing: LibUSB_LIBRARY LibUSB_INCLUDE_PATH) (found version "LibUSB_VERSION-NOTFOUND")

Is there any example project similar to what you're compiling here we could add to passthru.tests? Would probably help in not tripping this for any future dependency changes

Can we get them working? (Though I don't think sdl2 runs them either, so 🤷‍♀️)

Two are still broken, but I've left the option there for when we eventually figure out how to

[OPNA2608]

Is there any example project similar to what you're compiling here

What I was compiling there was the SDL3 package.

any […] project […] we could add to passthru.tests? Would probably help in not tripping this for any future dependency changes

I know that shadps4 needs SDL3, but it's pinning 3.1.2. With the "daily-changing API", not sure if removing the pin would break something. It doesn't have a VM test to check working SDL3 functionality, but one could be written to install & run an open toolchain's hello world example and wait for the text output.

SDL_EXAMPLES should build the examples, and SDL_INSTALL_EXAMPLES (this is missing an option() declaration?, but is being used here) should install them to $out/libexec/installed-examples/SDL3. Some of them might have on-screen text, maybe a basic VM test could be written that tries to run one of them & waits for working text rendering? Better than nothing maybe.

[marcin-serwin]

There are some changes needed to make it work with wayland:

• wayland-scanner is a build time dependency, it's not needed at runtime
• libxkbcommon is not needed by X11 since it has its own XKB implementation, but it's needed by wayland
• SDL_ShowMessageBox fails with posix_spawn() failed: No such file or directory if it doesn't find zenity in the PATH, we should patch it to point to the store path

Patch with the above changes

diff --git a/pkgs/by-name/sd/sdl3/package.nix b/pkgs/by-name/sd/sdl3/package.nix
index cff003e1802f..505272cca80e 100644
--- a/pkgs/by-name/sd/sdl3/package.nix
+++ b/pkgs/by-name/sd/sdl3/package.nix
@@ -28,6 +28,7 @@
   wayland,
   wayland-scanner,
   xorg,
+  zenity,
   alsaSupport ? stdenv.hostPlatform.isLinux && !stdenv.hostPlatform.isAndroid,
   dbusSupport ? stdenv.hostPlatform.isLinux && !stdenv.hostPlatform.isAndroid,
   drmSupport ? stdenv.hostPlatform.isLinux && !stdenv.hostPlatform.isAndroid,
@@ -68,10 +69,11 @@ stdenv.mkDerivation (finalAttrs: {
     cmake
     ninja
     validatePkgConfig
-  ];
+  ] ++ lib.optional waylandSupport wayland-scanner;
 
   buildInputs =
     finalAttrs.dlopenBuildInputs
+    ++ lib.optional waylandSupport zenity
     ++ lib.optionals ibusSupport [
       fcitx5
       ibus
@@ -106,10 +108,9 @@ stdenv.mkDerivation (finalAttrs: {
     ++ lib.optional sndioSupport sndio
     ++ lib.optionals waylandSupport [
       wayland
-      wayland-scanner
+      libxkbcommon
     ]
     ++ lib.optionals x11Support [
-      libxkbcommon
       xorg.libX11
       xorg.libXScrnSaver
       xorg.libXcursor
@@ -125,6 +126,11 @@ stdenv.mkDerivation (finalAttrs: {
     lib.optional (openglSupport && !stdenv.hostPlatform.isDarwin) libGL
     ++ lib.optional x11Support xorg.libX11;
 
+  postPatch = lib.optionalString waylandSupport ''
+    substituteInPlace src/video/wayland/SDL_waylandmessagebox.c \
+      --replace-fail '"zenity"' '"${zenity}/bin/zenity"'
+  '';
+
   cmakeFlags = [
     (lib.cmakeBool "SDL_ALSA" alsaSupport)
     (lib.cmakeBool "SDL_DBUS" dbusSupport)

[getchoo]

The snake game example is now built as a separate derivation to test our RPATH hacks, and then run in a VM test

[getchoo]

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 326699

---

aarch64-linux

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

---

aarch64-darwin

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

[Green-Sky]

They cut a new preview release https://github.com/libsdl-org/SDL/releases/tag/preview-3.1.8 which adds tray icon support. It currently requires libayatana-appindicator or libappindicator-gtk3 on linux.

[getchoo]

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 326699

---

aarch64-linux

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

---

x86_64-darwin

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

---

aarch64-darwin

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

[OPNA2608]

Let's complete the list of checked platforms:

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 326699

---

x86_64-linux

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

---

Also built sdl3.passthru.tests.

At this point, I think we should just send this.

[Green-Sky]

And another preview release 😄 . This time they are calling it the first release candidate.
https://github.com/libsdl-org/SDL/releases/tag/prerelease-3.1.10

[getchoo]

At this point it's been almost 6 months, so honestly I'm fine landing this without being on the latest tag and making a follow up, as we've already tested the current rev. Committers feel free to merge :)

If no one does, I'll try to bump it in the next couple days and go through the testing/nixpkgs-review process again

[pbsds]

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 326699

---

x86_64-linux

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

---

aarch64-linux

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

---

x86_64-darwin

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

---

aarch64-darwin

✅ 3 packages built:

• sdl3
• sdl3.dev
• sdl3.lib

[GaetanLepage]

Let's move on with this. We will be able to fix eventual issues in follow-up PRs.

[nixpkgs-ci]

Successfully created backport PR for release-24.11:

• [Backport release-24.11] sdl3: init at 3.1.8 #375314