Switch from sdl2 to sdl3

resolves conflicts for opendigitizer which recently switched to sdl3.

Signed-off-by: Alexander Krimm <[email protected]>

Author: wirew0rm

CMakeLists.txt

@@ -73,7 +73,7 @@ else()
       GIT_TAG v0.16)
     FetchContent_MakeAvailable(imgui implot gnuradio4 ut)
 
-    find_package(SDL2 REQUIRED)
+    find_package(SDL3 REQUIRED)
     find_package(OpenGL REQUIRED COMPONENTS OpenGL)
 
     # imgui and implot are not CMake Projects, so we have to define their
@@ -83,12 +83,12 @@ else()
       ${imgui_SOURCE_DIR}/imgui_demo.cpp
       ${imgui_SOURCE_DIR}/imgui_draw.cpp
       ${imgui_SOURCE_DIR}/backends/imgui_impl_opengl3.cpp
-      ${imgui_SOURCE_DIR}/backends/imgui_impl_sdl2.cpp
+      ${imgui_SOURCE_DIR}/backends/imgui_impl_sdl3.cpp
       ${imgui_SOURCE_DIR}/imgui_tables.cpp
       ${imgui_SOURCE_DIR}/imgui_widgets.cpp
       ${imgui_SOURCE_DIR}/imgui.cpp
       ${imgui_SOURCE_DIR}/misc/cpp/imgui_stdlib.cpp)
-    target_link_libraries(imgui PUBLIC SDL2::SDL2 OpenGL::GL)
+    target_link_libraries(imgui PUBLIC SDL3::SDL3 OpenGL::GL)
     target_compile_options(
       imgui PRIVATE -w) # imgui does lots of oldstyle casts and pointer
                         # arithmethic leading to many warnings

blocklib/timing/src/test-timing.cpp

@@ -6,16 +6,16 @@
 #include <unordered_set>
 
 // UI
-#include <SDL.h>
+#include <SDL3/SDL.h>
 #if defined(IMGUI_IMPL_OPENGL_ES2)
-#include <SDL_opengles2.h>
+#include <SDL3/SDL_opengles2.h>
 #else
-#include <SDL_opengl.h>
+#include <SDL3/SDL_opengl.h>
 #endif
 #include "ImScoped.hpp"
 #include <imgui.h>
 #include <imgui_impl_opengl3.h>
-#include <imgui_impl_sdl2.h>
+#include <imgui_impl_sdl3.h>
 #include <implot.h>
 
 #include <OutputCondition_Proxy.hpp>
@@ -687,39 +687,40 @@ class TimePlot {
 };
 
 std::pair<SDL_Window*, SDL_GLContext> openSDLWindow() {
-    if (SDL_Init(SDL_INIT_VIDEO | SDL_INIT_TIMER) != 0) {
+    if (!SDL_Init(SDL_INIT_VIDEO)) {
         return {nullptr, nullptr};
     }
     // Decide GL+GLSL versions
-#if defined(IMGUI_IMPL_OPENGL_ES2)
-    // GL ES 2.0 + GLSL 100
-    const char* glsl_version = "#version 100";
-    SDL_GL_SetAttribute(SDL_GL_CONTEXT_FLAGS, 0);
-    SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_ES);
-    SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 2);
+
+#ifdef __EMSCRIPTEN__
+    // WebGL2 via GLES 3.0 + GLSL ES 300
+    SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 3);
     SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 0);
-#elif defined(__APPLE__)
-    // GL 3.2 Core + GLSL 150
-    const char* glsl_version = "#version 150";
-    SDL_GL_SetAttribute(SDL_GL_CONTEXT_FLAGS, SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG); // Always required on Mac
+    SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_ES);
+    // glslVersionOut = "#version 300 es"; //TODO: check compatibility of this
+    const char* glsl_version = "#version 100";
+#else
+#ifdef __APPLE__
+    // macOS requires forward-compatible core context ≥ 3.2
+    SDL_GL_SetAttribute(SDL_GL_CONTEXT_FLAGS, SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG);
     SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_CORE);
     SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 3);
     SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 2);
+    const char* glsl_version = "#version 150";
 #else
-    // GL 3.0 + GLSL 130
-    const char* glsl_version = "#version 130";
     SDL_GL_SetAttribute(SDL_GL_CONTEXT_FLAGS, 0);
     SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_CORE);
     SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 3);
-    SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 0);
+    SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 3);
+    const char* glsl_version = "#version 330 core";
+#endif
 #endif
-
     // Create window with graphics context
     SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1);
     SDL_GL_SetAttribute(SDL_GL_DEPTH_SIZE, 24);
     SDL_GL_SetAttribute(SDL_GL_STENCIL_SIZE, 8);
-    auto        window_flags = static_cast<SDL_WindowFlags>(SDL_WINDOW_OPENGL | SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI);
-    SDL_Window* window       = SDL_CreateWindow("Dear ImGui SDL2+OpenGL3 example", SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED, 1280, 720, window_flags);
+    auto        window_flags = static_cast<SDL_WindowFlags>(SDL_WINDOW_OPENGL | SDL_WINDOW_RESIZABLE);
+    SDL_Window* window       = SDL_CreateWindow("Fair Timing Util", 1280, 720, window_flags);
     if (!window) {
         return {nullptr, nullptr};
     }
@@ -737,7 +738,7 @@ std::pair<SDL_Window*, SDL_GLContext> openSDLWindow() {
     // Setup Platform/Renderer backends
 
     std::print("Initilalizing SDL2 for OpenGL\n");
-    ImGui_ImplSDL2_InitForOpenGL(window, gl_context);
+    ImGui_ImplSDL3_InitForOpenGL(window, gl_context);
     std::print("Initializing OpenGL; glsl_version={}\n", glsl_version);
     if (!ImGui_ImplOpenGL3_Init(glsl_version)) {
         return {nullptr, nullptr};
@@ -749,16 +750,16 @@ std::pair<SDL_Window*, SDL_GLContext> openSDLWindow() {
 
 void processSDLEvents(SDL_Window* window, bool& done) {
     for (SDL_Event event; SDL_PollEvent(&event);) {
-        ImGui_ImplSDL2_ProcessEvent(&event);
-        if (event.type == SDL_QUIT || (event.type == SDL_WINDOWEVENT && event.window.event == SDL_WINDOWEVENT_CLOSE && event.window.windowID == SDL_GetWindowID(window))) {
+        ImGui_ImplSDL3_ProcessEvent(&event);
+        if (event.type == SDL_EVENT_QUIT || (event.type == SDL_EVENT_WINDOW_CLOSE_REQUESTED && event.window.windowID == SDL_GetWindowID(window))) {
             done = true;
         }
     }
 }
 
 void startImGuiFrame() {
     ImGui_ImplOpenGL3_NewFrame();
-    ImGui_ImplSDL2_NewFrame();
+    ImGui_ImplSDL3_NewFrame();
     ImGui::NewFrame();
 }
 
@@ -774,10 +775,10 @@ void RenderToSDL(const ImGuiIO& io, SDL_Window* window) {
 
 void shutdownSDL(SDL_Window* window, SDL_GLContext gl_context) {
     ImGui_ImplOpenGL3_Shutdown();
-    ImGui_ImplSDL2_Shutdown();
+    ImGui_ImplSDL3_Shutdown();
     ImGui::DestroyContext();
 
-    SDL_GL_DeleteContext(gl_context);
+    SDL_GL_DestroyContext(gl_context);
     SDL_DestroyWindow(window);
     SDL_Quit();
 }

docker/Dockerfile

@@ -39,7 +39,7 @@ RUN sudo apt-get update \
     && ( wget -O - https://labs.picotech.com/Release.gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/picotech.gpg ) \
     && (echo 'deb [signed-by=/usr/share/keyrings/picotech.gpg] https://labs.picotech.com/rc/picoscope7/debian/ picoscope main' | sudo tee /etc/apt/sources.list.d/picoscope.list )  \
     && sudo apt update \
-    && ( sudo apt install -y udev libusb-1.0-0-dev libps3000a libps4000a libps5000a libps6000 libps6000a libx11-dev libgl1-mesa-dev libsdl2-dev || true ) \
+    && ( sudo apt install -y udev libusb-1.0-0-dev libps3000a libps4000a libps5000a libps6000 libps6000a libx11-dev libgl1-mesa-dev libsdl3-dev || true ) \
     && sudo apt-get clean \
     && sudo rm -rf /var/lib/apt/lists/*