Port to SDL3

HexDecimal · HexDecimal · commit f05cba65a306 · 2025-03-26T18:05:38.000-07:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -39,13 +39,13 @@ else()
 endif()
 
 find_package(fmt CONFIG REQUIRED)
-find_package(SDL2 CONFIG REQUIRED)
+find_package(SDL3 CONFIG REQUIRED)
 find_package(libtcod CONFIG REQUIRED)
 target_link_libraries(
     ${PROJECT_NAME}
     PUBLIC
         fmt::fmt
-        SDL2::SDL2
+        SDL3::SDL3
         libtcod::libtcod
 )
 add_library(umbra::umbra ALIAS ${PROJECT_NAME})
diff --git a/src/demo/CMakeLists.txt b/src/demo/CMakeLists.txt
@@ -24,13 +24,12 @@ else()
     target_compile_options(${PROJECT_NAME} PRIVATE -Wall -Wextra)
 endif()
 
-find_package(SDL2 CONFIG REQUIRED)
+find_package(SDL3 CONFIG REQUIRED)
 find_package(libtcod CONFIG REQUIRED)
 target_link_libraries(
     ${PROJECT_NAME}
     PRIVATE
-        SDL2::SDL2
-        SDL2::SDL2main
+        SDL3::SDL3
         libtcod::libtcod
         umbra::umbra
 )
diff --git a/src/demo/circle.hpp b/src/demo/circle.hpp
@@ -35,8 +35,8 @@ class Circle : public UmbraModule {
   void onEvent(const SDL_Event& ev) override {
     TCOD_mouse_t tcod_mouse{};
     tcod::sdl2::process_event(ev, tcod_mouse);
-    if (ev.type == SDL_MOUSEMOTION) isGreen = circle.contains(tcod_mouse.cx, tcod_mouse.cy);
-    if (isGreen && ev.type == SDL_MOUSEBUTTONDOWN && ev.button.button == SDL_BUTTON_LEFT) {
+    if (ev.type == SDL_EVENT_MOUSE_MOTION) isGreen = circle.contains(tcod_mouse.cx, tcod_mouse.cy);
+    if (isGreen && ev.type == SDL_EVENT_MOUSE_BUTTON_DOWN && ev.button.button == SDL_BUTTON_LEFT) {
       setActive(false);
     }
   }
diff --git a/src/demo/demo.cpp b/src/demo/demo.cpp
@@ -63,8 +63,8 @@ void Demo::render() {
 }
 
 void Demo::onEvent(const SDL_Event& ev) {
-  if (ev.type == SDL_KEYDOWN) {
-    switch (ev.key.keysym.sym) {
+  if (ev.type == SDL_EVENT_KEY_DOWN) {
+    switch (ev.key.key) {
       case SDLK_SPACE:
         getEngine()->activateModule(666);
         break;
diff --git a/src/demo/main.cpp b/src/demo/main.cpp
@@ -25,7 +25,7 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#include <SDL.h>
+#include <SDL3/SDL_main.h>
 #include <stdio.h>
 
 #include "circle.hpp"
diff --git a/src/demo/matrix.cpp b/src/demo/matrix.cpp
@@ -26,7 +26,7 @@
  */
 #include "matrix.hpp"
 
-#include <SDL_timer.h>
+#include <SDL3/SDL_timer.h>
 #include <stdio.h>
 
 #include "globals.hpp"
@@ -38,7 +38,7 @@ constexpr std::array CHARACTERS{'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J'
                                 'v', 'w', 'x', 'y', 'z', '1', '2', '3', '4', '5', '6', '7', '8', '9'};
 
 bool Matrix::update() {
-  const auto now = SDL_GetTicks64();
+  const auto now = SDL_GetTicks();
   if (next_lead_ms <= now) {
     next_lead_ms = now + rng() % 200;
     auto& new_lead = leads.emplace_back();
@@ -50,7 +50,7 @@ bool Matrix::update() {
 }
 
 void Matrix::render() {
-  const auto now = SDL_GetTicks64();
+  const auto now = SDL_GetTicks();
   // Advance leads.
   for (auto& lead : leads) {
     if (lead.next_y_ms <= now) {
diff --git a/src/demo/panel.cpp b/src/demo/panel.cpp
@@ -26,7 +26,7 @@
  */
 #include "panel.hpp"
 
-#include <SDL_timer.h>
+#include <SDL3/SDL_timer.h>
 
 #include <algorithm>
 
@@ -43,7 +43,7 @@ void Panel::render() {
 }
 
 bool Panel::update() {
-  const uint64_t time = SDL_GetTicks64();
+  const uint64_t time = SDL_GetTicks();
   if (rect.mouseHover) {
     lastHover = time;
     posx += 3;
diff --git a/src/umbra/config.cpp b/src/umbra/config.cpp
@@ -161,7 +161,7 @@ void UmbraConfig::registerFont(const UmbraFont& new_font) {
 }
 
 bool UmbraConfig::activateFont(int shift) {
-  int s = CLAMP(-1, 1, shift);
+  int s = std::clamp(shift, -1, 1);
   // check if there are any registered fonts
   if (fonts.size() == 0)
     return false;  // can happen if a user uses the default terminal.png without registering any font
diff --git a/src/umbra/engine.cpp b/src/umbra/engine.cpp
@@ -26,8 +26,8 @@
  */
 #include "engine.hpp"
 
-#include <SDL_events.h>
-#include <SDL_timer.h>
+#include <SDL3/SDL_events.h>
+#include <SDL3/SDL_timer.h>
 #include <fmt/core.h>
 #include <stdarg.h>
 #include <stdio.h>
@@ -173,11 +173,11 @@ class UmbraModuleConfigParser : public ITCODParserListener {
   void error(const char* msg) override { UmbraLog::error(fmt::format("UmbraModuleConfigParser | {}", msg)); }
 };
 
-int UmbraEngine::onSDLEvent(void* userdata, SDL_Event* event) {
+bool UmbraEngine::onSDLEvent(void* userdata, SDL_Event* event) {
   auto self = static_cast<UmbraEngine*>(userdata);
   for (auto& module : self->activeModules) module->onEvent(*event);
-  if (event->type == SDL_QUIT) self->deactivateAll();
-  return 0;
+  if (event->type == SDL_EVENT_QUIT) self->deactivateAll();
+  return true;
 };
 
 UmbraEngine::UmbraEngine(const char* fileName, UmbraRegisterCallbackFlag flag) {
@@ -206,7 +206,7 @@ UmbraEngine::UmbraEngine(const char* fileName, UmbraRegisterCallbackFlag flag) {
   SDL_AddEventWatch(onSDLEvent, this);
 }
 
-UmbraEngine::~UmbraEngine() { SDL_DelEventWatch(onSDLEvent, this); }
+UmbraEngine::~UmbraEngine() { SDL_RemoveEventWatch(onSDLEvent, this); }
 
 void UmbraEngine::setWindowTitle(std::string title) { windowTitle = title; }
 
diff --git a/src/umbra/engine.hpp b/src/umbra/engine.hpp
@@ -27,7 +27,7 @@
 #ifndef UMBRA_ENGINE_HPP
 #define UMBRA_ENGINE_HPP
 
-#include <SDL_events.h>
+#include <SDL3/SDL_events.h>
 #include <fmt/printf.h>
 #include <libtcod/console_types.h>
 
@@ -399,7 +399,7 @@ class UmbraEngine {
    */
   void registerInternalModule(UmbraInternalModuleID id, UmbraModule* module);
   /// @brief SDL event watcher.
-  static int onSDLEvent(void* userdata, SDL_Event* event);
+  static bool onSDLEvent(void* userdata, SDL_Event* event);
 };
 
 #endif
diff --git a/src/umbra/imod_bsod.cpp b/src/umbra/imod_bsod.cpp
@@ -26,7 +26,7 @@
  */
 #include "imod_bsod.hpp"
 
-#include <SDL_timer.h>
+#include <SDL3/SDL_timer.h>
 
 #include <libtcod/libtcod.hpp>
 
diff --git a/src/umbra/imod_credits.cpp b/src/umbra/imod_credits.cpp
@@ -1,6 +1,6 @@
 #include "imod_credits.hpp"
 
-#include <SDL_timer.h>
+#include <SDL3/SDL_timer.h>
 
 #include <libtcod/libtcod.hpp>
 
@@ -15,7 +15,7 @@ void UmbraModCredits::onActivate() { startTime = SDL_GetTicks(); }
 
 bool UmbraModCredits::update() {
   alpha = 2.0f - (float)(SDL_GetTicks() - startTime) / (float)duration;
-  alpha = MIN(1.0f, alpha);
+  alpha = std::min(1.0f, alpha);
   if (alpha >= 0.0f)
     return true;
   else
diff --git a/src/umbra/imod_speed.cpp b/src/umbra/imod_speed.cpp
@@ -54,7 +54,7 @@ void UmbraModSpeed::onEvent(const SDL_Event& ev) {
   const int mouse_x = tcod_mouse.cx - rect.x;
   const int mouse_y = tcod_mouse.cy - rect.y;
   switch (ev.type) {
-    case SDL_MOUSEBUTTONDOWN:
+    case SDL_EVENT_MOUSE_BUTTON_DOWN:
       if (ev.button.button == SDL_BUTTON_LEFT) {
         if (minimiseButton.is(mouse_x, mouse_y)) {  // Minimize button is pressed
           isMinimized = !isMinimized;
@@ -71,15 +71,15 @@ void UmbraModSpeed::onEvent(const SDL_Event& ev) {
             dragZone.w = MAXIMISED_MODE_WIDTH - 3;
             // when the widget maximizes, it might cross the screen borders
             rect.x = rect.x + 10 - MAXIMISED_MODE_WIDTH;
-            rect.x = MAX(0, rect.x);
-            rect.y = MIN(getEngine()->getRootHeight() - rect.h, rect.y);
+            rect.x = std::max(0, rect.x);
+            rect.y = std::min(getEngine()->getRootHeight() - rect.h, rect.y);
           }
         } else if (closeButton.is(mouse_x, mouse_y)) {  // close button is pressed
           getEngine()->deactivateModule(this);
         }
       }
       break;
-    case SDL_MOUSEBUTTONUP:
+    case SDL_EVENT_MOUSE_BUTTON_UP:
       break;
     default:
       break;
diff --git a/src/umbra/log.cpp b/src/umbra/log.cpp
@@ -26,7 +26,7 @@
  */
 #include "log.hpp"
 
-#include <SDL_timer.h>
+#include <SDL3/SDL_timer.h>
 #include <fmt/printf.h>
 #include <stdarg.h>
 #include <stdio.h>
diff --git a/src/umbra/log.hpp b/src/umbra/log.hpp
@@ -61,7 +61,7 @@ class UmbraLog {
    */
   struct UmbraLogMessage {
     std::string msg;
-    uint32_t time;
+    uint64_t time;
     UmbraLogResult result;
     UmbraLogType logType;
     int indent;
diff --git a/src/umbra/module.cpp b/src/umbra/module.cpp
@@ -26,7 +26,7 @@
  */
 #include "module.hpp"
 
-#include <SDL_timer.h>
+#include <SDL3/SDL_timer.h>
 #include <libtcod/parser.h>
 
 #include <libtcod/sys.hpp>
diff --git a/src/umbra/module.hpp b/src/umbra/module.hpp
@@ -26,7 +26,7 @@
  */
 #pragma once
 
-#include <SDL_events.h>
+#include <SDL3/SDL_events.h>
 
 #include <cassert>
 #include <libtcod/libtcod.hpp>
diff --git a/src/umbra/widget.cpp b/src/umbra/widget.cpp
@@ -39,7 +39,7 @@ void UmbraWidget::onEvent(const SDL_Event& ev) {
   const int local_x = mouse_x - rect.x;
   const int local_y = mouse_y - rect.y;
   switch (ev.type) {
-    case SDL_MOUSEMOTION: {
+    case SDL_EVENT_MOUSE_MOTION: {
       const bool wasHover = rect.mouseHover;
       rect.mouseHover = rect.contains(mouse_x, mouse_y);
       if (!wasHover && rect.mouseHover) {
@@ -57,7 +57,7 @@ void UmbraWidget::onEvent(const SDL_Event& ev) {
         rect.y = std::clamp(rect.y + tcod_mouse.dcy, 0, getEngine()->getRootHeight() - rect.h);
       }
     } break;
-    case SDL_MOUSEBUTTONDOWN:
+    case SDL_EVENT_MOUSE_BUTTON_DOWN:
       if (ev.button.button == SDL_BUTTON_LEFT) {
         rect.mouseDown = rect.contains(mouse_x, mouse_y);
         minimiseButton.mouseDown = minimiseButton.is(local_x, local_y);
@@ -67,7 +67,7 @@ void UmbraWidget::onEvent(const SDL_Event& ev) {
         if (canDrag && dragZone.contains(local_x, local_y)) isDragging = true;
       }
       break;
-    case SDL_MOUSEBUTTONUP:
+    case SDL_EVENT_MOUSE_BUTTON_UP:
       if (ev.button.button == SDL_BUTTON_LEFT) {
         isDragging = false;
         rect.mouseDown = false;
diff --git a/vcpkg b/vcpkg
@@ -1 +1 @@
-Subproject commit 34f072dfcb8b9356e6ed2c74947f87390ddb2706
+Subproject commit d172727ef04337ef0021640302a9a3a91ad17414
diff --git a/vcpkg.json b/vcpkg.json
@@ -6,8 +6,10 @@
     "fmt",
     {
       "name": "libtcod",
-      "features": ["threads"]
+      "features": [
+        "threads"
+      ]
     },
-    "sdl2"
+    "sdl3"
   ]
 }

Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,8 @@ class Circle : public UmbraModule {`
`35`	`35`	`void onEvent(const SDL_Event& ev) override {`
`36`	`36`	`TCOD_mouse_t tcod_mouse{};`
`37`	`37`	`tcod::sdl2::process_event(ev, tcod_mouse);`
`38`		`- if (ev.type == SDL_MOUSEMOTION) isGreen = circle.contains(tcod_mouse.cx, tcod_mouse.cy);`
`39`		`- if (isGreen && ev.type == SDL_MOUSEBUTTONDOWN && ev.button.button == SDL_BUTTON_LEFT) {`
	`38`	`+ if (ev.type == SDL_EVENT_MOUSE_MOTION) isGreen = circle.contains(tcod_mouse.cx, tcod_mouse.cy);`
	`39`	`+ if (isGreen && ev.type == SDL_EVENT_MOUSE_BUTTON_DOWN && ev.button.button == SDL_BUTTON_LEFT) {`
`40`	`40`	`setActive(false);`
`41`	`41`	`}`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ void UmbraConfig::registerFont(const UmbraFont& new_font) {`
`161`	`161`	`}`
`162`	`162`
`163`	`163`	`bool UmbraConfig::activateFont(int shift) {`
`164`		`- int s = CLAMP(-1, 1, shift);`
	`164`	`+ int s = std::clamp(shift, -1, 1);`
`165`	`165`	`// check if there are any registered fonts`
`166`	`166`	`if (fonts.size() == 0)`
`167`	`167`	`return false; // can happen if a user uses the default terminal.png without registering any font`