Upgrade to SDL3

.github/workflows/build.yml

@@ -42,7 +42,7 @@ jobs:
           - runner: ubuntu-latest
             preset: linux-cross-arm64
             cc: gcc
-            cxx: g++++
+            cxx: g++
             name: Linux-cross-arm64
         build_type:
           - Debug

.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Generate git hash and tarball
         run: |
           sudo apt update
-          sudo apt install -y ninja-build cmake g++ libsdl2-dev zlib1g-dev
+          sudo apt install -y ninja-build cmake g++ zlib1g-dev
           cmake --preset linux
           cmake --build --preset linux -t get_git_hash
           cmake --build --preset linux -t package_source

BUILD.md

@@ -2,7 +2,15 @@
 # Building Descent 3 Open Source 
 
 ## Dependencies
-The build process uses [**CMake**](https://cmake.org/) and, by default, [**Ninja**](https://ninja-build.org/). You must install these; the project cannot locate them for you. The source code depends on [**SDL2**](https://github.com/libsdl-org/SDL/tree/SDL2) and [**zlib**](https://github.com/madler/zlib). You can supply these dependencies yourself via your system's library management tools, or the build system can locate the dependencies for you using [vcpkg](https://github.com/microsoft/vcpkg), a cross-platform dependency-management system developed by Microsoft. The official builds source their dependencies from vcpkg.
+The build process uses [**CMake**](https://cmake.org/) and, by default, [**Ninja**](https://ninja-build.org/). You must install these; the project cannot locate them for you. The source code also depends on third-party libraries that are not provided as part of the repository:
+- [**SDL3**](https://wiki.libsdl.org/SDL3/FrontPage) which is used as the base to handle video, audio and input.
+- [**cpp-httplib**](https://github.com/yhirose/cpp-httplib) as a HTTP client to download levels.
+- [**glm**](https://github.com/g-truc/glm) providing useful additions to OpenGL.
+- [**plog**](https://github.com/SergiusTheBest/plog) for logging
+- [**zlib**](https://www.zlib.net/) as a compression utility
+- [**gtest**](https://github.com/google/googletest) (optional) for testing.
+
+You can supply these dependencies yourself via your system's library management tools, or the build system can locate the dependencies for you using [vcpkg](https://github.com/microsoft/vcpkg), a cross-platform dependency-management system developed by Microsoft. The official builds source their dependencies from vcpkg.
 
 ## Installing and using vcpkg
 * When building for Windows, vcpkg is already installed and configured when using any of the Visual Studio command prompts (either actual Command Prompt, or PowerShell).
@@ -132,11 +140,11 @@ Once CMake finishes, the built files will be put in `builds/mac/build/Debug` or
     * If you would like to manage the code dependencies yourself:
         * APT users
             ```sh
-            sudo apt install -y --no-install-recommends libsdl2-dev zlib1g-dev libcpp-httplib-dev libgtest-dev libglm-dev
+            sudo apt install -y --no-install-recommends libsdl3-dev zlib1g-dev libcpp-httplib-dev libgtest-dev libglm-dev
             ```
         * DNF users
             ```sh
-            sudo dnf install -y SDL2-devel zlib-devel cpp-httplib-devel gtest glm-devel
+            sudo dnf install -y SDL3-devel zlib-devel cpp-httplib-devel gtest glm-devel
             ```
 
 3. **Clone the Descent3 source code.**
@@ -195,5 +203,5 @@ cmake --preset linux -DENABLE_LOGGER=ON
 | `ENABLE_MEM_RTL`         | Enable Real-time library memory management functions (disable to verbose memory allocations).                                                                                                                                                                                                           | `ON`                                                                                         |
 | `FORCE_COLORED_OUTPUT`   | Always produce ANSI-colored compiler warnings/errors (GCC/Clang only; esp. useful with Ninja).                                                                                                                                                                                                          | `OFF`                                                                                        |
 | `FORCE_PORTABLE_INSTALL` | Install all files into local directory defined by `CMAKE_INSTALL_PREFIX`.                                                                                                                                                                                                                               | `ON`                                                                                         |
-| `USE_EXTERNAL_PLOG`      | Use system plog library.                                                                                                                                                                                                                                                                                | `OFF`                                                                                        |
+      | `OFF`                                                                                        |
 | `USE_VCPKG`              | Explicitly control whether or not to use vcpkg for dependency resolution. `ON` requires the environment variable `VCPKG_ROOT` to be set.                                                                                                                                                                | Determined by the existence of `VCPKG_ROOT` in the environment: If it exists, vcpkg is used. |

CMakeLists.txt

@@ -9,8 +9,9 @@ endif()
 set(USE_VCPKG "DEFAULT" CACHE STRING "Use vcpkg for dependency management. DEFAULT defers to existence of $VCPKG_ROOT environment variable.")
 set_property(CACHE USE_VCPKG PROPERTY STRINGS "DEFAULT" "ON" "OFF")
 
-if(USE_VCPKG)
+if(NOT USE_VCPKG STREQUAL "OFF")
   if(DEFINED ENV{VCPKG_ROOT})
+
     if (CMAKE_TOOLCHAIN_FILE)
       cmake_path(ABSOLUTE_PATH CMAKE_TOOLCHAIN_FILE NORMALIZE OUTPUT_VARIABLE VCPKG_CHAINLOAD_TOOLCHAIN_FILE)
     endif()
@@ -42,7 +43,6 @@ option(ENABLE_MEM_RTL "Enable Real-time library memory management functions (dis
 option(FATAL_GL_ERRORS "Check OpenGL calls and raise exceptions on errors." OFF)
 option(FORCE_COLORED_OUTPUT "Always produce ANSI-colored compiler warnings/errors (GCC/Clang only; esp. useful with Ninja)." OFF)
 option(FORCE_PORTABLE_INSTALL "Install all files into local directory defined by CMAKE_INSTALL_PREFIX" ON)
-option(USE_EXTERNAL_PLOG "Use system plog library instead bundled" OFF)
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   option(BUILD_EDITOR "Build internal editor" OFF)
 endif()
@@ -159,23 +159,18 @@ if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID STREQUAL "GNU"
   add_compile_options("-Wno-multichar;-Wall")
 endif()
 
+find_package(SDL3 REQUIRED CONFIG REQUIRED COMPONENTS SDL3)
 find_package(glm REQUIRED)
 find_package(httplib REQUIRED)
-find_package(SDL2 REQUIRED)
-# Some versions of the SDL2 find_package set SDL2_INCLUDE_DIR and some set a plural SDL2_INCLUDE_DIRS. Check both.
-message("SDL2 Include Dir is ${SDL2_INCLUDE_DIR} ${SDL2_INCLUDE_DIRS}")
-if(USE_EXTERNAL_PLOG)
-  find_package(plog REQUIRED)
-endif()
+find_package(ZLIB REQUIRED)
+find_package(plog REQUIRED)
 
 if(CMAKE_SYSTEM_NAME STREQUAL "Linux" OR CMAKE_SYSTEM_NAME STREQUAL "OpenBSD")
   message("Building for Linux")
   add_compile_definitions(POSIX __LINUX__ _USE_OGL_ACTIVE_TEXTURES PRIMARY_HOG=\"d3-linux.hog\")
-  set(PLATFORM_INCLUDES "lib/linux" ${SDL2_INCLUDE_DIR} ${SDL2_INCLUDE_DIRS})
 elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
   message("Building for MAC OSX")
   add_compile_definitions(POSIX MACOSX=1 _USE_OGL_ACTIVE_TEXTURES PRIMARY_HOG=\"d3-osx.hog\")
-  set(PLATFORM_INCLUDES "lib/linux" ${SDL2_INCLUDE_DIR} ${SDL2_INCLUDE_DIRS})
 elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   # Windows.h defines to avoid as many issues as possible.
   add_compile_definitions(WIN32_LEAN_AND_MEAN NOMINMAX NODRAWTEXT NOBITMAP NOMCX NOSERVICE PRIMARY_HOG=\"d3-win.hog\"
@@ -191,8 +186,6 @@ elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
 
   add_compile_definitions(WIN32 _CRT_SECURE_NO_WARNINGS _CRT_SECURE_NO_DEPRECATE _CRT_NONSTDC_NO_DEPRECATE)
 
-  set(PLATFORM_INCLUDES "lib/win/DirectX" "lib/win")
-
   set(CMAKE_FIND_LIBRARY_PREFIXES "")
   set(CMAKE_FIND_LIBRARY_SUFFIXES ".lib")
 
@@ -221,8 +214,6 @@ endif()
 add_compile_definitions($<$<CONFIG:Release>:RELEASE>)
 add_compile_definitions($<$<CONFIG:Debug>:_DEBUG>)
 
-find_package(ZLIB REQUIRED)
-
 if(ENABLE_LOGGER)
   message("Enabling Logging")
   add_compile_definitions(LOGGER)
@@ -240,7 +231,10 @@ include_directories(
   "lib"     # TODO: Remove after untying all modules
   "linux"   # -*-
   "Descent3"
-  ${PLATFORM_INCLUDES}
+  $<$<PLATFORM_ID:Windows>:
+    "lib/win/DirectX"
+    "lib/win"
+  >
 )
 
 add_subdirectory(third_party)

Descent3/CMakeLists.txt

@@ -312,7 +312,7 @@ file(GLOB_RECURSE INCS "../lib/*.h")
 
 add_executable(Descent3 WIN32 MACOSX_BUNDLE ${D3Icon} ${HEADERS} ${CPPS} ${INCS} ${MANIFEST} ${RC_FILE})
 target_link_libraries(Descent3 PRIVATE
-  SDL2::SDL2
+  SDL3::SDL3
   2dlib
   AudioEncode
   bitmap
@@ -343,7 +343,7 @@ target_link_libraries(Descent3 PRIVATE
   unzip
   vecmat
   ${PLATFORM_LIBS})
-target_include_directories(Descent3 PRIVATE ${PROJECT_BINARY_DIR}/lib)
+target_include_directories(Descent3 PRIVATE ${PROJECT_BINARY_DIR}/lib ${SDL3_INCLUDE_DIRS})
 target_link_options(Descent3 PRIVATE $<$<PLATFORM_ID:Windows>:/DEBUG:FULL>)
 set_target_properties(Descent3 PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/build")
 add_dependencies(Descent3

Descent3/config.cpp

@@ -691,10 +691,10 @@ struct video_menu {
 
     sheet->NewGroup(TXT_MONITOR, 0, 180);
     vsync = sheet->AddLongCheckBox(TXT_CFG_VSYNCENABLED, (Render_preferred_state.vsync_on != 0));
-#if !defined(POSIX)
+
     sheet->AddText("");
     sheet->AddLongButton(TXT_AUTO_GAMMA, IDV_AUTOGAMMA);
-#endif
+
     return sheet;
   };
 
@@ -736,13 +736,11 @@ struct video_menu {
 
   // process
   void process(int res) {
-#if !defined(POSIX)
     switch (res) {
     case IDV_AUTOGAMMA:
       config_gamma();
       break;
     }
-#endif
   };
 };
 

Descent3/menu.cpp

@@ -112,7 +112,7 @@
  *
  * 169   4/16/99 11:56a Matt
  * Changed directplay code to be "ifdef _WIN32" instead of "ifndef
- * __LINUX__" so it will work on the Mac.
+ * SDL_PLATFORM_LINUX" so it will work on the Mac.
  *
  * 168   4/15/99 1:40a Jeff
  * changes for linux compile

Descent3/multi_connect.cpp

@@ -96,7 +96,7 @@
  *
  * 61    4/16/99 11:56a Matt
  * Changed directplay code to be "ifdef _WIN32" instead of "ifndef
- * __LINUX__" so it will work on the Mac.
+ * SDL_PLATFORM_LINUX" so it will work on the Mac.
  *
  * 60    4/15/99 1:41a Jeff
  * changes for linux compile

Descent3/multi_dll_mgr.cpp

@@ -90,7 +90,7 @@
  *
  * 61    4/16/99 11:56a Matt
  * Changed directplay code to be "ifdef _WIN32" instead of "ifndef
- * __LINUX__" so it will work on the Mac.
+ * SDL_PLATFORM_LINUX" so it will work on the Mac.
  *
  * 60    4/16/99 12:15a Jeff
  * linux wants stdcall modifiers before parens, unlike windows

Descent3/multi_ui.cpp

@@ -100,7 +100,7 @@
  *
  * 82    4/16/99 11:56a Matt
  * Changed directplay code to be "ifdef _WIN32" instead of "ifndef
- * __LINUX__" so it will work on the Mac.
+ * SDL_PLATFORM_LINUX" so it will work on the Mac.
  *
  * 81    4/15/99 3:36p Kevin
  * Added mouselook UI stuff to the multiplayer options menu

Descent3/sdlmain.cpp

@@ -33,7 +33,7 @@
 #include <csignal>
 #endif
 
-#include <SDL.h>
+#include <SDL3/SDL.h>
 
 #include "appdatabase.h"
 #include "application.h"
@@ -175,27 +175,27 @@ class oeD3LnxDatabase final : public oeLnxAppDatabase {
   }
 };
 
-int sdlKeyFilter(const SDL_Event *event);
-int sdlMouseButtonUpFilter(const SDL_Event *event);
-int sdlMouseButtonDownFilter(const SDL_Event *event);
-int sdlMouseWheelFilter(const SDL_Event *event);
-int sdlMouseMotionFilter(const SDL_Event *event);
+bool sdlKeyFilter(const SDL_Event *event);
+bool sdlMouseButtonUpFilter(const SDL_Event *event);
+bool sdlMouseButtonDownFilter(const SDL_Event *event);
+bool sdlMouseWheelFilter(const SDL_Event *event);
+bool sdlMouseMotionFilter(const SDL_Event *event);
 
-int SDLCALL d3SDLEventFilter(void *userdata, SDL_Event *event) {
+bool SDLCALL d3SDLEventFilter(void *userdata, SDL_Event *event) {
   switch (event->type) {
-  case SDL_KEYUP:
-  case SDL_KEYDOWN:
+  case SDL_EVENT_KEY_UP:
+  case SDL_EVENT_KEY_DOWN:
     return (sdlKeyFilter(event));
-  case SDL_JOYBALLMOTION:
-  case SDL_MOUSEMOTION:
+  case SDL_EVENT_JOYSTICK_BALL_MOTION:
+  case SDL_EVENT_MOUSE_MOTION:
     return (sdlMouseMotionFilter(event));
-  case SDL_MOUSEBUTTONUP:
+  case SDL_EVENT_MOUSE_BUTTON_UP:
     return (sdlMouseButtonUpFilter(event));
-  case SDL_MOUSEBUTTONDOWN:
+  case SDL_EVENT_MOUSE_BUTTON_DOWN:
     return (sdlMouseButtonDownFilter(event));
-  case SDL_MOUSEWHEEL:
+  case SDL_EVENT_MOUSE_WHEEL:
     return (sdlMouseWheelFilter(event));
-  case SDL_QUIT:
+  case SDL_EVENT_QUIT:
     SDL_Quit();
     _exit(0);
     break;
@@ -244,7 +244,7 @@ int main(int argc, char *argv[]) {
 #endif
 
   int rc = SDL_Init(SDL_INIT_AUDIO | SDL_INIT_VIDEO);
-  if (rc != 0) {
+  if (!rc) {
     LOG_FATAL.printf("SDL: SDL_Init() failed: %d: %s!", rc, SDL_GetError());
     return (0);
   }
@@ -273,7 +273,6 @@ int main(int argc, char *argv[]) {
       flags |= APPFLAG_NOMOUSECAPTURE;
     ddio_MouseSetGrab(false);
       }
-    SDL_SetRelativeMouseMode(ddio_MouseGetGrab() ? SDL_TRUE : SDL_FALSE);
 
     if (!FindArg("-sharedmemory")) {
       flags |= APPFLAG_NOSHAREDMEMORY;

Descent3/terrainrender.cpp

@@ -2870,7 +2870,7 @@ int DrawTerrainTrianglesSoftware(int index, int bm_handle, int upper_left, int l
                           }
                   }
           #endif
-  #endif//__LINUX__
+  #endif//SDL_PLATFORM_LINUX
           */
   return 0;
 }

ddebug/CMakeLists.txt

@@ -23,13 +23,14 @@ target_include_directories(ddebug PUBLIC
   ${PROJECT_SOURCE_DIR}/ddebug
   >
   PRIVATE ${PROJECT_BINARY_DIR}/lib   # For d3_version.h
+  ${SDL3_INCLUDE_DIRS}
 )
 target_link_libraries(ddebug PRIVATE
   $<$<PLATFORM_ID:Windows>:
     mem
     misc
   >
   PUBLIC
-  SDL2::SDL2
+  SDL3::SDL3
   logger
 )

ddebug/lnxdebug.cpp

@@ -39,7 +39,7 @@
  */
 
 #include <cstdio>
-#include <SDL_assert.h>
+#include <SDL3/SDL_assert.h>
 
 #include "debug.h"
 

ddebug/pserror.h

@@ -149,7 +149,7 @@
 #ifndef PSERROR_H
 #define PSERROR_H
 
-#include <SDL_assert.h>
+#include <SDL3/SDL_assert.h>
 
 #include "debug.h"
 #include "log.h"

ddio/CMakeLists.txt

@@ -28,7 +28,7 @@ set(CPPS
 )
 add_library(ddio STATIC ${HEADERS} ${CPPS})
 target_link_libraries(ddio PRIVATE
-  SDL2::SDL2
+  SDL3::SDL3
   ddebug
   logger
   mem
@@ -37,6 +37,7 @@ target_include_directories(ddio PUBLIC
   $<BUILD_INTERFACE:
   ${PROJECT_SOURCE_DIR}/ddio
   >
+  ${SDL3_INCLUDE_DIRS}
 )
 
 if(BUILD_TESTING)