/
dieoska
/
ddnet
Обзор
Документация
Войти
/
dieoska
/
ddnet
Код
Запросы
0
Задачи
Вики
Пакеты
0
Релизы
0
CI/CD
Аналитика
Безопасность
master
src/engine/client/backend_sdl.cpp
1 797 строк
51 KB
Robert Müller
Fix debug assertion crash of headless client
01 дек 2025, 23:48
01 дек 2025, 23:48
91f2e0d
Код
Авторство
О чём код?
#include <base/detect.h> #ifndef CONF_BACKEND_OPENGL_ES #include <GL/glew.h> #endif #include <base/log.h> #include <base/math.h> #include <base/tl/threading.h> #include <engine/shared/config.h> #include <engine/shared/localization.h> #include <SDL.h> #include <SDL_messagebox.h> #include <SDL_vulkan.h> #if defined(CONF_VIDEORECORDER) #include <engine/shared/video.h> #endif #include "backend_sdl.h" #if defined(CONF_HEADLESS_CLIENT) #include "backend/null/backend_null.h" #endif #if !defined(CONF_BACKEND_OPENGL_ES) #include "backend/opengl/backend_opengl3.h" #endif #if defined(CONF_BACKEND_OPENGL_ES3) || defined(CONF_BACKEND_OPENGL_ES) #include "backend/opengles/backend_opengles3.h" #endif #if defined(CONF_BACKEND_VULKAN) #include "backend/vulkan/backend_vulkan.h" #endif #include "graphics_threaded.h" #include <engine/graphics.h> #include <algorithm> #include <cstdlib> class IStorage; // ------------ CGraphicsBackend_Threaded // Run everything single threaded when compiling for Emscripten, as context binding does not work outside of the main thread with SDL2. // TODO SDL3: Check if SDL3 supports threaded graphics and PROXY_TO_PTHREAD, OFFSCREENCANVAS_SUPPORT and OFFSCREEN_FRAMEBUFFER correctly. #if !defined(CONF_PLATFORM_EMSCRIPTEN) void CGraphicsBackend_Threaded::ThreadFunc(void *pUser) { auto *pSelf = (CGraphicsBackend_Threaded *)pUser; std::unique_lock<std::mutex> Lock(pSelf->m_BufferSwapMutex); // notify, that the thread started pSelf->m_Started = true; pSelf->m_BufferSwapCond.notify_all(); while(!pSelf->m_Shutdown) { pSelf->m_BufferSwapCond.wait(Lock, [&pSelf] { return pSelf->m_pBuffer != nullptr || pSelf->m_Shutdown; }); if(pSelf->m_pBuffer) { #ifdef CONF_PLATFORM_MACOS CAutoreleasePool AutoreleasePool; #endif pSelf->m_pProcessor->RunBuffer(pSelf->m_pBuffer); pSelf->m_pBuffer = nullptr; pSelf->m_BufferInProcess.store(false, std::memory_order_relaxed); pSelf->m_BufferSwapCond.notify_all(); #if defined(CONF_VIDEORECORDER) if(IVideo::Current()) IVideo::Current()->NextVideoFrameThread(); #endif } } } #endif CGraphicsBackend_Threaded::CGraphicsBackend_Threaded(TTranslateFunc &&TranslateFunc) : m_TranslateFunc(std::move(TranslateFunc)) { m_pProcessor = nullptr; m_Shutdown = true; #if !defined(CONF_PLATFORM_EMSCRIPTEN) m_pBuffer = nullptr; m_BufferInProcess.store(false, std::memory_order_relaxed); #endif } void CGraphicsBackend_Threaded::StartProcessor(ICommandProcessor *pProcessor) { dbg_assert(m_Shutdown, "Processor was already not shut down."); m_Shutdown = false; m_pProcessor = pProcessor; #if !defined(CONF_PLATFORM_EMSCRIPTEN) std::unique_lock<std::mutex> Lock(m_BufferSwapMutex); m_pThread = thread_init(ThreadFunc, this, "Graphics thread"); // wait for the thread to start m_BufferSwapCond.wait(Lock, [this]() -> bool { return m_Started; }); #endif } void CGraphicsBackend_Threaded::StopProcessor() { dbg_assert(!m_Shutdown, "Processor was already shut down."); m_Shutdown = true; #if defined(CONF_PLATFORM_EMSCRIPTEN) m_Warning = m_pProcessor->GetWarning(); #else { std::unique_lock<std::mutex> Lock(m_BufferSwapMutex); m_Warning = m_pProcessor->GetWarning(); m_BufferSwapCond.notify_all(); } thread_wait(m_pThread); #endif } void CGraphicsBackend_Threaded::RunBuffer(CCommandBuffer *pBuffer) { SGfxErrorContainer Error; #if defined(CONF_PLATFORM_EMSCRIPTEN) Error = m_pProcessor->GetError(); if(Error.m_ErrorType == GFX_ERROR_TYPE_NONE) { RunBufferSingleThreadedUnsafe(pBuffer); #if defined(CONF_VIDEORECORDER) if(IVideo::Current()) IVideo::Current()->NextVideoFrameThread(); #endif } #else WaitForIdle(); { std::unique_lock<std::mutex> Lock(m_BufferSwapMutex); Error = m_pProcessor->GetError(); if(Error.m_ErrorType == GFX_ERROR_TYPE_NONE) { m_pBuffer = pBuffer; m_BufferInProcess.store(true, std::memory_order_relaxed); m_BufferSwapCond.notify_all(); } } #endif // Process error after lock is released to prevent deadlock if(Error.m_ErrorType != GFX_ERROR_TYPE_NONE) { ProcessError(Error); } } void CGraphicsBackend_Threaded::RunBufferSingleThreadedUnsafe(CCommandBuffer *pBuffer) { m_pProcessor->RunBuffer(pBuffer); } bool CGraphicsBackend_Threaded::IsIdle() const { #if defined(CONF_PLATFORM_EMSCRIPTEN) return true; #else return !m_BufferInProcess.load(std::memory_order_relaxed); #endif } void CGraphicsBackend_Threaded::WaitForIdle() { #if !defined(CONF_PLATFORM_EMSCRIPTEN) std::unique_lock<std::mutex> Lock(m_BufferSwapMutex); m_BufferSwapCond.wait(Lock, [this]() { return m_pBuffer == nullptr; }); #endif } void CGraphicsBackend_Threaded::ProcessError(const SGfxErrorContainer &Error) { std::string VerboseStr = "Graphics Assertion:"; for(const auto &ErrStr : Error.m_vErrors) { VerboseStr.append("\n"); if(ErrStr.m_RequiresTranslation) VerboseStr.append(m_TranslateFunc(ErrStr.m_Err.c_str(), "")); else VerboseStr.append(ErrStr.m_Err); } dbg_assert_failed("%s", VerboseStr.c_str()); } bool CGraphicsBackend_Threaded::GetWarning(std::vector<std::string> &WarningStrings) { if(m_Warning.m_WarningType != GFX_WARNING_TYPE_NONE) { m_Warning.m_WarningType = GFX_WARNING_TYPE_NONE; WarningStrings = m_Warning.m_vWarnings; return true; } return false; } // ------------ CCommandProcessorFragment_General void CCommandProcessorFragment_General::Cmd_Signal(const CCommandBuffer::SCommand_Signal *pCommand) { pCommand->m_pSemaphore->Signal(); } bool CCommandProcessorFragment_General::RunCommand(const CCommandBuffer::SCommand *pBaseCommand) { switch(pBaseCommand->m_Cmd) { case CCommandBuffer::CMD_SIGNAL: Cmd_Signal(static_cast<const CCommandBuffer::SCommand_Signal *>(pBaseCommand)); break; default: return false; } return true; } // ------------ CCommandProcessorFragment_SDL void CCommandProcessorFragment_SDL::Cmd_Init(const SCommand_Init *pCommand) { m_GLContext = pCommand->m_GLContext; m_pWindow = pCommand->m_pWindow; if(m_GLContext) SDL_GL_MakeCurrent(m_pWindow, m_GLContext); } void CCommandProcessorFragment_SDL::Cmd_Shutdown(const SCommand_Shutdown *pCommand) { if(m_GLContext) SDL_GL_MakeCurrent(nullptr, nullptr); } void CCommandProcessorFragment_SDL::Cmd_Swap(const CCommandBuffer::SCommand_Swap *pCommand) { if(m_GLContext) SDL_GL_SwapWindow(m_pWindow); } void CCommandProcessorFragment_SDL::Cmd_VSync(const CCommandBuffer::SCommand_VSync *pCommand) { if(m_GLContext) { #if defined(CONF_PLATFORM_EMSCRIPTEN) // SDL_GL_SetSwapInterval is not supported with Emscripten as this is only a wrapper for the // emscripten_set_main_loop_timing function which does not work because we do not use the // emscripten_set_main_loop function before. *pCommand->m_pRetOk = !pCommand->m_VSync; #else *pCommand->m_pRetOk = SDL_GL_SetSwapInterval(pCommand->m_VSync) == 0; #endif } } void CCommandProcessorFragment_SDL::Cmd_WindowCreateNtf(const CCommandBuffer::SCommand_WindowCreateNtf *pCommand) { m_pWindow = SDL_GetWindowFromID(pCommand->m_WindowId); // Android destroys windows when they are not visible, so we get the new one and work with that // The graphic context does not need to be recreated, just unbound see @see SCommand_WindowDestroyNtf #ifdef CONF_PLATFORM_ANDROID if(m_GLContext) SDL_GL_MakeCurrent(m_pWindow, m_GLContext); #endif } void CCommandProcessorFragment_SDL::Cmd_WindowDestroyNtf(const CCommandBuffer::SCommand_WindowDestroyNtf *pCommand) { // Unbind the graphic context from the window, so it does not get destroyed #ifdef CONF_PLATFORM_ANDROID if(m_GLContext) SDL_GL_MakeCurrent(NULL, NULL); #endif } CCommandProcessorFragment_SDL::CCommandProcessorFragment_SDL() = default; bool CCommandProcessorFragment_SDL::RunCommand(const CCommandBuffer::SCommand *pBaseCommand) { switch(pBaseCommand->m_Cmd) { case CCommandBuffer::CMD_WINDOW_CREATE_NTF: Cmd_WindowCreateNtf(static_cast<const CCommandBuffer::SCommand_WindowCreateNtf *>(pBaseCommand)); break; case CCommandBuffer::CMD_WINDOW_DESTROY_NTF: Cmd_WindowDestroyNtf(static_cast<const CCommandBuffer::SCommand_WindowDestroyNtf *>(pBaseCommand)); break; case CCommandBuffer::CMD_SWAP: Cmd_Swap(static_cast<const CCommandBuffer::SCommand_Swap *>(pBaseCommand)); break; case CCommandBuffer::CMD_VSYNC: Cmd_VSync(static_cast<const CCommandBuffer::SCommand_VSync *>(pBaseCommand)); break; case CCommandBuffer::CMD_MULTISAMPLING: break; case CMD_INIT: Cmd_Init(static_cast<const SCommand_Init *>(pBaseCommand)); break; case CMD_SHUTDOWN: Cmd_Shutdown(static_cast<const SCommand_Shutdown *>(pBaseCommand)); break; case CCommandProcessorFragment_GLBase::CMD_PRE_INIT: break; case CCommandProcessorFragment_GLBase::CMD_POST_SHUTDOWN: break; default: return false; } return true; } // ------------ CCommandProcessor_SDL_GL void CCommandProcessor_SDL_GL::HandleError() { switch(m_Error.m_ErrorType) { case GFX_ERROR_TYPE_INIT: m_Error.m_vErrors.emplace_back(SGfxErrorContainer::SError{true, Localizable("Failed during initialization. Try to change gfx_backend to OpenGL or Vulkan in settings_ddnet.cfg in the config directory and try again.", "Graphics error")}); break; case GFX_ERROR_TYPE_OUT_OF_MEMORY_IMAGE: [[fallthrough]]; case GFX_ERROR_TYPE_OUT_OF_MEMORY_BUFFER: [[fallthrough]]; case GFX_ERROR_TYPE_OUT_OF_MEMORY_STAGING: m_Error.m_vErrors.emplace_back(SGfxErrorContainer::SError{true, Localizable("Out of VRAM. Try setting 'cl_skins_loaded_max' to a lower value or remove custom assets (skins, entities, etc.), especially those with high resolution.", "Graphics error")}); break; case GFX_ERROR_TYPE_RENDER_RECORDING: m_Error.m_vErrors.emplace_back(SGfxErrorContainer::SError{true, Localizable("An error during command recording occurred. Try to update your GPU drivers.", "Graphics error")}); break; case GFX_ERROR_TYPE_RENDER_CMD_FAILED: m_Error.m_vErrors.emplace_back(SGfxErrorContainer::SError{true, Localizable("A render command failed. Try to update your GPU drivers.", "Graphics error")}); break; case GFX_ERROR_TYPE_RENDER_SUBMIT_FAILED: m_Error.m_vErrors.emplace_back(SGfxErrorContainer::SError{true, Localizable("Submitting the render commands failed. Try to update your GPU drivers.", "Graphics error")}); break; case GFX_ERROR_TYPE_SWAP_FAILED: m_Error.m_vErrors.emplace_back(SGfxErrorContainer::SError{true, Localizable("Failed to swap framebuffers. Try to update your GPU drivers.", "Graphics error")}); break; case GFX_ERROR_TYPE_UNKNOWN: [[fallthrough]]; default: m_Error.m_vErrors.emplace_back(SGfxErrorContainer::SError{true, Localizable("Unknown error. Try to change gfx_backend to OpenGL or Vulkan in settings_ddnet.cfg in the config directory and try again.", "Graphics error")}); break; } } void CCommandProcessor_SDL_GL::HandleWarning() { switch(m_Warning.m_WarningType) { case GFX_WARNING_TYPE_INIT_FAILED: m_Warning.m_vWarnings.emplace_back(Localizable("Could not initialize the given graphics backend, reverting to the default backend now.", "Graphics error")); break; case GFX_WARNING_TYPE_INIT_FAILED_MISSING_INTEGRATED_GPU_DRIVER: m_Warning.m_vWarnings.emplace_back(Localizable("Could not initialize the given graphics backend, this is probably because you didn't install the driver of the integrated graphics card.", "Graphics error")); break; case GFX_WARNING_MISSING_EXTENSION: // ignore this warning for now return; case GFX_WARNING_LOW_ON_MEMORY: // ignore this warning for now return; case GFX_WARNING_TYPE_INIT_FAILED_NO_DEVICE_WITH_REQUIRED_VERSION: { // Ignore this warning for now completely. // A console message was already printed by the backend m_Warning.m_WarningType = GFX_WARNING_TYPE_NONE; m_Warning.m_vWarnings.clear(); return; } default: dbg_assert_failed("Unhandled graphics warning type %d", (int)m_Warning.m_WarningType); } } void CCommandProcessor_SDL_GL::RunBuffer(CCommandBuffer *pBuffer) { m_pGLBackend->StartCommands(pBuffer->m_CommandCount, pBuffer->m_RenderCallCount); for(const CCommandBuffer::SCommand *pCommand = pBuffer->Head(); pCommand; pCommand = pCommand->m_pNext) { auto Res = m_pGLBackend->RunCommand(pCommand); if(Res == ERunCommandReturnTypes::RUN_COMMAND_COMMAND_HANDLED) { continue; } else if(Res == ERunCommandReturnTypes::RUN_COMMAND_COMMAND_ERROR) { m_Error = m_pGLBackend->GetError(); HandleError(); return; } else if(Res == ERunCommandReturnTypes::RUN_COMMAND_COMMAND_WARNING) { m_Warning = m_pGLBackend->GetWarning(); HandleWarning(); return; } if(m_SDL.RunCommand(pCommand)) continue; if(m_General.RunCommand(pCommand)) continue; dbg_assert_failed("Unknown graphics command %d", pCommand->m_Cmd); } m_pGLBackend->EndCommands(); } CCommandProcessor_SDL_GL::CCommandProcessor_SDL_GL(EBackendType BackendType, int GLMajor, int GLMinor, int GLPatch) { m_BackendType = BackendType; #if defined(CONF_HEADLESS_CLIENT) m_pGLBackend = new CCommandProcessorFragment_Null(); #else if(BackendType == BACKEND_TYPE_OPENGL_ES) { #if defined(CONF_BACKEND_OPENGL_ES) || defined(CONF_BACKEND_OPENGL_ES3) if(GLMajor < 3) { m_pGLBackend = new CCommandProcessorFragment_OpenGLES(); } else { m_pGLBackend = new CCommandProcessorFragment_OpenGLES3(); } #endif } else if(BackendType == BACKEND_TYPE_OPENGL) { #if !defined(CONF_BACKEND_OPENGL_ES) if(GLMajor < 2) { m_pGLBackend = new CCommandProcessorFragment_OpenGL(); } if(GLMajor == 2) { m_pGLBackend = new CCommandProcessorFragment_OpenGL2(); } if(GLMajor == 3 && GLMinor == 0) { m_pGLBackend = new CCommandProcessorFragment_OpenGL3(); } else if((GLMajor == 3 && GLMinor == 3) || GLMajor >= 4) { m_pGLBackend = new CCommandProcessorFragment_OpenGL3_3(); } #endif } else if(BackendType == BACKEND_TYPE_VULKAN) { #if defined(CONF_BACKEND_VULKAN) m_pGLBackend = CreateVulkanCommandProcessorFragment(); #endif } #endif } CCommandProcessor_SDL_GL::~CCommandProcessor_SDL_GL() { delete m_pGLBackend; } const SGfxErrorContainer &CCommandProcessor_SDL_GL::GetError() const { return m_Error; } void CCommandProcessor_SDL_GL::ErroneousCleanup() { m_pGLBackend->ErroneousCleanup(); } const SGfxWarningContainer &CCommandProcessor_SDL_GL::GetWarning() const { return m_Warning; } // ------------ CGraphicsBackend_SDL_GL #if !defined(CONF_HEADLESS_CLIENT) static bool BackendInitGlew(EBackendType BackendType, int &GlewMajor, int &GlewMinor, int &GlewPatch) { if(BackendType == BACKEND_TYPE_OPENGL) { #if !defined(CONF_BACKEND_OPENGL_ES) // Support graphic cards that are pretty old (and Linux) glewExperimental = GL_TRUE; #ifdef CONF_GLEW_HAS_CONTEXT_INIT const GLenum InitResult = glewContextInit(); if(InitResult != GLEW_OK) { log_error("gfx", "Unable to init glew (glewContextInit): %s", glewGetErrorString(InitResult)); return false; } #else const GLenum InitResult = glewInit(); if(InitResult != GLEW_OK) { // With wayland the glewInit function is allowed to fail with GLEW_ERROR_NO_GLX_DISPLAY, // as it will already have initialized the context with glewContextInit internally. const char *pVideoDriver = SDL_GetCurrentVideoDriver(); if(pVideoDriver == nullptr || str_comp(pVideoDriver, "wayland") != 0 || InitResult != GLEW_ERROR_NO_GLX_DISPLAY) { log_error("gfx", "Unable to init glew (glewInit): %s", glewGetErrorString(InitResult)); return false; } } #endif #ifdef GLEW_VERSION_4_6 if(GLEW_VERSION_4_6) { GlewMajor = 4; GlewMinor = 6; GlewPatch = 0; return true; } #endif #ifdef GLEW_VERSION_4_5 if(GLEW_VERSION_4_5) { GlewMajor = 4; GlewMinor = 5; GlewPatch = 0; return true; } #endif // Don't allow GL 3.3, if the driver doesn't support at least OpenGL 4.5 #ifndef CONF_FAMILY_WINDOWS if(GLEW_VERSION_4_4) { GlewMajor = 4; GlewMinor = 4; GlewPatch = 0; return true; } if(GLEW_VERSION_4_3) { GlewMajor = 4; GlewMinor = 3; GlewPatch = 0; return true; } if(GLEW_VERSION_4_2) { GlewMajor = 4; GlewMinor = 2; GlewPatch = 0; return true; } if(GLEW_VERSION_4_1) { GlewMajor = 4; GlewMinor = 1; GlewPatch = 0; return true; } if(GLEW_VERSION_4_0) { GlewMajor = 4; GlewMinor = 0; GlewPatch = 0; return true; } if(GLEW_VERSION_3_3) { GlewMajor = 3; GlewMinor = 3; GlewPatch = 0; return true; } #endif if(GLEW_VERSION_3_0) { GlewMajor = 3; GlewMinor = 0; GlewPatch = 0; return true; } if(GLEW_VERSION_2_1) { GlewMajor = 2; GlewMinor = 1; GlewPatch = 0; return true; } if(GLEW_VERSION_2_0) { GlewMajor = 2; GlewMinor = 0; GlewPatch = 0; return true; } if(GLEW_VERSION_1_5) { GlewMajor = 1; GlewMinor = 5; GlewPatch = 0; return true; } if(GLEW_VERSION_1_4) { GlewMajor = 1; GlewMinor = 4; GlewPatch = 0; return true; } if(GLEW_VERSION_1_3) { GlewMajor = 1; GlewMinor = 3; GlewPatch = 0; return true; } if(GLEW_VERSION_1_2_1) { GlewMajor = 1; GlewMinor = 2; GlewPatch = 1; return true; } if(GLEW_VERSION_1_2) { GlewMajor = 1; GlewMinor = 2; GlewPatch = 0; return true; } if(GLEW_VERSION_1_1) { GlewMajor = 1; GlewMinor = 1; GlewPatch = 0; return true; } #endif } else if(BackendType == BACKEND_TYPE_OPENGL_ES) { // just assume the version we need GlewMajor = 3; GlewMinor = 0; GlewPatch = 0; return true; } else { dbg_assert_failed("Invalid backend type for glew: %d", (int)BackendType); } return false; } static int IsVersionSupportedGlew(EBackendType BackendType, int VersionMajor, int VersionMinor, int VersionPatch, int GlewMajor, int GlewMinor, int GlewPatch) { if(BackendType == BACKEND_TYPE_OPENGL) { if(VersionMajor >= 4 && GlewMajor < 4) { return -1; } else if(VersionMajor >= 3 && GlewMajor < 3) { return -1; } else if(VersionMajor == 3 && GlewMajor == 3) { if(VersionMinor >= 3 && GlewMinor < 3) { return -1; } if(VersionMinor >= 2 && GlewMinor < 2) { return -1; } if(VersionMinor >= 1 && GlewMinor < 1) { return -1; } if(VersionMinor >= 0 && GlewMinor < 0) { return -1; } } else if(VersionMajor >= 2 && GlewMajor < 2) { return -1; } else if(VersionMajor == 2 && GlewMajor == 2) { if(VersionMinor >= 1 && GlewMinor < 1) { return -1; } if(VersionMinor >= 0 && GlewMinor < 0) { return -1; } } else if(VersionMajor >= 1 && GlewMajor < 1) { return -1; } else if(VersionMajor == 1 && GlewMajor == 1) { if(VersionMinor >= 5 && GlewMinor < 5) { return -1; } if(VersionMinor >= 4 && GlewMinor < 4) { return -1; } if(VersionMinor >= 3 && GlewMinor < 3) { return -1; } if(VersionMinor >= 2 && GlewMinor < 2) { return -1; } else if(VersionMinor == 2 && GlewMinor == 2) { if(VersionPatch >= 1 && GlewPatch < 1) { return -1; } if(VersionPatch >= 0 && GlewPatch < 0) { return -1; } } if(VersionMinor >= 1 && GlewMinor < 1) { return -1; } if(VersionMinor >= 0 && GlewMinor < 0) { return -1; } } } return 0; } #endif // !CONF_HEADLESS_CLIENT EBackendType CGraphicsBackend_SDL_GL::DetectBackend() { EBackendType RetBackendType = BACKEND_TYPE_OPENGL; #if defined(CONF_BACKEND_VULKAN) const char *pEnvDriver = SDL_getenv("DDNET_DRIVER"); if(pEnvDriver && str_comp_nocase(pEnvDriver, "GLES") == 0) RetBackendType = BACKEND_TYPE_OPENGL_ES; else if(pEnvDriver && str_comp_nocase(pEnvDriver, "Vulkan") == 0) RetBackendType = BACKEND_TYPE_VULKAN; else if(pEnvDriver && str_comp_nocase(pEnvDriver, "OpenGL") == 0) RetBackendType = BACKEND_TYPE_OPENGL; else if(pEnvDriver == nullptr) { // load the config backend const char *pConfBackend = g_Config.m_GfxBackend; if(str_comp_nocase(pConfBackend, "GLES") == 0) RetBackendType = BACKEND_TYPE_OPENGL_ES; else if(str_comp_nocase(pConfBackend, "Vulkan") == 0) RetBackendType = BACKEND_TYPE_VULKAN; else if(str_comp_nocase(pConfBackend, "OpenGL") == 0) RetBackendType = BACKEND_TYPE_OPENGL; } #else RetBackendType = BACKEND_TYPE_OPENGL; #endif #if !defined(CONF_BACKEND_OPENGL_ES) && !defined(CONF_BACKEND_OPENGL_ES3) if(RetBackendType == BACKEND_TYPE_OPENGL_ES) RetBackendType = BACKEND_TYPE_OPENGL; #elif defined(CONF_BACKEND_OPENGL_ES) if(RetBackendType == BACKEND_TYPE_OPENGL) RetBackendType = BACKEND_TYPE_OPENGL_ES; #endif return RetBackendType; } void CGraphicsBackend_SDL_GL::ClampDriverVersion(EBackendType BackendType) { if(BackendType == BACKEND_TYPE_OPENGL) { // clamp the versions to existing versions(only for OpenGL major <= 3) if(g_Config.m_GfxGLMajor == 1) { g_Config.m_GfxGLMinor = std::clamp(g_Config.m_GfxGLMinor, 1, 5); if(g_Config.m_GfxGLMinor == 2) g_Config.m_GfxGLPatch = std::clamp(g_Config.m_GfxGLPatch, 0, 1); else g_Config.m_GfxGLPatch = 0; } else if(g_Config.m_GfxGLMajor == 2) { g_Config.m_GfxGLMinor = std::clamp(g_Config.m_GfxGLMinor, 0, 1); g_Config.m_GfxGLPatch = 0; } else if(g_Config.m_GfxGLMajor == 3) { g_Config.m_GfxGLMinor = std::clamp(g_Config.m_GfxGLMinor, 0, 3); if(g_Config.m_GfxGLMinor < 3) g_Config.m_GfxGLMinor = 0; g_Config.m_GfxGLPatch = 0; } } else if(BackendType == BACKEND_TYPE_OPENGL_ES) { #if !defined(CONF_BACKEND_OPENGL_ES3) // Make sure GLES is set to 1.0 (which is equivalent to OpenGL 1.3), if its not set to >= 3.0(which is equivalent to OpenGL 3.3) if(g_Config.m_GfxGLMajor < 3) { g_Config.m_GfxGLMajor = 1; g_Config.m_GfxGLMinor = 0; g_Config.m_GfxGLPatch = 0; // GLES also doesn't know GL_QUAD g_Config.m_GfxQuadAsTriangle = 1; } #else g_Config.m_GfxGLMajor = 3; g_Config.m_GfxGLMinor = 0; g_Config.m_GfxGLPatch = 0; #endif } else if(BackendType == BACKEND_TYPE_VULKAN) { #if defined(CONF_BACKEND_VULKAN) g_Config.m_GfxGLMajor = gs_BackendVulkanMajor; g_Config.m_GfxGLMinor = gs_BackendVulkanMinor; g_Config.m_GfxGLPatch = 0; #endif } } static Uint32 MessageBoxTypeToSdlFlags(IGraphics::EMessageBoxType Type) { switch(Type) { case IGraphics::EMessageBoxType::ERROR: return SDL_MESSAGEBOX_ERROR; case IGraphics::EMessageBoxType::WARNING: return SDL_MESSAGEBOX_WARNING; case IGraphics::EMessageBoxType::INFO: return SDL_MESSAGEBOX_INFORMATION; default: dbg_assert_failed("Type invalid"); } } static std::optional<int> ShowMessageBoxImpl(const IGraphics::CMessageBox &MessageBox, SDL_Window *pWindow) { dbg_assert(!MessageBox.m_vButtons.empty(), "At least one button is required"); std::vector<SDL_MessageBoxButtonData> vButtonData; vButtonData.reserve(MessageBox.m_vButtons.size()); for(const auto &Button : MessageBox.m_vButtons) { SDL_MessageBoxButtonData ButtonData{}; ButtonData.buttonid = vButtonData.size(); ButtonData.flags = (Button.m_Confirm ? SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT : 0) | (Button.m_Cancel ? SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT : 0); ButtonData.text = Button.m_pLabel; vButtonData.emplace_back(ButtonData); } #if defined(CONF_FAMILY_WINDOWS) // TODO SDL3: The order of buttons is not defined by default, but the flags returned by MessageBoxTypeToSdlFlags do not work together // with SDL_MESSAGEBOX_BUTTONS_LEFT_TO_RIGHT with SDL2 on various platforms. Windows appears to be the only platform that // lays out buttons from right to left by default, so we reverse the order manually. std::reverse(vButtonData.begin(), vButtonData.end()); #endif SDL_MessageBoxData MessageBoxData{}; MessageBoxData.title = MessageBox.m_pTitle; MessageBoxData.message = MessageBox.m_pMessage; MessageBoxData.flags = MessageBoxTypeToSdlFlags(MessageBox.m_Type); MessageBoxData.numbuttons = vButtonData.size(); MessageBoxData.buttons = vButtonData.data(); MessageBoxData.window = pWindow; int ButtonId = -1; if(SDL_ShowMessageBox(&MessageBoxData, &ButtonId) != 0) { return std::nullopt; } return ButtonId; } std::optional<int> ShowMessageBoxWithoutGraphics(const IGraphics::CMessageBox &MessageBox) { return ShowMessageBoxImpl(MessageBox, nullptr); } std::optional<int> CGraphicsBackend_SDL_GL::ShowMessageBox(const IGraphics::CMessageBox &MessageBox) { if(m_pProcessor != nullptr) { m_pProcessor->ErroneousCleanup(); } // TODO: Remove this workaround when https://github.com/libsdl-org/SDL/issues/3750 is // fixed and pass the window to SDL_ShowSimpleMessageBox to make the popup modal instead // of destroying the window before opening the popup. if(m_pWindow != nullptr) { SDL_DestroyWindow(m_pWindow); m_pWindow = nullptr; } return ShowMessageBoxImpl(MessageBox, m_pWindow); } bool CGraphicsBackend_SDL_GL::IsModernAPI(EBackendType BackendType) { if(BackendType == BACKEND_TYPE_OPENGL) return (g_Config.m_GfxGLMajor == 3 && g_Config.m_GfxGLMinor == 3) || g_Config.m_GfxGLMajor >= 4; else if(BackendType == BACKEND_TYPE_OPENGL_ES) return g_Config.m_GfxGLMajor >= 3; else if(BackendType == BACKEND_TYPE_VULKAN) return true; return false; } bool CGraphicsBackend_SDL_GL::GetDriverVersion(EGraphicsDriverAgeType DriverAgeType, int &Major, int &Minor, int &Patch, const char *&pName, EBackendType BackendType) { if(BackendType == BACKEND_TYPE_AUTO) BackendType = m_BackendType; if(BackendType == BACKEND_TYPE_OPENGL) { pName = "OpenGL"; #ifndef CONF_BACKEND_OPENGL_ES if(DriverAgeType == GRAPHICS_DRIVER_AGE_TYPE_LEGACY) { Major = 1; Minor = 4; Patch = 0; return true; } else if(DriverAgeType == GRAPHICS_DRIVER_AGE_TYPE_DEFAULT) { Major = 3; Minor = 0; Patch = 0; return true; } else if(DriverAgeType == GRAPHICS_DRIVER_AGE_TYPE_MODERN) { Major = 3; Minor = 3; Patch = 0; return true; } #endif } else if(BackendType == BACKEND_TYPE_OPENGL_ES) { pName = "GLES"; #ifdef CONF_BACKEND_OPENGL_ES if(DriverAgeType == GRAPHICS_DRIVER_AGE_TYPE_LEGACY) { Major = 1; Minor = 0; Patch = 0; return true; } else if(DriverAgeType == GRAPHICS_DRIVER_AGE_TYPE_DEFAULT) { Major = 3; Minor = 0; Patch = 0; // there isn't really a default one return false; } #endif #ifdef CONF_BACKEND_OPENGL_ES3 if(DriverAgeType == GRAPHICS_DRIVER_AGE_TYPE_MODERN) { Major = 3; Minor = 0; Patch = 0; return true; } #endif } else if(BackendType == BACKEND_TYPE_VULKAN) { pName = "Vulkan"; #ifdef CONF_BACKEND_VULKAN if(DriverAgeType == GRAPHICS_DRIVER_AGE_TYPE_DEFAULT) { Major = gs_BackendVulkanMajor; Minor = gs_BackendVulkanMinor; Patch = 0; return true; } #else return false; #endif } return false; } const char *CGraphicsBackend_SDL_GL::GetScreenName(int Screen) const { const char *pName = SDL_GetDisplayName(Screen); return pName == nullptr ? "unknown/error" : pName; } static void DisplayToVideoMode(CVideoMode *pVMode, SDL_DisplayMode *pMode, float HiDPIScale, int RefreshRate) { pVMode->m_CanvasWidth = pMode->w * HiDPIScale; pVMode->m_CanvasHeight = pMode->h * HiDPIScale; pVMode->m_WindowWidth = pMode->w; pVMode->m_WindowHeight = pMode->h; pVMode->m_RefreshRate = RefreshRate; pVMode->m_Red = SDL_BITSPERPIXEL(pMode->format); pVMode->m_Green = SDL_BITSPERPIXEL(pMode->format); pVMode->m_Blue = SDL_BITSPERPIXEL(pMode->format); pVMode->m_Format = pMode->format; } void CGraphicsBackend_SDL_GL::GetVideoModes(CVideoMode *pModes, int MaxModes, int *pNumModes, float HiDPIScale, int MaxWindowWidth, int MaxWindowHeight, int ScreenId) { SDL_DisplayMode DesktopMode; int MaxModesAvailable = SDL_GetNumDisplayModes(ScreenId); // Only collect fullscreen modes when requested, that makes sure in windowed mode no refresh rates are shown that aren't supported without // fullscreen anyway(except fullscreen desktop) bool IsFullscreenDesktop = m_pWindow != nullptr && (((SDL_GetWindowFlags(m_pWindow) & SDL_WINDOW_FULLSCREEN_DESKTOP) == SDL_WINDOW_FULLSCREEN_DESKTOP) || g_Config.m_GfxFullscreen == 3); bool CollectFullscreenModes = m_pWindow == nullptr || ((SDL_GetWindowFlags(m_pWindow) & SDL_WINDOW_FULLSCREEN) != 0 && !IsFullscreenDesktop); if(SDL_GetDesktopDisplayMode(ScreenId, &DesktopMode) < 0) { log_error("gfx", "Unable to get desktop display mode of screen %d: %s", ScreenId, SDL_GetError()); } constexpr int ModeCount = 256; SDL_DisplayMode aModes[ModeCount]; int NumModes = 0; for(int i = 0; i < MaxModesAvailable && NumModes < ModeCount; i++) { SDL_DisplayMode Mode; if(SDL_GetDisplayMode(ScreenId, i, &Mode) < 0) { log_error("gfx", "Unable to get display mode %d of screen %d: %s", i, ScreenId, SDL_GetError()); continue; } aModes[NumModes] = Mode; ++NumModes; } int NumModesInserted = 0; auto &&ModeInsert = [&](SDL_DisplayMode &Mode) { if(NumModesInserted < MaxModes) { // if last mode was equal, ignore this one --- in fullscreen this can really only happen if the screen // supports different color modes // in non fullscreen these are the modes that show different refresh rate, but are basically the same if(NumModesInserted > 0 && pModes[NumModesInserted - 1].m_WindowWidth == Mode.w && pModes[NumModesInserted - 1].m_WindowHeight == Mode.h && (pModes[NumModesInserted - 1].m_RefreshRate == Mode.refresh_rate || (Mode.refresh_rate != DesktopMode.refresh_rate && !CollectFullscreenModes))) return; DisplayToVideoMode(&pModes[NumModesInserted], &Mode, HiDPIScale, !CollectFullscreenModes ? DesktopMode.refresh_rate : Mode.refresh_rate); NumModesInserted++; } }; for(int i = 0; i < NumModes; i++) { SDL_DisplayMode &Mode = aModes[i]; if(Mode.w > MaxWindowWidth || Mode.h > MaxWindowHeight) continue; ModeInsert(Mode); if(IsFullscreenDesktop) break; if(NumModesInserted >= MaxModes) break; } *pNumModes = NumModesInserted; } void CGraphicsBackend_SDL_GL::GetCurrentVideoMode(CVideoMode &CurMode, float HiDPIScale, int MaxWindowWidth, int MaxWindowHeight, int ScreenId) { SDL_DisplayMode DpMode; // if "real" fullscreen, obtain the video mode for that if((SDL_GetWindowFlags(m_pWindow) & SDL_WINDOW_FULLSCREEN_DESKTOP) == SDL_WINDOW_FULLSCREEN) { if(SDL_GetCurrentDisplayMode(ScreenId, &DpMode)) { log_error("gfx", "Unable to get current display mode of screen %d: %s", ScreenId, SDL_GetError()); } } else { if(SDL_GetDesktopDisplayMode(ScreenId, &DpMode) < 0) { log_error("gfx", "Unable to get desktop display mode of screen %d: %s", ScreenId, SDL_GetError()); } else { int Width = 0; int Height = 0; if(m_BackendType != EBackendType::BACKEND_TYPE_VULKAN) SDL_GL_GetDrawableSize(m_pWindow, &Width, &Height); else SDL_Vulkan_GetDrawableSize(m_pWindow, &Width, &Height); // SDL video modes are in screen space which are logical pixels DpMode.w = Width / HiDPIScale; DpMode.h = Height / HiDPIScale; } } DisplayToVideoMode(&CurMode, &DpMode, HiDPIScale, DpMode.refresh_rate); } CGraphicsBackend_SDL_GL::CGraphicsBackend_SDL_GL(TTranslateFunc &&TranslateFunc) : CGraphicsBackend_Threaded(std::move(TranslateFunc)) { m_aErrorString[0] = '\0'; } int CGraphicsBackend_SDL_GL::Init(const char *pName, int *pScreen, int *pWidth, int *pHeight, int *pRefreshRate, int *pFsaaSamples, int Flags, int *pDesktopWidth, int *pDesktopHeight, int *pCurrentWidth, int *pCurrentHeight, IStorage *pStorage) { #if defined(CONF_HEADLESS_CLIENT) m_BackendType = BACKEND_TYPE_OPENGL; g_Config.m_GfxGLMajor = 0; g_Config.m_GfxGLMinor = 0; g_Config.m_GfxGLPatch = 0; int InitError = 0; int GlewMajor = 0; int GlewMinor = 0; int GlewPatch = 0; *pScreen = 0; *pWidth = *pDesktopWidth = *pCurrentWidth = 800; *pHeight = *pDesktopHeight = *pCurrentHeight = 600; *pRefreshRate = 60; *pFsaaSamples = 0; log_info("gfx", "Created headless context"); #else // print sdl version { SDL_version Compiled; SDL_version Linked; SDL_VERSION(&Compiled); SDL_GetVersion(&Linked); log_info("sdl", "SDL version %d.%d.%d (compiled = %d.%d.%d)", Linked.major, Linked.minor, Linked.patch, Compiled.major, Compiled.minor, Compiled.patch); #if CONF_PLATFORM_LINUX && SDL_VERSION_ATLEAST(2, 0, 22) // needed to workaround SDL from forcing exclusively X11 if linking against the GLX flavour of GLEW instead of the EGL one // w/o this on Wayland systems (no XWayland support) SDL's Video subsystem will fail to load (starting from SDL2.30+) if(Linked.major == 2 && Linked.minor >= 30) SDL_SetHint(SDL_HINT_VIDEODRIVER, "x11,wayland"); #endif } if(!SDL_WasInit(SDL_INIT_VIDEO)) { if(SDL_InitSubSystem(SDL_INIT_VIDEO) < 0) { log_error("gfx", "Unable to initialize SDL video: %s", SDL_GetError()); return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_SDL_INIT_FAILED; } } EBackendType OldBackendType = m_BackendType; m_BackendType = DetectBackend(); // little fallback for Vulkan if(OldBackendType != BACKEND_TYPE_AUTO && m_BackendType == BACKEND_TYPE_VULKAN) { // try default opengl settings str_copy(g_Config.m_GfxBackend, "OpenGL"); g_Config.m_GfxGLMajor = 3; g_Config.m_GfxGLMinor = 0; g_Config.m_GfxGLPatch = 0; // do another analysis round too, just in case g_Config.m_Gfx3DTextureAnalysisRan = 0; g_Config.m_GfxDriverIsBlocked = 0; m_BackendType = DetectBackend(); } ClampDriverVersion(m_BackendType); const bool UseModernGL = IsModernAPI(m_BackendType); const bool IsOpenGLFamilyBackend = m_BackendType == BACKEND_TYPE_OPENGL || m_BackendType == BACKEND_TYPE_OPENGL_ES; if(IsOpenGLFamilyBackend) { SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, g_Config.m_GfxGLMajor); SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, g_Config.m_GfxGLMinor); } const char *pBackendName; switch(m_BackendType) { case BACKEND_TYPE_OPENGL: pBackendName = "OpenGL"; break; case BACKEND_TYPE_OPENGL_ES: pBackendName = "OpenGL ES"; break; case BACKEND_TYPE_VULKAN: pBackendName = "Vulkan"; break; default: dbg_assert_failed("Invalid m_BackendType: %d", m_BackendType); } log_info("gfx", "Created %s %d.%d context", pBackendName, g_Config.m_GfxGLMajor, g_Config.m_GfxGLMinor); if(m_BackendType == BACKEND_TYPE_OPENGL) { if(g_Config.m_GfxGLMajor == 3 && g_Config.m_GfxGLMinor == 0) { SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_COMPATIBILITY); } else if(UseModernGL) { SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_CORE); } } else if(m_BackendType == BACKEND_TYPE_OPENGL_ES) { SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_ES); } if(IsOpenGLFamilyBackend) { *pFsaaSamples = std::clamp(*pFsaaSamples, 0, 8); } // set screen m_NumScreens = SDL_GetNumVideoDisplays(); if(m_NumScreens > 0) { SDL_Rect ScreenPos; *pScreen = std::clamp(*pScreen, 0, m_NumScreens - 1); if(SDL_GetDisplayBounds(*pScreen, &ScreenPos) != 0) { log_error("gfx", "Unable to get display bounds of screen %d: %s", *pScreen, SDL_GetError()); return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_SDL_SCREEN_INFO_REQUEST_FAILED; } } else { log_error("gfx", "Unable to get number of screens: %s", SDL_GetError()); return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_SDL_SCREEN_REQUEST_FAILED; } // store desktop resolution for settings reset button SDL_DisplayMode DisplayMode; if(SDL_GetDesktopDisplayMode(*pScreen, &DisplayMode)) { log_error("gfx", "Unable to get desktop display mode of screen %d: %s", *pScreen, SDL_GetError()); return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_SDL_SCREEN_RESOLUTION_REQUEST_FAILED; } bool IsDesktopChanged = *pDesktopWidth == 0 || *pDesktopHeight == 0 || *pDesktopWidth != DisplayMode.w || *pDesktopHeight != DisplayMode.h; *pDesktopWidth = DisplayMode.w; *pDesktopHeight = DisplayMode.h; // fetch supported video modes bool SupportedResolution = false; CVideoMode aModes[256]; int ModesCount = 0; int IndexOfResolution = -1; GetVideoModes(aModes, std::size(aModes), &ModesCount, 1, *pDesktopWidth, *pDesktopHeight, *pScreen); for(int i = 0; i < ModesCount; i++) { if(*pWidth == aModes[i].m_WindowWidth && *pHeight == aModes[i].m_WindowHeight && (*pRefreshRate == aModes[i].m_RefreshRate || *pRefreshRate == 0)) { SupportedResolution = true; IndexOfResolution = i; break; } } // set flags int SdlFlags = SDL_WINDOW_INPUT_GRABBED | SDL_WINDOW_INPUT_FOCUS | SDL_WINDOW_MOUSE_FOCUS | SDL_WINDOW_ALLOW_HIGHDPI; SdlFlags |= (IsOpenGLFamilyBackend) ? SDL_WINDOW_OPENGL : SDL_WINDOW_VULKAN; if(Flags & IGraphicsBackend::INITFLAG_RESIZABLE) SdlFlags |= SDL_WINDOW_RESIZABLE; if(Flags & IGraphicsBackend::INITFLAG_BORDERLESS) SdlFlags |= SDL_WINDOW_BORDERLESS; if(Flags & IGraphicsBackend::INITFLAG_FULLSCREEN) SdlFlags |= SDL_WINDOW_FULLSCREEN; else if(Flags & (IGraphicsBackend::INITFLAG_DESKTOP_FULLSCREEN)) SdlFlags |= SDL_WINDOW_FULLSCREEN_DESKTOP; bool IsFullscreen = (SdlFlags & SDL_WINDOW_FULLSCREEN) != 0 || g_Config.m_GfxFullscreen == 3; // use desktop resolution as default resolution, clamp resolution if users's display is smaller than we remembered // if the user starts in fullscreen, and the resolution was not found use the desktop one if((IsFullscreen && !SupportedResolution) || *pWidth == 0 || *pHeight == 0 || (IsDesktopChanged && (!SupportedResolution || !IsFullscreen) && (*pWidth > *pDesktopWidth || *pHeight > *pDesktopHeight))) { *pWidth = *pDesktopWidth; *pHeight = *pDesktopHeight; *pRefreshRate = DisplayMode.refresh_rate; } // if in fullscreen and refresh rate wasn't set yet, just use the one from the found list if(*pRefreshRate == 0 && SupportedResolution) { *pRefreshRate = aModes[IndexOfResolution].m_RefreshRate; } else if(*pRefreshRate == 0) { *pRefreshRate = DisplayMode.refresh_rate; } // set gl attributes if(IsOpenGLFamilyBackend) { SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1); if(*pFsaaSamples) { SDL_GL_SetAttribute(SDL_GL_MULTISAMPLEBUFFERS, 1); SDL_GL_SetAttribute(SDL_GL_MULTISAMPLESAMPLES, *pFsaaSamples); } else { SDL_GL_SetAttribute(SDL_GL_MULTISAMPLEBUFFERS, 0); SDL_GL_SetAttribute(SDL_GL_MULTISAMPLESAMPLES, 0); } } m_pWindow = SDL_CreateWindow( pName, SDL_WINDOWPOS_CENTERED_DISPLAY(*pScreen), SDL_WINDOWPOS_CENTERED_DISPLAY(*pScreen), *pWidth, *pHeight, SdlFlags); // set caption if(m_pWindow == nullptr) { log_error("gfx", "Unable to create window: %s", SDL_GetError()); if(m_BackendType == BACKEND_TYPE_VULKAN) return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_GL_CONTEXT_FAILED; else return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_SDL_WINDOW_CREATE_FAILED; } int GlewMajor = 0; int GlewMinor = 0; int GlewPatch = 0; if(IsOpenGLFamilyBackend) { m_GLContext = SDL_GL_CreateContext(m_pWindow); if(m_GLContext == nullptr) { log_error("gfx", "Unable to create graphics context: %s", SDL_GetError()); SDL_DestroyWindow(m_pWindow); m_pWindow = nullptr; return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_GL_CONTEXT_FAILED; } if(!BackendInitGlew(m_BackendType, GlewMajor, GlewMinor, GlewPatch)) { SDL_GL_DeleteContext(m_GLContext); SDL_DestroyWindow(m_pWindow); m_pWindow = nullptr; return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_GLEW_INIT_FAILED; } } int InitError = IsVersionSupportedGlew(m_BackendType, g_Config.m_GfxGLMajor, g_Config.m_GfxGLMinor, g_Config.m_GfxGLPatch, GlewMajor, GlewMinor, GlewPatch); // SDL_GL_GetDrawableSize reports HiDPI resolution even with SDL_WINDOW_ALLOW_HIGHDPI not set, which is wrong if(SdlFlags & SDL_WINDOW_ALLOW_HIGHDPI) { if(IsOpenGLFamilyBackend) SDL_GL_GetDrawableSize(m_pWindow, pCurrentWidth, pCurrentHeight); else SDL_Vulkan_GetDrawableSize(m_pWindow, pCurrentWidth, pCurrentHeight); } else SDL_GetWindowSize(m_pWindow, pCurrentWidth, pCurrentHeight); SDL_GetWindowSize(m_pWindow, pWidth, pHeight); if(IsOpenGLFamilyBackend) { #if !defined(CONF_PLATFORM_EMSCRIPTEN) // SDL_GL_SetSwapInterval is not supported with Emscripten as this is only a wrapper for the // emscripten_set_main_loop_timing function which does not work because we do not use the // emscripten_set_main_loop function before. SDL_GL_SetSwapInterval(Flags & IGraphicsBackend::INITFLAG_VSYNC ? 1 : 0); #endif SDL_GL_MakeCurrent(nullptr, nullptr); } if(InitError != 0) { if(m_GLContext) SDL_GL_DeleteContext(m_GLContext); SDL_DestroyWindow(m_pWindow); m_pWindow = nullptr; // try setting to glew supported version g_Config.m_GfxGLMajor = GlewMajor; g_Config.m_GfxGLMinor = GlewMinor; g_Config.m_GfxGLPatch = GlewPatch; return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_GL_VERSION_FAILED; } #endif // !CONF_HEADLESS_CLIENT // start the command processor dbg_assert(m_pProcessor == nullptr, "Processor was not cleaned up properly."); m_pProcessor = new CCommandProcessor_SDL_GL(m_BackendType, g_Config.m_GfxGLMajor, g_Config.m_GfxGLMinor, g_Config.m_GfxGLPatch); StartProcessor(m_pProcessor); // issue init commands for OpenGL and SDL CCommandBuffer CmdBuffer(1024, 512); CCommandProcessorFragment_GLBase::SCommand_PreInit CmdPre; CmdPre.m_pWindow = m_pWindow; CmdPre.m_Width = *pCurrentWidth; CmdPre.m_Height = *pCurrentHeight; CmdPre.m_pVendorString = m_aVendorString; CmdPre.m_pVersionString = m_aVersionString; CmdPre.m_pRendererString = m_aRendererString; CmdPre.m_pGpuList = &m_GpuList; CmdBuffer.AddCommandUnsafe(CmdPre); RunBufferSingleThreadedUnsafe(&CmdBuffer); CmdBuffer.Reset(); // run sdl first to have the context in the thread CCommandProcessorFragment_SDL::SCommand_Init CmdSDL; CmdSDL.m_pWindow = m_pWindow; CmdSDL.m_GLContext = m_GLContext; CmdBuffer.AddCommandUnsafe(CmdSDL); RunBuffer(&CmdBuffer); WaitForIdle(); CmdBuffer.Reset(); const char *pErrorStr = nullptr; if(InitError == 0) { CCommandProcessorFragment_GLBase::SCommand_Init CmdGL; CmdGL.m_pWindow = m_pWindow; CmdGL.m_Width = *pCurrentWidth; CmdGL.m_Height = *pCurrentHeight; CmdGL.m_pTextureMemoryUsage = &m_TextureMemoryUsage; CmdGL.m_pBufferMemoryUsage = &m_BufferMemoryUsage; CmdGL.m_pStreamMemoryUsage = &m_StreamMemoryUsage; CmdGL.m_pStagingMemoryUsage = &m_StagingMemoryUsage; CmdGL.m_pGpuList = &m_GpuList; CmdGL.m_pReadPresentedImageDataFunc = &m_ReadPresentedImageDataFunc; CmdGL.m_pStorage = pStorage; CmdGL.m_pCapabilities = &m_Capabilities; CmdGL.m_pInitError = &InitError; CmdGL.m_RequestedMajor = g_Config.m_GfxGLMajor; CmdGL.m_RequestedMinor = g_Config.m_GfxGLMinor; CmdGL.m_RequestedPatch = g_Config.m_GfxGLPatch; CmdGL.m_GlewMajor = GlewMajor; CmdGL.m_GlewMinor = GlewMinor; CmdGL.m_GlewPatch = GlewPatch; CmdGL.m_pErrStringPtr = &pErrorStr; CmdGL.m_pVendorString = m_aVendorString; CmdGL.m_pVersionString = m_aVersionString; CmdGL.m_pRendererString = m_aRendererString; CmdGL.m_RequestedBackend = m_BackendType; CmdBuffer.AddCommandUnsafe(CmdGL); RunBuffer(&CmdBuffer); WaitForIdle(); CmdBuffer.Reset(); } if(InitError != 0) { if(InitError != -2) { // shutdown the context, as it might have been initialized CCommandProcessorFragment_GLBase::SCommand_Shutdown CmdGL; CmdBuffer.AddCommandUnsafe(CmdGL); RunBuffer(&CmdBuffer); WaitForIdle(); CmdBuffer.Reset(); } CCommandProcessorFragment_SDL::SCommand_Shutdown Cmd; CmdBuffer.AddCommandUnsafe(Cmd); RunBuffer(&CmdBuffer); WaitForIdle(); CmdBuffer.Reset(); CCommandProcessorFragment_GLBase::SCommand_PostShutdown CmdPost; CmdBuffer.AddCommandUnsafe(CmdPost); RunBufferSingleThreadedUnsafe(&CmdBuffer); CmdBuffer.Reset(); // stop and delete the processor StopProcessor(); delete m_pProcessor; m_pProcessor = nullptr; if(m_GLContext) SDL_GL_DeleteContext(m_GLContext); SDL_DestroyWindow(m_pWindow); m_pWindow = nullptr; // try setting to version string's supported version if(InitError == -2) { g_Config.m_GfxGLMajor = m_Capabilities.m_ContextMajor; g_Config.m_GfxGLMinor = m_Capabilities.m_ContextMinor; g_Config.m_GfxGLPatch = m_Capabilities.m_ContextPatch; } if(pErrorStr != nullptr) { str_copy(m_aErrorString, pErrorStr); } return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_GL_VERSION_FAILED; } { CCommandBuffer::SCommand_Update_Viewport CmdSDL2; CmdSDL2.m_X = 0; CmdSDL2.m_Y = 0; CmdSDL2.m_Width = *pCurrentWidth; CmdSDL2.m_Height = *pCurrentHeight; CmdSDL2.m_ByResize = true; CmdBuffer.AddCommandUnsafe(CmdSDL2); RunBuffer(&CmdBuffer); WaitForIdle(); CmdBuffer.Reset(); } return EGraphicsBackendErrorCodes::GRAPHICS_BACKEND_ERROR_CODE_NONE; } int CGraphicsBackend_SDL_GL::Shutdown() { if(m_pProcessor != nullptr) { // issue a shutdown command CCommandBuffer CmdBuffer(1024, 512); CCommandProcessorFragment_GLBase::SCommand_Shutdown CmdGL; CmdBuffer.AddCommandUnsafe(CmdGL); RunBuffer(&CmdBuffer); WaitForIdle(); CmdBuffer.Reset(); CCommandProcessorFragment_SDL::SCommand_Shutdown Cmd; CmdBuffer.AddCommandUnsafe(Cmd); RunBuffer(&CmdBuffer); WaitForIdle(); CmdBuffer.Reset(); CCommandProcessorFragment_GLBase::SCommand_PostShutdown CmdPost; CmdBuffer.AddCommandUnsafe(CmdPost); RunBufferSingleThreadedUnsafe(&CmdBuffer); CmdBuffer.Reset(); // stop and delete the processor StopProcessor(); delete m_pProcessor; m_pProcessor = nullptr; } if(m_GLContext != nullptr) SDL_GL_DeleteContext(m_GLContext); SDL_DestroyWindow(m_pWindow); m_pWindow = nullptr; SDL_QuitSubSystem(SDL_INIT_VIDEO); return 0; } uint64_t CGraphicsBackend_SDL_GL::TextureMemoryUsage() const { return m_TextureMemoryUsage; } uint64_t CGraphicsBackend_SDL_GL::BufferMemoryUsage() const { return m_BufferMemoryUsage; } uint64_t CGraphicsBackend_SDL_GL::StreamedMemoryUsage() const { return m_StreamMemoryUsage; } uint64_t CGraphicsBackend_SDL_GL::StagingMemoryUsage() const { return m_StagingMemoryUsage; } const TTwGraphicsGpuList &CGraphicsBackend_SDL_GL::GetGpus() const { return m_GpuList; } void CGraphicsBackend_SDL_GL::Minimize() { SDL_MinimizeWindow(m_pWindow); } void CGraphicsBackend_SDL_GL::SetWindowParams(int FullscreenMode, bool IsBorderless) { // The flags have to be kept consistent with flags set in the CGraphics_Threaded::IssueInit function! if(FullscreenMode > 0) { bool IsDesktopFullscreen = FullscreenMode == 2; #ifndef CONF_FAMILY_WINDOWS // Windowed fullscreen is only available on Windows, use desktop fullscreen on other platforms IsDesktopFullscreen |= FullscreenMode == 3; #endif if(FullscreenMode == 1) { #if defined(CONF_PLATFORM_MACOS) || defined(CONF_PLATFORM_HAIKU) // Todo SDL: remove this when fixed (game freezes when losing focus in fullscreen) SDL_SetWindowFullscreen(m_pWindow, SDL_WINDOW_FULLSCREEN_DESKTOP); #else SDL_SetWindowFullscreen(m_pWindow, SDL_WINDOW_FULLSCREEN); #endif SDL_SetWindowResizable(m_pWindow, SDL_FALSE); } else if(IsDesktopFullscreen) { SDL_SetWindowFullscreen(m_pWindow, SDL_WINDOW_FULLSCREEN_DESKTOP); SDL_SetWindowResizable(m_pWindow, SDL_FALSE); } else // Windowed fullscreen { SDL_SetWindowFullscreen(m_pWindow, 0); SDL_SetWindowBordered(m_pWindow, SDL_TRUE); SDL_SetWindowResizable(m_pWindow, SDL_FALSE); SDL_DisplayMode DpMode; if(SDL_GetDesktopDisplayMode(g_Config.m_GfxScreen, &DpMode) < 0) { log_error("gfx", "Unable to get desktop display mode of screen %d: %s", g_Config.m_GfxScreen, SDL_GetError()); } else { ResizeWindow(DpMode.w, DpMode.h, DpMode.refresh_rate); SDL_SetWindowPosition(m_pWindow, SDL_WINDOWPOS_CENTERED_DISPLAY(g_Config.m_GfxScreen), SDL_WINDOWPOS_CENTERED_DISPLAY(g_Config.m_GfxScreen)); } } } else // Windowed { SDL_SetWindowFullscreen(m_pWindow, 0); SDL_SetWindowBordered(m_pWindow, SDL_bool(!IsBorderless)); SDL_SetWindowResizable(m_pWindow, SDL_TRUE); } } bool CGraphicsBackend_SDL_GL::SetWindowScreen(int Index, bool MoveToCenter) { if(Index < 0 || Index >= m_NumScreens) { log_error("gfx", "Invalid screen number: %d (min: 0, max: %d)", Index, m_NumScreens); return false; } SDL_Rect ScreenPos; if(SDL_GetDisplayBounds(Index, &ScreenPos) != 0) { log_error("gfx", "Unable to get bounds of screen %d: %s", Index, SDL_GetError()); return false; } if(MoveToCenter) { SDL_SetWindowPosition(m_pWindow, SDL_WINDOWPOS_CENTERED_DISPLAY(Index), SDL_WINDOWPOS_CENTERED_DISPLAY(Index)); } else { SDL_SetWindowPosition(m_pWindow, SDL_WINDOWPOS_UNDEFINED_DISPLAY(Index), SDL_WINDOWPOS_UNDEFINED_DISPLAY(Index)); } return UpdateDisplayMode(Index); } bool CGraphicsBackend_SDL_GL::UpdateDisplayMode(int Index) { SDL_DisplayMode DisplayMode; if(SDL_GetDesktopDisplayMode(Index, &DisplayMode) < 0) { log_error("gfx", "Unable to get desktop display mode of screen %d: %s", Index, SDL_GetError()); return false; } g_Config.m_GfxScreen = Index; g_Config.m_GfxDesktopWidth = DisplayMode.w; g_Config.m_GfxDesktopHeight = DisplayMode.h; return true; } int CGraphicsBackend_SDL_GL::GetWindowScreen() { return SDL_GetWindowDisplayIndex(m_pWindow); } int CGraphicsBackend_SDL_GL::WindowActive() { return m_pWindow && SDL_GetWindowFlags(m_pWindow) & SDL_WINDOW_INPUT_FOCUS; } int CGraphicsBackend_SDL_GL::WindowOpen() { return m_pWindow && SDL_GetWindowFlags(m_pWindow) & SDL_WINDOW_SHOWN; } void CGraphicsBackend_SDL_GL::SetWindowGrab(bool Grab) { SDL_SetWindowGrab(m_pWindow, Grab ? SDL_TRUE : SDL_FALSE); } bool CGraphicsBackend_SDL_GL::ResizeWindow(int w, int h, int RefreshRate) { // don't call resize events when the window is at fullscreen desktop if(!m_pWindow || (SDL_GetWindowFlags(m_pWindow) & SDL_WINDOW_FULLSCREEN_DESKTOP) == SDL_WINDOW_FULLSCREEN_DESKTOP) return false; // if the window is at fullscreen use SDL_SetWindowDisplayMode instead, suggested by SDL if(SDL_GetWindowFlags(m_pWindow) & SDL_WINDOW_FULLSCREEN) { #ifdef CONF_FAMILY_WINDOWS // in windows make the window windowed mode first, this prevents strange window glitches (other games probably do something similar) SetWindowParams(0, true); #endif SDL_DisplayMode SetMode = {}; SDL_DisplayMode ClosestMode = {}; SetMode.format = 0; SetMode.w = w; SetMode.h = h; SetMode.refresh_rate = RefreshRate; SDL_SetWindowDisplayMode(m_pWindow, SDL_GetClosestDisplayMode(g_Config.m_GfxScreen, &SetMode, &ClosestMode)); #ifdef CONF_FAMILY_WINDOWS // now change it back to fullscreen, this will restore the above set state, bcs SDL saves fullscreen modes apart from other video modes (as of SDL 2.0.16) // see implementation of SDL_SetWindowDisplayMode SetWindowParams(1, false); #endif return true; } else { SDL_SetWindowSize(m_pWindow, w, h); if(SDL_GetWindowFlags(m_pWindow) & SDL_WINDOW_MAXIMIZED) // remove maximize flag SDL_RestoreWindow(m_pWindow); } return false; } void CGraphicsBackend_SDL_GL::GetViewportSize(int &w, int &h) { if(m_BackendType != EBackendType::BACKEND_TYPE_VULKAN) SDL_GL_GetDrawableSize(m_pWindow, &w, &h); else SDL_Vulkan_GetDrawableSize(m_pWindow, &w, &h); } void CGraphicsBackend_SDL_GL::NotifyWindow() { // Minimum version 2.0.16, after version 2.0.22 the naming is changed to 2.24.0 etc. #if SDL_MAJOR_VERSION > 2 || (SDL_MAJOR_VERSION == 2 && SDL_MINOR_VERSION == 0 && SDL_PATCHLEVEL >= 16) || (SDL_MAJOR_VERSION == 2 && SDL_MINOR_VERSION > 0) if(SDL_FlashWindow(m_pWindow, SDL_FlashOperation::SDL_FLASH_UNTIL_FOCUSED) != 0) { // fails if SDL hasn't implemented it return; } #endif } bool CGraphicsBackend_SDL_GL::IsScreenKeyboardShown() { return SDL_IsScreenKeyboardShown(m_pWindow); } void CGraphicsBackend_SDL_GL::WindowDestroyNtf(uint32_t WindowId) { } void CGraphicsBackend_SDL_GL::WindowCreateNtf(uint32_t WindowId) { m_pWindow = SDL_GetWindowFromID(WindowId); } TGLBackendReadPresentedImageData &CGraphicsBackend_SDL_GL::GetReadPresentedImageDataFuncUnsafe() { return m_ReadPresentedImageDataFunc; } IGraphicsBackend *CreateGraphicsBackend(TTranslateFunc &&TranslateFunc) { return new CGraphicsBackend_SDL_GL(std::move(TranslateFunc)); }