imgui_impl_sdl3.cpp 61 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246
  1. // dear imgui: Platform Backend for SDL3
  2. // This needs to be used along with a Renderer (e.g. SDL_GPU, DirectX11, OpenGL3, Vulkan..)
  3. // (Info: SDL3 is a cross-platform general purpose library for handling windows, inputs, graphics context creation, etc.)
  4. // Implemented features:
  5. // [X] Platform: Clipboard support.
  6. // [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen.
  7. // [X] Platform: Keyboard support. Since 1.87 we are using the io.AddKeyEvent() function. Pass ImGuiKey values to all key functions e.g. ImGui::IsKeyPressed(ImGuiKey_Space). [Legacy SDL_SCANCODE_* values are obsolete since 1.87 and not supported since 1.91.5]
  8. // [X] Platform: Gamepad support.
  9. // [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  10. // [x] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable' -> the OS animation effect when window gets created/destroyed is problematic. SDL2 backend doesn't have issue.
  11. // Missing features or Issues:
  12. // [ ] Platform: Multi-viewport: Minimized windows seems to break mouse wheel events (at least under Windows).
  13. // [x] Platform: IME support. Position somehow broken in SDL3 + app needs to call 'SDL_SetHint(SDL_HINT_IME_SHOW_UI, "1");' before SDL_CreateWindow()!.
  14. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  15. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  16. // Learn about Dear ImGui:
  17. // - FAQ https://dearimgui.com/faq
  18. // - Getting Started https://dearimgui.com/getting-started
  19. // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
  20. // - Introduction, links and more at the top of imgui.cpp
  21. // CHANGELOG
  22. // (minor and older changes stripped away, please see git history for details)
  23. // 2025-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  24. // 2025-06-27: IME: avoid calling SDL_StartTextInput() again if already active. (#8727)
  25. // 2025-05-15: [Docking] Add Platform_GetWindowFramebufferScale() handler, to allow varying Retina display density on multiple monitors.
  26. // 2025-05-06: [Docking] macOS: fixed secondary viewports not appearing on other monitors before of parenting.
  27. // 2025-04-09: [Docking] Revert update monitors and work areas information every frame. Only do it on Windows. (#8415, #8558)
  28. // 2025-04-22: IME: honor ImGuiPlatformImeData->WantTextInput as an alternative way to call SDL_StartTextInput(), without IME being necessarily visible.
  29. // 2025-04-09: Don't attempt to call SDL_CaptureMouse() on drivers where we don't call SDL_GetGlobalMouseState(). (#8561)
  30. // 2025-03-30: Update for SDL3 api changes: Revert SDL_GetClipboardText() memory ownership change. (#8530, #7801)
  31. // 2025-03-21: Fill gamepad inputs and set ImGuiBackendFlags_HasGamepad regardless of ImGuiConfigFlags_NavEnableGamepad being set.
  32. // 2025-03-10: When dealing with OEM keys, use scancodes instead of translated keycodes to choose ImGuiKey values. (#7136, #7201, #7206, #7306, #7670, #7672, #8468)
  33. // 2025-02-26: Only start SDL_CaptureMouse() when mouse is being dragged, to mitigate issues with e.g.Linux debuggers not claiming capture back. (#6410, #3650)
  34. // 2025-02-25: [Docking] Revert to use SDL_GetDisplayBounds() for WorkPos/WorkRect if SDL_GetDisplayUsableBounds() failed.
  35. // 2025-02-24: Avoid calling SDL_GetGlobalMouseState() when mouse is in relative mode.
  36. // 2025-02-21: [Docking] Update monitors and work areas information every frame, as the later may change regardless of monitor changes. (#8415)
  37. // 2025-02-18: Added ImGuiMouseCursor_Wait and ImGuiMouseCursor_Progress mouse cursor support.
  38. // 2025-02-10: Using SDL_OpenURL() in platform_io.Platform_OpenInShellFn handler.
  39. // 2025-01-20: Made ImGui_ImplSDL3_SetGamepadMode(ImGui_ImplSDL3_GamepadMode_Manual) accept an empty array.
  40. // 2024-10-24: Emscripten: SDL_EVENT_MOUSE_WHEEL event doesn't require dividing by 100.0f on Emscripten.
  41. // 2024-09-11: (Docking) Added support for viewport->ParentViewportId field to support parenting at OS level. (#7973)
  42. // 2024-09-03: Update for SDL3 api changes: SDL_GetGamepads() memory ownership revert. (#7918, #7898, #7807)
  43. // 2024-08-22: moved some OS/backend related function pointers from ImGuiIO to ImGuiPlatformIO:
  44. // - io.GetClipboardTextFn -> platform_io.Platform_GetClipboardTextFn
  45. // - io.SetClipboardTextFn -> platform_io.Platform_SetClipboardTextFn
  46. // - io.PlatformSetImeDataFn -> platform_io.Platform_SetImeDataFn
  47. // 2024-08-19: Storing SDL_WindowID inside ImGuiViewport::PlatformHandle instead of SDL_Window*.
  48. // 2024-08-19: ImGui_ImplSDL3_ProcessEvent() now ignores events intended for other SDL windows. (#7853)
  49. // 2024-07-22: Update for SDL3 api changes: SDL_GetGamepads() memory ownership change. (#7807)
  50. // 2024-07-18: Update for SDL3 api changes: SDL_GetClipboardText() memory ownership change. (#7801)
  51. // 2024-07-15: Update for SDL3 api changes: SDL_GetProperty() change to SDL_GetPointerProperty(). (#7794)
  52. // 2024-07-02: Update for SDL3 api changes: SDLK_x renames and SDLK_KP_x removals (#7761, #7762).
  53. // 2024-07-01: Update for SDL3 api changes: SDL_SetTextInputRect() changed to SDL_SetTextInputArea().
  54. // 2024-06-26: Update for SDL3 api changes: SDL_StartTextInput()/SDL_StopTextInput()/SDL_SetTextInputRect() functions signatures.
  55. // 2024-06-24: Update for SDL3 api changes: SDL_EVENT_KEY_DOWN/SDL_EVENT_KEY_UP contents.
  56. // 2024-06-03; Update for SDL3 api changes: SDL_SYSTEM_CURSOR_ renames.
  57. // 2024-05-15: Update for SDL3 api changes: SDLK_ renames.
  58. // 2024-04-15: Inputs: Re-enable calling SDL_StartTextInput()/SDL_StopTextInput() as SDL3 no longer enables it by default and should play nicer with IME.
  59. // 2024-02-13: Inputs: Fixed gamepad support. Handle gamepad disconnection. Added ImGui_ImplSDL3_SetGamepadMode().
  60. // 2023-11-13: Updated for recent SDL3 API changes.
  61. // 2023-10-05: Inputs: Added support for extra ImGuiKey values: F13 to F24 function keys, app back/forward keys.
  62. // 2023-05-04: Fixed build on Emscripten/iOS/Android. (#6391)
  63. // 2023-04-06: Inputs: Avoid calling SDL_StartTextInput()/SDL_StopTextInput() as they don't only pertain to IME. It's unclear exactly what their relation is to IME. (#6306)
  64. // 2023-04-04: Inputs: Added support for io.AddMouseSourceEvent() to discriminate ImGuiMouseSource_Mouse/ImGuiMouseSource_TouchScreen. (#2702)
  65. // 2023-02-23: Accept SDL_GetPerformanceCounter() not returning a monotonically increasing value. (#6189, #6114, #3644)
  66. // 2023-02-07: Forked "imgui_impl_sdl2" into "imgui_impl_sdl3". Removed version checks for old feature. Refer to imgui_impl_sdl2.cpp for older changelog.
  67. #include "imgui.h"
  68. #ifndef IMGUI_DISABLE
  69. #include "imgui_impl_sdl3.h"
  70. // Clang warnings with -Weverything
  71. #if defined(__clang__)
  72. #pragma clang diagnostic push
  73. #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast
  74. #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision
  75. #endif
  76. // SDL
  77. #include <SDL3/SDL.h>
  78. #include <stdio.h> // for snprintf()
  79. #if defined(__APPLE__)
  80. #include <TargetConditionals.h>
  81. #endif
  82. #ifdef _WIN32
  83. #ifndef WIN32_LEAN_AND_MEAN
  84. #define WIN32_LEAN_AND_MEAN
  85. #endif
  86. #include <windows.h>
  87. #endif
  88. #if !defined(__EMSCRIPTEN__) && !defined(__ANDROID__) && !(defined(__APPLE__) && TARGET_OS_IOS) && !defined(__amigaos4__)
  89. #define SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE 1
  90. #else
  91. #define SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE 0
  92. #endif
  93. // FIXME-LEGACY: remove when SDL 3.1.3 preview is released.
  94. #ifndef SDLK_APOSTROPHE
  95. #define SDLK_APOSTROPHE SDLK_QUOTE
  96. #endif
  97. #ifndef SDLK_GRAVE
  98. #define SDLK_GRAVE SDLK_BACKQUOTE
  99. #endif
  100. // SDL Data
  101. struct ImGui_ImplSDL3_Data
  102. {
  103. SDL_Window* Window;
  104. SDL_WindowID WindowID;
  105. SDL_Renderer* Renderer;
  106. Uint64 Time;
  107. char* ClipboardTextData;
  108. char BackendPlatformName[48];
  109. bool UseVulkan;
  110. bool WantUpdateMonitors;
  111. // IME handling
  112. SDL_Window* ImeWindow;
  113. // Mouse handling
  114. Uint32 MouseWindowID;
  115. int MouseButtonsDown;
  116. SDL_Cursor* MouseCursors[ImGuiMouseCursor_COUNT];
  117. SDL_Cursor* MouseLastCursor;
  118. int MousePendingLeaveFrame;
  119. bool MouseCanUseGlobalState;
  120. bool MouseCanUseCapture;
  121. bool MouseCanReportHoveredViewport; // This is hard to use/unreliable on SDL so we'll set ImGuiBackendFlags_HasMouseHoveredViewport dynamically based on state.
  122. // Gamepad handling
  123. ImVector<SDL_Gamepad*> Gamepads;
  124. ImGui_ImplSDL3_GamepadMode GamepadMode;
  125. bool WantUpdateGamepadsList;
  126. ImGui_ImplSDL3_Data() { memset((void*)this, 0, sizeof(*this)); }
  127. };
  128. // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts
  129. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  130. // FIXME: multi-context support is not well tested and probably dysfunctional in this backend.
  131. // FIXME: some shared resources (mouse cursor shape, gamepad) are mishandled when using multi-context.
  132. static ImGui_ImplSDL3_Data* ImGui_ImplSDL3_GetBackendData()
  133. {
  134. return ImGui::GetCurrentContext() ? (ImGui_ImplSDL3_Data*)ImGui::GetIO().BackendPlatformUserData : nullptr;
  135. }
  136. // Forward Declarations
  137. static void ImGui_ImplSDL3_UpdateMonitors();
  138. static void ImGui_ImplSDL3_InitMultiViewportSupport(SDL_Window* window, void* sdl_gl_context);
  139. static void ImGui_ImplSDL3_ShutdownMultiViewportSupport();
  140. // Functions
  141. static const char* ImGui_ImplSDL3_GetClipboardText(ImGuiContext*)
  142. {
  143. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  144. if (bd->ClipboardTextData)
  145. SDL_free(bd->ClipboardTextData);
  146. bd->ClipboardTextData = SDL_GetClipboardText();
  147. return bd->ClipboardTextData;
  148. }
  149. static void ImGui_ImplSDL3_SetClipboardText(ImGuiContext*, const char* text)
  150. {
  151. SDL_SetClipboardText(text);
  152. }
  153. static void ImGui_ImplSDL3_PlatformSetImeData(ImGuiContext*, ImGuiViewport* viewport, ImGuiPlatformImeData* data)
  154. {
  155. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  156. SDL_WindowID window_id = (SDL_WindowID)(intptr_t)viewport->PlatformHandle;
  157. SDL_Window* window = SDL_GetWindowFromID(window_id);
  158. if ((!(data->WantVisible || data->WantTextInput) || bd->ImeWindow != window) && bd->ImeWindow != nullptr)
  159. {
  160. SDL_StopTextInput(bd->ImeWindow);
  161. bd->ImeWindow = nullptr;
  162. }
  163. if (data->WantVisible)
  164. {
  165. SDL_Rect r;
  166. r.x = (int)(data->InputPos.x - viewport->Pos.x);
  167. r.y = (int)(data->InputPos.y - viewport->Pos.y + data->InputLineHeight);
  168. r.w = 1;
  169. r.h = (int)data->InputLineHeight;
  170. SDL_SetTextInputArea(window, &r, 0);
  171. bd->ImeWindow = window;
  172. }
  173. if (!SDL_TextInputActive(window) && (data->WantVisible || data->WantTextInput))
  174. SDL_StartTextInput(window);
  175. }
  176. // Not static to allow third-party code to use that if they want to (but undocumented)
  177. ImGuiKey ImGui_ImplSDL3_KeyEventToImGuiKey(SDL_Keycode keycode, SDL_Scancode scancode);
  178. ImGuiKey ImGui_ImplSDL3_KeyEventToImGuiKey(SDL_Keycode keycode, SDL_Scancode scancode)
  179. {
  180. // Keypad doesn't have individual key values in SDL3
  181. switch (scancode)
  182. {
  183. case SDL_SCANCODE_KP_0: return ImGuiKey_Keypad0;
  184. case SDL_SCANCODE_KP_1: return ImGuiKey_Keypad1;
  185. case SDL_SCANCODE_KP_2: return ImGuiKey_Keypad2;
  186. case SDL_SCANCODE_KP_3: return ImGuiKey_Keypad3;
  187. case SDL_SCANCODE_KP_4: return ImGuiKey_Keypad4;
  188. case SDL_SCANCODE_KP_5: return ImGuiKey_Keypad5;
  189. case SDL_SCANCODE_KP_6: return ImGuiKey_Keypad6;
  190. case SDL_SCANCODE_KP_7: return ImGuiKey_Keypad7;
  191. case SDL_SCANCODE_KP_8: return ImGuiKey_Keypad8;
  192. case SDL_SCANCODE_KP_9: return ImGuiKey_Keypad9;
  193. case SDL_SCANCODE_KP_PERIOD: return ImGuiKey_KeypadDecimal;
  194. case SDL_SCANCODE_KP_DIVIDE: return ImGuiKey_KeypadDivide;
  195. case SDL_SCANCODE_KP_MULTIPLY: return ImGuiKey_KeypadMultiply;
  196. case SDL_SCANCODE_KP_MINUS: return ImGuiKey_KeypadSubtract;
  197. case SDL_SCANCODE_KP_PLUS: return ImGuiKey_KeypadAdd;
  198. case SDL_SCANCODE_KP_ENTER: return ImGuiKey_KeypadEnter;
  199. case SDL_SCANCODE_KP_EQUALS: return ImGuiKey_KeypadEqual;
  200. default: break;
  201. }
  202. switch (keycode)
  203. {
  204. case SDLK_TAB: return ImGuiKey_Tab;
  205. case SDLK_LEFT: return ImGuiKey_LeftArrow;
  206. case SDLK_RIGHT: return ImGuiKey_RightArrow;
  207. case SDLK_UP: return ImGuiKey_UpArrow;
  208. case SDLK_DOWN: return ImGuiKey_DownArrow;
  209. case SDLK_PAGEUP: return ImGuiKey_PageUp;
  210. case SDLK_PAGEDOWN: return ImGuiKey_PageDown;
  211. case SDLK_HOME: return ImGuiKey_Home;
  212. case SDLK_END: return ImGuiKey_End;
  213. case SDLK_INSERT: return ImGuiKey_Insert;
  214. case SDLK_DELETE: return ImGuiKey_Delete;
  215. case SDLK_BACKSPACE: return ImGuiKey_Backspace;
  216. case SDLK_SPACE: return ImGuiKey_Space;
  217. case SDLK_RETURN: return ImGuiKey_Enter;
  218. case SDLK_ESCAPE: return ImGuiKey_Escape;
  219. //case SDLK_APOSTROPHE: return ImGuiKey_Apostrophe;
  220. case SDLK_COMMA: return ImGuiKey_Comma;
  221. //case SDLK_MINUS: return ImGuiKey_Minus;
  222. case SDLK_PERIOD: return ImGuiKey_Period;
  223. //case SDLK_SLASH: return ImGuiKey_Slash;
  224. case SDLK_SEMICOLON: return ImGuiKey_Semicolon;
  225. //case SDLK_EQUALS: return ImGuiKey_Equal;
  226. //case SDLK_LEFTBRACKET: return ImGuiKey_LeftBracket;
  227. //case SDLK_BACKSLASH: return ImGuiKey_Backslash;
  228. //case SDLK_RIGHTBRACKET: return ImGuiKey_RightBracket;
  229. //case SDLK_GRAVE: return ImGuiKey_GraveAccent;
  230. case SDLK_CAPSLOCK: return ImGuiKey_CapsLock;
  231. case SDLK_SCROLLLOCK: return ImGuiKey_ScrollLock;
  232. case SDLK_NUMLOCKCLEAR: return ImGuiKey_NumLock;
  233. case SDLK_PRINTSCREEN: return ImGuiKey_PrintScreen;
  234. case SDLK_PAUSE: return ImGuiKey_Pause;
  235. case SDLK_LCTRL: return ImGuiKey_LeftCtrl;
  236. case SDLK_LSHIFT: return ImGuiKey_LeftShift;
  237. case SDLK_LALT: return ImGuiKey_LeftAlt;
  238. case SDLK_LGUI: return ImGuiKey_LeftSuper;
  239. case SDLK_RCTRL: return ImGuiKey_RightCtrl;
  240. case SDLK_RSHIFT: return ImGuiKey_RightShift;
  241. case SDLK_RALT: return ImGuiKey_RightAlt;
  242. case SDLK_RGUI: return ImGuiKey_RightSuper;
  243. case SDLK_APPLICATION: return ImGuiKey_Menu;
  244. case SDLK_0: return ImGuiKey_0;
  245. case SDLK_1: return ImGuiKey_1;
  246. case SDLK_2: return ImGuiKey_2;
  247. case SDLK_3: return ImGuiKey_3;
  248. case SDLK_4: return ImGuiKey_4;
  249. case SDLK_5: return ImGuiKey_5;
  250. case SDLK_6: return ImGuiKey_6;
  251. case SDLK_7: return ImGuiKey_7;
  252. case SDLK_8: return ImGuiKey_8;
  253. case SDLK_9: return ImGuiKey_9;
  254. case SDLK_A: return ImGuiKey_A;
  255. case SDLK_B: return ImGuiKey_B;
  256. case SDLK_C: return ImGuiKey_C;
  257. case SDLK_D: return ImGuiKey_D;
  258. case SDLK_E: return ImGuiKey_E;
  259. case SDLK_F: return ImGuiKey_F;
  260. case SDLK_G: return ImGuiKey_G;
  261. case SDLK_H: return ImGuiKey_H;
  262. case SDLK_I: return ImGuiKey_I;
  263. case SDLK_J: return ImGuiKey_J;
  264. case SDLK_K: return ImGuiKey_K;
  265. case SDLK_L: return ImGuiKey_L;
  266. case SDLK_M: return ImGuiKey_M;
  267. case SDLK_N: return ImGuiKey_N;
  268. case SDLK_O: return ImGuiKey_O;
  269. case SDLK_P: return ImGuiKey_P;
  270. case SDLK_Q: return ImGuiKey_Q;
  271. case SDLK_R: return ImGuiKey_R;
  272. case SDLK_S: return ImGuiKey_S;
  273. case SDLK_T: return ImGuiKey_T;
  274. case SDLK_U: return ImGuiKey_U;
  275. case SDLK_V: return ImGuiKey_V;
  276. case SDLK_W: return ImGuiKey_W;
  277. case SDLK_X: return ImGuiKey_X;
  278. case SDLK_Y: return ImGuiKey_Y;
  279. case SDLK_Z: return ImGuiKey_Z;
  280. case SDLK_F1: return ImGuiKey_F1;
  281. case SDLK_F2: return ImGuiKey_F2;
  282. case SDLK_F3: return ImGuiKey_F3;
  283. case SDLK_F4: return ImGuiKey_F4;
  284. case SDLK_F5: return ImGuiKey_F5;
  285. case SDLK_F6: return ImGuiKey_F6;
  286. case SDLK_F7: return ImGuiKey_F7;
  287. case SDLK_F8: return ImGuiKey_F8;
  288. case SDLK_F9: return ImGuiKey_F9;
  289. case SDLK_F10: return ImGuiKey_F10;
  290. case SDLK_F11: return ImGuiKey_F11;
  291. case SDLK_F12: return ImGuiKey_F12;
  292. case SDLK_F13: return ImGuiKey_F13;
  293. case SDLK_F14: return ImGuiKey_F14;
  294. case SDLK_F15: return ImGuiKey_F15;
  295. case SDLK_F16: return ImGuiKey_F16;
  296. case SDLK_F17: return ImGuiKey_F17;
  297. case SDLK_F18: return ImGuiKey_F18;
  298. case SDLK_F19: return ImGuiKey_F19;
  299. case SDLK_F20: return ImGuiKey_F20;
  300. case SDLK_F21: return ImGuiKey_F21;
  301. case SDLK_F22: return ImGuiKey_F22;
  302. case SDLK_F23: return ImGuiKey_F23;
  303. case SDLK_F24: return ImGuiKey_F24;
  304. case SDLK_AC_BACK: return ImGuiKey_AppBack;
  305. case SDLK_AC_FORWARD: return ImGuiKey_AppForward;
  306. default: break;
  307. }
  308. // Fallback to scancode
  309. switch (scancode)
  310. {
  311. case SDL_SCANCODE_GRAVE: return ImGuiKey_GraveAccent;
  312. case SDL_SCANCODE_MINUS: return ImGuiKey_Minus;
  313. case SDL_SCANCODE_EQUALS: return ImGuiKey_Equal;
  314. case SDL_SCANCODE_LEFTBRACKET: return ImGuiKey_LeftBracket;
  315. case SDL_SCANCODE_RIGHTBRACKET: return ImGuiKey_RightBracket;
  316. case SDL_SCANCODE_NONUSBACKSLASH: return ImGuiKey_Oem102;
  317. case SDL_SCANCODE_BACKSLASH: return ImGuiKey_Backslash;
  318. case SDL_SCANCODE_SEMICOLON: return ImGuiKey_Semicolon;
  319. case SDL_SCANCODE_APOSTROPHE: return ImGuiKey_Apostrophe;
  320. case SDL_SCANCODE_COMMA: return ImGuiKey_Comma;
  321. case SDL_SCANCODE_PERIOD: return ImGuiKey_Period;
  322. case SDL_SCANCODE_SLASH: return ImGuiKey_Slash;
  323. default: break;
  324. }
  325. return ImGuiKey_None;
  326. }
  327. static void ImGui_ImplSDL3_UpdateKeyModifiers(SDL_Keymod sdl_key_mods)
  328. {
  329. ImGuiIO& io = ImGui::GetIO();
  330. io.AddKeyEvent(ImGuiMod_Ctrl, (sdl_key_mods & SDL_KMOD_CTRL) != 0);
  331. io.AddKeyEvent(ImGuiMod_Shift, (sdl_key_mods & SDL_KMOD_SHIFT) != 0);
  332. io.AddKeyEvent(ImGuiMod_Alt, (sdl_key_mods & SDL_KMOD_ALT) != 0);
  333. io.AddKeyEvent(ImGuiMod_Super, (sdl_key_mods & SDL_KMOD_GUI) != 0);
  334. }
  335. static ImGuiViewport* ImGui_ImplSDL3_GetViewportForWindowID(SDL_WindowID window_id)
  336. {
  337. return ImGui::FindViewportByPlatformHandle((void*)(intptr_t)window_id);
  338. }
  339. // You can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if dear imgui wants to use your inputs.
  340. // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application, or clear/overwrite your copy of the mouse data.
  341. // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application, or clear/overwrite your copy of the keyboard data.
  342. // Generally you may always pass all inputs to dear imgui, and hide them from your application based on those two flags.
  343. bool ImGui_ImplSDL3_ProcessEvent(const SDL_Event* event)
  344. {
  345. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  346. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplSDL3_Init()?");
  347. ImGuiIO& io = ImGui::GetIO();
  348. switch (event->type)
  349. {
  350. case SDL_EVENT_MOUSE_MOTION:
  351. {
  352. if (ImGui_ImplSDL3_GetViewportForWindowID(event->motion.windowID) == nullptr)
  353. return false;
  354. ImVec2 mouse_pos((float)event->motion.x, (float)event->motion.y);
  355. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  356. {
  357. int window_x, window_y;
  358. SDL_GetWindowPosition(SDL_GetWindowFromID(event->motion.windowID), &window_x, &window_y);
  359. mouse_pos.x += window_x;
  360. mouse_pos.y += window_y;
  361. }
  362. io.AddMouseSourceEvent(event->motion.which == SDL_TOUCH_MOUSEID ? ImGuiMouseSource_TouchScreen : ImGuiMouseSource_Mouse);
  363. io.AddMousePosEvent(mouse_pos.x, mouse_pos.y);
  364. return true;
  365. }
  366. case SDL_EVENT_MOUSE_WHEEL:
  367. {
  368. if (ImGui_ImplSDL3_GetViewportForWindowID(event->wheel.windowID) == nullptr)
  369. return false;
  370. //IMGUI_DEBUG_LOG("wheel %.2f %.2f, precise %.2f %.2f\n", (float)event->wheel.x, (float)event->wheel.y, event->wheel.preciseX, event->wheel.preciseY);
  371. float wheel_x = -event->wheel.x;
  372. float wheel_y = event->wheel.y;
  373. io.AddMouseSourceEvent(event->wheel.which == SDL_TOUCH_MOUSEID ? ImGuiMouseSource_TouchScreen : ImGuiMouseSource_Mouse);
  374. io.AddMouseWheelEvent(wheel_x, wheel_y);
  375. return true;
  376. }
  377. case SDL_EVENT_MOUSE_BUTTON_DOWN:
  378. case SDL_EVENT_MOUSE_BUTTON_UP:
  379. {
  380. if (ImGui_ImplSDL3_GetViewportForWindowID(event->button.windowID) == nullptr)
  381. return false;
  382. int mouse_button = -1;
  383. if (event->button.button == SDL_BUTTON_LEFT) { mouse_button = 0; }
  384. if (event->button.button == SDL_BUTTON_RIGHT) { mouse_button = 1; }
  385. if (event->button.button == SDL_BUTTON_MIDDLE) { mouse_button = 2; }
  386. if (event->button.button == SDL_BUTTON_X1) { mouse_button = 3; }
  387. if (event->button.button == SDL_BUTTON_X2) { mouse_button = 4; }
  388. if (mouse_button == -1)
  389. break;
  390. io.AddMouseSourceEvent(event->button.which == SDL_TOUCH_MOUSEID ? ImGuiMouseSource_TouchScreen : ImGuiMouseSource_Mouse);
  391. io.AddMouseButtonEvent(mouse_button, (event->type == SDL_EVENT_MOUSE_BUTTON_DOWN));
  392. bd->MouseButtonsDown = (event->type == SDL_EVENT_MOUSE_BUTTON_DOWN) ? (bd->MouseButtonsDown | (1 << mouse_button)) : (bd->MouseButtonsDown & ~(1 << mouse_button));
  393. return true;
  394. }
  395. case SDL_EVENT_TEXT_INPUT:
  396. {
  397. if (ImGui_ImplSDL3_GetViewportForWindowID(event->text.windowID) == nullptr)
  398. return false;
  399. io.AddInputCharactersUTF8(event->text.text);
  400. return true;
  401. }
  402. case SDL_EVENT_KEY_DOWN:
  403. case SDL_EVENT_KEY_UP:
  404. {
  405. ImGuiViewport* viewport = ImGui_ImplSDL3_GetViewportForWindowID(event->key.windowID);
  406. if (viewport == nullptr)
  407. return false;
  408. //IMGUI_DEBUG_LOG("SDL_EVENT_KEY_%s : key=0x%08X ('%s'), scancode=%d ('%s'), mod=%X, windowID=%d, viewport=%08X\n",
  409. // (event->type == SDL_EVENT_KEY_DOWN) ? "DOWN" : "UP ", event->key.key, SDL_GetKeyName(event->key.key), event->key.scancode, SDL_GetScancodeName(event->key.scancode), event->key.mod, event->key.windowID, viewport ? viewport->ID : 0);
  410. ImGui_ImplSDL3_UpdateKeyModifiers((SDL_Keymod)event->key.mod);
  411. ImGuiKey key = ImGui_ImplSDL3_KeyEventToImGuiKey(event->key.key, event->key.scancode);
  412. io.AddKeyEvent(key, (event->type == SDL_EVENT_KEY_DOWN));
  413. io.SetKeyEventNativeData(key, (int)event->key.key, (int)event->key.scancode, (int)event->key.scancode); // To support legacy indexing (<1.87 user code). Legacy backend uses SDLK_*** as indices to IsKeyXXX() functions.
  414. return true;
  415. }
  416. case SDL_EVENT_DISPLAY_ORIENTATION:
  417. case SDL_EVENT_DISPLAY_ADDED:
  418. case SDL_EVENT_DISPLAY_REMOVED:
  419. case SDL_EVENT_DISPLAY_MOVED:
  420. case SDL_EVENT_DISPLAY_CONTENT_SCALE_CHANGED:
  421. {
  422. bd->WantUpdateMonitors = true;
  423. return true;
  424. }
  425. case SDL_EVENT_WINDOW_MOUSE_ENTER:
  426. {
  427. if (ImGui_ImplSDL3_GetViewportForWindowID(event->window.windowID) == nullptr)
  428. return false;
  429. bd->MouseWindowID = event->window.windowID;
  430. bd->MousePendingLeaveFrame = 0;
  431. return true;
  432. }
  433. // - In some cases, when detaching a window from main viewport SDL may send SDL_WINDOWEVENT_ENTER one frame too late,
  434. // causing SDL_WINDOWEVENT_LEAVE on previous frame to interrupt drag operation by clear mouse position. This is why
  435. // we delay process the SDL_WINDOWEVENT_LEAVE events by one frame. See issue #5012 for details.
  436. // FIXME: Unconfirmed whether this is still needed with SDL3.
  437. case SDL_EVENT_WINDOW_MOUSE_LEAVE:
  438. {
  439. if (ImGui_ImplSDL3_GetViewportForWindowID(event->window.windowID) == nullptr)
  440. return false;
  441. bd->MousePendingLeaveFrame = ImGui::GetFrameCount() + 1;
  442. return true;
  443. }
  444. case SDL_EVENT_WINDOW_FOCUS_GAINED:
  445. case SDL_EVENT_WINDOW_FOCUS_LOST:
  446. {
  447. ImGuiViewport* viewport = ImGui_ImplSDL3_GetViewportForWindowID(event->window.windowID);
  448. if (viewport == nullptr)
  449. return false;
  450. //IMGUI_DEBUG_LOG("%s: windowId %d, viewport: %08X\n", (event->type == SDL_EVENT_WINDOW_FOCUS_GAINED) ? "SDL_EVENT_WINDOW_FOCUS_GAINED" : "SDL_WINDOWEVENT_FOCUS_LOST", event->window.windowID, viewport ? viewport->ID : 0);
  451. io.AddFocusEvent(event->type == SDL_EVENT_WINDOW_FOCUS_GAINED);
  452. return true;
  453. }
  454. case SDL_EVENT_WINDOW_CLOSE_REQUESTED:
  455. case SDL_EVENT_WINDOW_MOVED:
  456. case SDL_EVENT_WINDOW_RESIZED:
  457. {
  458. ImGuiViewport* viewport = ImGui_ImplSDL3_GetViewportForWindowID(event->window.windowID);
  459. if (viewport == NULL)
  460. return false;
  461. if (event->type == SDL_EVENT_WINDOW_CLOSE_REQUESTED)
  462. viewport->PlatformRequestClose = true;
  463. if (event->type == SDL_EVENT_WINDOW_MOVED)
  464. viewport->PlatformRequestMove = true;
  465. if (event->type == SDL_EVENT_WINDOW_RESIZED)
  466. viewport->PlatformRequestResize = true;
  467. return true;
  468. }
  469. case SDL_EVENT_GAMEPAD_ADDED:
  470. case SDL_EVENT_GAMEPAD_REMOVED:
  471. {
  472. bd->WantUpdateGamepadsList = true;
  473. return true;
  474. }
  475. default:
  476. break;
  477. }
  478. return false;
  479. }
  480. static void ImGui_ImplSDL3_SetupPlatformHandles(ImGuiViewport* viewport, SDL_Window* window)
  481. {
  482. viewport->PlatformHandle = (void*)(intptr_t)SDL_GetWindowID(window);
  483. viewport->PlatformHandleRaw = nullptr;
  484. #if defined(_WIN32) && !defined(__WINRT__)
  485. viewport->PlatformHandleRaw = (HWND)SDL_GetPointerProperty(SDL_GetWindowProperties(window), SDL_PROP_WINDOW_WIN32_HWND_POINTER, nullptr);
  486. #elif defined(__APPLE__)
  487. viewport->PlatformHandleRaw = SDL_GetPointerProperty(SDL_GetWindowProperties(window), SDL_PROP_WINDOW_COCOA_WINDOW_POINTER, nullptr);
  488. #endif
  489. }
  490. static bool ImGui_ImplSDL3_Init(SDL_Window* window, SDL_Renderer* renderer, void* sdl_gl_context)
  491. {
  492. ImGuiIO& io = ImGui::GetIO();
  493. IMGUI_CHECKVERSION();
  494. IM_ASSERT(io.BackendPlatformUserData == nullptr && "Already initialized a platform backend!");
  495. IM_UNUSED(sdl_gl_context); // Unused in this branch
  496. //SDL_SetHint(SDL_HINT_EVENT_LOGGING, "2");
  497. const int ver_linked = SDL_GetVersion();
  498. // Setup backend capabilities flags
  499. ImGui_ImplSDL3_Data* bd = IM_NEW(ImGui_ImplSDL3_Data)();
  500. snprintf(bd->BackendPlatformName, sizeof(bd->BackendPlatformName), "imgui_impl_sdl3 (%d.%d.%d; %d.%d.%d)",
  501. SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_MICRO_VERSION, SDL_VERSIONNUM_MAJOR(ver_linked), SDL_VERSIONNUM_MINOR(ver_linked), SDL_VERSIONNUM_MICRO(ver_linked));
  502. io.BackendPlatformUserData = (void*)bd;
  503. io.BackendPlatformName = bd->BackendPlatformName;
  504. io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
  505. io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
  506. // (ImGuiBackendFlags_PlatformHasViewports may be set just below)
  507. bd->Window = window;
  508. bd->WindowID = SDL_GetWindowID(window);
  509. bd->Renderer = renderer;
  510. // SDL on Linux/OSX doesn't report events for unfocused windows (see https://github.com/ocornut/imgui/issues/4960)
  511. // We will use 'MouseCanReportHoveredViewport' to set 'ImGuiBackendFlags_HasMouseHoveredViewport' dynamically each frame.
  512. #ifndef __APPLE__
  513. bd->MouseCanReportHoveredViewport = bd->MouseCanUseGlobalState;
  514. #else
  515. bd->MouseCanReportHoveredViewport = false;
  516. #endif
  517. // Check and store if we are on a SDL backend that supports SDL_GetGlobalMouseState() and SDL_CaptureMouse()
  518. // ("wayland" and "rpi" don't support it, but we chose to use a white-list instead of a black-list)
  519. bd->MouseCanUseGlobalState = false;
  520. bd->MouseCanUseCapture = false;
  521. #if SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE
  522. const char* sdl_backend = SDL_GetCurrentVideoDriver();
  523. const char* capture_and_global_state_whitelist[] = { "windows", "cocoa", "x11", "DIVE", "VMAN" };
  524. for (const char* item : capture_and_global_state_whitelist)
  525. if (strncmp(sdl_backend, item, strlen(item)) == 0)
  526. bd->MouseCanUseGlobalState = bd->MouseCanUseCapture = true;
  527. #endif
  528. if (bd->MouseCanUseGlobalState)
  529. io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports; // We can create multi-viewports on the Platform side (optional)
  530. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  531. platform_io.Platform_SetClipboardTextFn = ImGui_ImplSDL3_SetClipboardText;
  532. platform_io.Platform_GetClipboardTextFn = ImGui_ImplSDL3_GetClipboardText;
  533. platform_io.Platform_SetImeDataFn = ImGui_ImplSDL3_PlatformSetImeData;
  534. platform_io.Platform_OpenInShellFn = [](ImGuiContext*, const char* url) { return SDL_OpenURL(url) == 0; };
  535. // Update monitor a first time during init
  536. ImGui_ImplSDL3_UpdateMonitors();
  537. // Gamepad handling
  538. bd->GamepadMode = ImGui_ImplSDL3_GamepadMode_AutoFirst;
  539. bd->WantUpdateGamepadsList = true;
  540. // Load mouse cursors
  541. bd->MouseCursors[ImGuiMouseCursor_Arrow] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_DEFAULT);
  542. bd->MouseCursors[ImGuiMouseCursor_TextInput] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_TEXT);
  543. bd->MouseCursors[ImGuiMouseCursor_ResizeAll] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_MOVE);
  544. bd->MouseCursors[ImGuiMouseCursor_ResizeNS] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_NS_RESIZE);
  545. bd->MouseCursors[ImGuiMouseCursor_ResizeEW] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_EW_RESIZE);
  546. bd->MouseCursors[ImGuiMouseCursor_ResizeNESW] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_NESW_RESIZE);
  547. bd->MouseCursors[ImGuiMouseCursor_ResizeNWSE] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_NWSE_RESIZE);
  548. bd->MouseCursors[ImGuiMouseCursor_Hand] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_POINTER);
  549. bd->MouseCursors[ImGuiMouseCursor_Wait] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_WAIT);
  550. bd->MouseCursors[ImGuiMouseCursor_Progress] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_PROGRESS);
  551. bd->MouseCursors[ImGuiMouseCursor_NotAllowed] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_NOT_ALLOWED);
  552. // Set platform dependent data in viewport
  553. // Our mouse update function expect PlatformHandle to be filled for the main viewport
  554. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  555. ImGui_ImplSDL3_SetupPlatformHandles(main_viewport, window);
  556. // From 2.0.5: Set SDL hint to receive mouse click events on window focus, otherwise SDL doesn't emit the event.
  557. // Without this, when clicking to gain focus, our widgets wouldn't activate even though they showed as hovered.
  558. // (This is unfortunately a global SDL setting, so enabling it might have a side-effect on your application.
  559. // It is unlikely to make a difference, but if your app absolutely needs to ignore the initial on-focus click:
  560. // you can ignore SDL_EVENT_MOUSE_BUTTON_DOWN events coming right after a SDL_EVENT_WINDOW_FOCUS_GAINED)
  561. SDL_SetHint(SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH, "1");
  562. // From 2.0.22: Disable auto-capture, this is preventing drag and drop across multiple windows (see #5710)
  563. SDL_SetHint(SDL_HINT_MOUSE_AUTO_CAPTURE, "0");
  564. // SDL 3.x : see https://github.com/libsdl-org/SDL/issues/6659
  565. SDL_SetHint("SDL_BORDERLESS_WINDOWED_STYLE", "0");
  566. // We need SDL_CaptureMouse(), SDL_GetGlobalMouseState() from SDL 2.0.4+ to support multiple viewports.
  567. // We left the call to ImGui_ImplSDL3_InitPlatformInterface() outside of #ifdef to avoid unused-function warnings.
  568. if (io.BackendFlags & ImGuiBackendFlags_PlatformHasViewports)
  569. ImGui_ImplSDL3_InitMultiViewportSupport(window, sdl_gl_context);
  570. return true;
  571. }
  572. // Should technically be a SDL_GLContext but due to typedef it is sane to keep it void* in public interface.
  573. bool ImGui_ImplSDL3_InitForOpenGL(SDL_Window* window, void* sdl_gl_context)
  574. {
  575. return ImGui_ImplSDL3_Init(window, nullptr, sdl_gl_context);
  576. }
  577. bool ImGui_ImplSDL3_InitForVulkan(SDL_Window* window)
  578. {
  579. if (!ImGui_ImplSDL3_Init(window, nullptr, nullptr))
  580. return false;
  581. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  582. bd->UseVulkan = true;
  583. return true;
  584. }
  585. bool ImGui_ImplSDL3_InitForD3D(SDL_Window* window)
  586. {
  587. #if !defined(_WIN32)
  588. IM_ASSERT(0 && "Unsupported");
  589. #endif
  590. return ImGui_ImplSDL3_Init(window, nullptr, nullptr);
  591. }
  592. bool ImGui_ImplSDL3_InitForMetal(SDL_Window* window)
  593. {
  594. return ImGui_ImplSDL3_Init(window, nullptr, nullptr);
  595. }
  596. bool ImGui_ImplSDL3_InitForSDLRenderer(SDL_Window* window, SDL_Renderer* renderer)
  597. {
  598. return ImGui_ImplSDL3_Init(window, renderer, nullptr);
  599. }
  600. bool ImGui_ImplSDL3_InitForSDLGPU(SDL_Window* window)
  601. {
  602. return ImGui_ImplSDL3_Init(window, nullptr, nullptr);
  603. }
  604. bool ImGui_ImplSDL3_InitForOther(SDL_Window* window)
  605. {
  606. return ImGui_ImplSDL3_Init(window, nullptr, nullptr);
  607. }
  608. static void ImGui_ImplSDL3_CloseGamepads();
  609. void ImGui_ImplSDL3_Shutdown()
  610. {
  611. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  612. IM_ASSERT(bd != nullptr && "No platform backend to shutdown, or already shutdown?");
  613. ImGuiIO& io = ImGui::GetIO();
  614. ImGui_ImplSDL3_ShutdownMultiViewportSupport();
  615. if (bd->ClipboardTextData)
  616. SDL_free(bd->ClipboardTextData);
  617. for (ImGuiMouseCursor cursor_n = 0; cursor_n < ImGuiMouseCursor_COUNT; cursor_n++)
  618. SDL_DestroyCursor(bd->MouseCursors[cursor_n]);
  619. ImGui_ImplSDL3_CloseGamepads();
  620. io.BackendPlatformName = nullptr;
  621. io.BackendPlatformUserData = nullptr;
  622. io.BackendFlags &= ~(ImGuiBackendFlags_HasMouseCursors | ImGuiBackendFlags_HasSetMousePos | ImGuiBackendFlags_HasGamepad | ImGuiBackendFlags_PlatformHasViewports | ImGuiBackendFlags_HasMouseHoveredViewport);
  623. IM_DELETE(bd);
  624. }
  625. // This code is incredibly messy because some of the functions we need for full viewport support are not available in SDL < 2.0.4.
  626. static void ImGui_ImplSDL3_UpdateMouseData()
  627. {
  628. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  629. ImGuiIO& io = ImGui::GetIO();
  630. // We forward mouse input when hovered or captured (via SDL_EVENT_MOUSE_MOTION) or when focused (below)
  631. #if SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE
  632. // - SDL_CaptureMouse() let the OS know e.g. that our drags can extend outside of parent boundaries (we want updated position) and shouldn't trigger other operations outside.
  633. // - Debuggers under Linux tends to leave captured mouse on break, which may be very inconvenient, so to mitigate the issue we wait until mouse has moved to begin capture.
  634. if (bd->MouseCanUseCapture)
  635. {
  636. bool want_capture = false;
  637. for (int button_n = 0; button_n < ImGuiMouseButton_COUNT && !want_capture; button_n++)
  638. if (ImGui::IsMouseDragging(button_n, 1.0f))
  639. want_capture = true;
  640. SDL_CaptureMouse(want_capture);
  641. }
  642. SDL_Window* focused_window = SDL_GetKeyboardFocus();
  643. const bool is_app_focused = (focused_window && (bd->Window == focused_window || ImGui_ImplSDL3_GetViewportForWindowID(SDL_GetWindowID(focused_window)) != NULL));
  644. #else
  645. SDL_Window* focused_window = bd->Window;
  646. const bool is_app_focused = (SDL_GetWindowFlags(bd->Window) & SDL_WINDOW_INPUT_FOCUS) != 0; // SDL 2.0.3 and non-windowed systems: single-viewport only
  647. #endif
  648. if (is_app_focused)
  649. {
  650. // (Optional) Set OS mouse position from Dear ImGui if requested (rarely used, only when io.ConfigNavMoveSetMousePos is enabled by user)
  651. if (io.WantSetMousePos)
  652. {
  653. #if SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE
  654. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  655. SDL_WarpMouseGlobal(io.MousePos.x, io.MousePos.y);
  656. else
  657. #endif
  658. SDL_WarpMouseInWindow(bd->Window, io.MousePos.x, io.MousePos.y);
  659. }
  660. // (Optional) Fallback to provide mouse position when focused (SDL_EVENT_MOUSE_MOTION already provides this when hovered or captured)
  661. const bool is_relative_mouse_mode = SDL_GetWindowRelativeMouseMode(bd->Window);
  662. if (bd->MouseCanUseGlobalState && bd->MouseButtonsDown == 0 && !is_relative_mouse_mode)
  663. {
  664. // Single-viewport mode: mouse position in client window coordinates (io.MousePos is (0,0) when the mouse is on the upper-left corner of the app window)
  665. // Multi-viewport mode: mouse position in OS absolute coordinates (io.MousePos is (0,0) when the mouse is on the upper-left of the primary monitor)
  666. float mouse_x, mouse_y;
  667. int window_x, window_y;
  668. SDL_GetGlobalMouseState(&mouse_x, &mouse_y);
  669. if (!(io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable))
  670. {
  671. SDL_GetWindowPosition(focused_window, &window_x, &window_y);
  672. mouse_x -= window_x;
  673. mouse_y -= window_y;
  674. }
  675. io.AddMousePosEvent((float)mouse_x, (float)mouse_y);
  676. }
  677. }
  678. // (Optional) When using multiple viewports: call io.AddMouseViewportEvent() with the viewport the OS mouse cursor is hovering.
  679. // If ImGuiBackendFlags_HasMouseHoveredViewport is not set by the backend, Dear imGui will ignore this field and infer the information using its flawed heuristic.
  680. // - [!] SDL backend does NOT correctly ignore viewports with the _NoInputs flag.
  681. // Some backend are not able to handle that correctly. If a backend report an hovered viewport that has the _NoInputs flag (e.g. when dragging a window
  682. // for docking, the viewport has the _NoInputs flag in order to allow us to find the viewport under), then Dear ImGui is forced to ignore the value reported
  683. // by the backend, and use its flawed heuristic to guess the viewport behind.
  684. // - [X] SDL backend correctly reports this regardless of another viewport behind focused and dragged from (we need this to find a useful drag and drop target).
  685. if (io.BackendFlags & ImGuiBackendFlags_HasMouseHoveredViewport)
  686. {
  687. ImGuiID mouse_viewport_id = 0;
  688. if (ImGuiViewport* mouse_viewport = ImGui_ImplSDL3_GetViewportForWindowID(bd->MouseWindowID))
  689. mouse_viewport_id = mouse_viewport->ID;
  690. io.AddMouseViewportEvent(mouse_viewport_id);
  691. }
  692. }
  693. static void ImGui_ImplSDL3_UpdateMouseCursor()
  694. {
  695. ImGuiIO& io = ImGui::GetIO();
  696. if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
  697. return;
  698. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  699. ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
  700. if (io.MouseDrawCursor || imgui_cursor == ImGuiMouseCursor_None)
  701. {
  702. // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
  703. SDL_HideCursor();
  704. }
  705. else
  706. {
  707. // Show OS mouse cursor
  708. SDL_Cursor* expected_cursor = bd->MouseCursors[imgui_cursor] ? bd->MouseCursors[imgui_cursor] : bd->MouseCursors[ImGuiMouseCursor_Arrow];
  709. if (bd->MouseLastCursor != expected_cursor)
  710. {
  711. SDL_SetCursor(expected_cursor); // SDL function doesn't have an early out (see #6113)
  712. bd->MouseLastCursor = expected_cursor;
  713. }
  714. SDL_ShowCursor();
  715. }
  716. }
  717. static void ImGui_ImplSDL3_CloseGamepads()
  718. {
  719. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  720. if (bd->GamepadMode != ImGui_ImplSDL3_GamepadMode_Manual)
  721. for (SDL_Gamepad* gamepad : bd->Gamepads)
  722. SDL_CloseGamepad(gamepad);
  723. bd->Gamepads.resize(0);
  724. }
  725. void ImGui_ImplSDL3_SetGamepadMode(ImGui_ImplSDL3_GamepadMode mode, SDL_Gamepad** manual_gamepads_array, int manual_gamepads_count)
  726. {
  727. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  728. ImGui_ImplSDL3_CloseGamepads();
  729. if (mode == ImGui_ImplSDL3_GamepadMode_Manual)
  730. {
  731. IM_ASSERT(manual_gamepads_array != nullptr || manual_gamepads_count <= 0);
  732. for (int n = 0; n < manual_gamepads_count; n++)
  733. bd->Gamepads.push_back(manual_gamepads_array[n]);
  734. }
  735. else
  736. {
  737. IM_ASSERT(manual_gamepads_array == nullptr && manual_gamepads_count <= 0);
  738. bd->WantUpdateGamepadsList = true;
  739. }
  740. bd->GamepadMode = mode;
  741. }
  742. static void ImGui_ImplSDL3_UpdateGamepadButton(ImGui_ImplSDL3_Data* bd, ImGuiIO& io, ImGuiKey key, SDL_GamepadButton button_no)
  743. {
  744. bool merged_value = false;
  745. for (SDL_Gamepad* gamepad : bd->Gamepads)
  746. merged_value |= SDL_GetGamepadButton(gamepad, button_no) != 0;
  747. io.AddKeyEvent(key, merged_value);
  748. }
  749. static inline float Saturate(float v) { return v < 0.0f ? 0.0f : v > 1.0f ? 1.0f : v; }
  750. static void ImGui_ImplSDL3_UpdateGamepadAnalog(ImGui_ImplSDL3_Data* bd, ImGuiIO& io, ImGuiKey key, SDL_GamepadAxis axis_no, float v0, float v1)
  751. {
  752. float merged_value = 0.0f;
  753. for (SDL_Gamepad* gamepad : bd->Gamepads)
  754. {
  755. float vn = Saturate((float)(SDL_GetGamepadAxis(gamepad, axis_no) - v0) / (float)(v1 - v0));
  756. if (merged_value < vn)
  757. merged_value = vn;
  758. }
  759. io.AddKeyAnalogEvent(key, merged_value > 0.1f, merged_value);
  760. }
  761. static void ImGui_ImplSDL3_UpdateGamepads()
  762. {
  763. ImGuiIO& io = ImGui::GetIO();
  764. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  765. // Update list of gamepads to use
  766. if (bd->WantUpdateGamepadsList && bd->GamepadMode != ImGui_ImplSDL3_GamepadMode_Manual)
  767. {
  768. ImGui_ImplSDL3_CloseGamepads();
  769. int sdl_gamepads_count = 0;
  770. SDL_JoystickID* sdl_gamepads = SDL_GetGamepads(&sdl_gamepads_count);
  771. for (int n = 0; n < sdl_gamepads_count; n++)
  772. if (SDL_Gamepad* gamepad = SDL_OpenGamepad(sdl_gamepads[n]))
  773. {
  774. bd->Gamepads.push_back(gamepad);
  775. if (bd->GamepadMode == ImGui_ImplSDL3_GamepadMode_AutoFirst)
  776. break;
  777. }
  778. bd->WantUpdateGamepadsList = false;
  779. SDL_free(sdl_gamepads);
  780. }
  781. io.BackendFlags &= ~ImGuiBackendFlags_HasGamepad;
  782. if (bd->Gamepads.Size == 0)
  783. return;
  784. io.BackendFlags |= ImGuiBackendFlags_HasGamepad;
  785. // Update gamepad inputs
  786. const int thumb_dead_zone = 8000; // SDL_gamepad.h suggests using this value.
  787. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadStart, SDL_GAMEPAD_BUTTON_START);
  788. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadBack, SDL_GAMEPAD_BUTTON_BACK);
  789. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadFaceLeft, SDL_GAMEPAD_BUTTON_WEST); // Xbox X, PS Square
  790. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadFaceRight, SDL_GAMEPAD_BUTTON_EAST); // Xbox B, PS Circle
  791. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadFaceUp, SDL_GAMEPAD_BUTTON_NORTH); // Xbox Y, PS Triangle
  792. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadFaceDown, SDL_GAMEPAD_BUTTON_SOUTH); // Xbox A, PS Cross
  793. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadDpadLeft, SDL_GAMEPAD_BUTTON_DPAD_LEFT);
  794. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadDpadRight, SDL_GAMEPAD_BUTTON_DPAD_RIGHT);
  795. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadDpadUp, SDL_GAMEPAD_BUTTON_DPAD_UP);
  796. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadDpadDown, SDL_GAMEPAD_BUTTON_DPAD_DOWN);
  797. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadL1, SDL_GAMEPAD_BUTTON_LEFT_SHOULDER);
  798. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadR1, SDL_GAMEPAD_BUTTON_RIGHT_SHOULDER);
  799. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadL2, SDL_GAMEPAD_AXIS_LEFT_TRIGGER, 0.0f, 32767);
  800. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadR2, SDL_GAMEPAD_AXIS_RIGHT_TRIGGER, 0.0f, 32767);
  801. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadL3, SDL_GAMEPAD_BUTTON_LEFT_STICK);
  802. ImGui_ImplSDL3_UpdateGamepadButton(bd, io, ImGuiKey_GamepadR3, SDL_GAMEPAD_BUTTON_RIGHT_STICK);
  803. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadLStickLeft, SDL_GAMEPAD_AXIS_LEFTX, -thumb_dead_zone, -32768);
  804. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadLStickRight, SDL_GAMEPAD_AXIS_LEFTX, +thumb_dead_zone, +32767);
  805. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadLStickUp, SDL_GAMEPAD_AXIS_LEFTY, -thumb_dead_zone, -32768);
  806. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadLStickDown, SDL_GAMEPAD_AXIS_LEFTY, +thumb_dead_zone, +32767);
  807. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadRStickLeft, SDL_GAMEPAD_AXIS_RIGHTX, -thumb_dead_zone, -32768);
  808. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadRStickRight, SDL_GAMEPAD_AXIS_RIGHTX, +thumb_dead_zone, +32767);
  809. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadRStickUp, SDL_GAMEPAD_AXIS_RIGHTY, -thumb_dead_zone, -32768);
  810. ImGui_ImplSDL3_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadRStickDown, SDL_GAMEPAD_AXIS_RIGHTY, +thumb_dead_zone, +32767);
  811. }
  812. static void ImGui_ImplSDL3_UpdateMonitors()
  813. {
  814. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  815. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  816. platform_io.Monitors.resize(0);
  817. bd->WantUpdateMonitors = false;
  818. int display_count;
  819. SDL_DisplayID* displays = SDL_GetDisplays(&display_count);
  820. for (int n = 0; n < display_count; n++)
  821. {
  822. // Warning: the validity of monitor DPI information on Windows depends on the application DPI awareness settings, which generally needs to be set in the manifest or at runtime.
  823. SDL_DisplayID display_id = displays[n];
  824. ImGuiPlatformMonitor monitor;
  825. SDL_Rect r;
  826. SDL_GetDisplayBounds(display_id, &r);
  827. monitor.MainPos = monitor.WorkPos = ImVec2((float)r.x, (float)r.y);
  828. monitor.MainSize = monitor.WorkSize = ImVec2((float)r.w, (float)r.h);
  829. if (SDL_GetDisplayUsableBounds(display_id, &r) && r.w > 0 && r.h > 0)
  830. {
  831. monitor.WorkPos = ImVec2((float)r.x, (float)r.y);
  832. monitor.WorkSize = ImVec2((float)r.w, (float)r.h);
  833. }
  834. monitor.DpiScale = SDL_GetDisplayContentScale(display_id); // See https://wiki.libsdl.org/SDL3/README-highdpi for details.
  835. monitor.PlatformHandle = (void*)(intptr_t)n;
  836. if (monitor.DpiScale <= 0.0f)
  837. continue; // Some accessibility applications are declaring virtual monitors with a DPI of 0, see #7902.
  838. platform_io.Monitors.push_back(monitor);
  839. }
  840. SDL_free(displays);
  841. }
  842. static void ImGui_ImplSDL3_GetWindowSizeAndFramebufferScale(SDL_Window* window, ImVec2* out_size, ImVec2* out_framebuffer_scale)
  843. {
  844. int w, h;
  845. int display_w, display_h;
  846. SDL_GetWindowSize(window, &w, &h);
  847. if (SDL_GetWindowFlags(window) & SDL_WINDOW_MINIMIZED)
  848. w = h = 0;
  849. SDL_GetWindowSizeInPixels(window, &display_w, &display_h);
  850. if (out_size != nullptr)
  851. *out_size = ImVec2((float)w, (float)h);
  852. if (out_framebuffer_scale != nullptr)
  853. *out_framebuffer_scale = (w > 0 && h > 0) ? ImVec2((float)display_w / w, (float)display_h / h) : ImVec2(1.0f, 1.0f);
  854. }
  855. void ImGui_ImplSDL3_NewFrame()
  856. {
  857. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  858. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplSDL3_Init()?");
  859. ImGuiIO& io = ImGui::GetIO();
  860. // Setup main viewport size (every frame to accommodate for window resizing)
  861. ImGui_ImplSDL3_GetWindowSizeAndFramebufferScale(bd->Window, &io.DisplaySize, &io.DisplayFramebufferScale);
  862. // Update monitors
  863. #ifdef WIN32
  864. bd->WantUpdateMonitors = true; // Keep polling under Windows to handle changes of work area when resizing task-bar (#8415)
  865. #endif
  866. if (bd->WantUpdateMonitors)
  867. ImGui_ImplSDL3_UpdateMonitors();
  868. // Setup time step (we could also use SDL_GetTicksNS() available since SDL3)
  869. // (Accept SDL_GetPerformanceCounter() not returning a monotonically increasing value. Happens in VMs and Emscripten, see #6189, #6114, #3644)
  870. static Uint64 frequency = SDL_GetPerformanceFrequency();
  871. Uint64 current_time = SDL_GetPerformanceCounter();
  872. if (current_time <= bd->Time)
  873. current_time = bd->Time + 1;
  874. io.DeltaTime = bd->Time > 0 ? (float)((double)(current_time - bd->Time) / frequency) : (float)(1.0f / 60.0f);
  875. bd->Time = current_time;
  876. if (bd->MousePendingLeaveFrame && bd->MousePendingLeaveFrame >= ImGui::GetFrameCount() && bd->MouseButtonsDown == 0)
  877. {
  878. bd->MouseWindowID = 0;
  879. bd->MousePendingLeaveFrame = 0;
  880. io.AddMousePosEvent(-FLT_MAX, -FLT_MAX);
  881. }
  882. // Our io.AddMouseViewportEvent() calls will only be valid when not capturing.
  883. // Technically speaking testing for 'bd->MouseButtonsDown == 0' would be more rigorous, but testing for payload reduces noise and potential side-effects.
  884. if (bd->MouseCanReportHoveredViewport && ImGui::GetDragDropPayload() == nullptr)
  885. io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport;
  886. else
  887. io.BackendFlags &= ~ImGuiBackendFlags_HasMouseHoveredViewport;
  888. ImGui_ImplSDL3_UpdateMouseData();
  889. ImGui_ImplSDL3_UpdateMouseCursor();
  890. // Update game controllers (if enabled and available)
  891. ImGui_ImplSDL3_UpdateGamepads();
  892. }
  893. //--------------------------------------------------------------------------------------------------------
  894. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  895. // This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports simultaneously.
  896. // If you are new to dear imgui or creating a new binding for dear imgui, it is recommended that you completely ignore this section first..
  897. //--------------------------------------------------------------------------------------------------------
  898. // Helper structure we store in the void* PlatformUserData field of each ImGuiViewport to easily retrieve our backend data.
  899. struct ImGui_ImplSDL3_ViewportData
  900. {
  901. SDL_Window* Window;
  902. SDL_Window* ParentWindow;
  903. Uint32 WindowID; // Stored in ImGuiViewport::PlatformHandle. Use SDL_GetWindowFromID() to get SDL_Window* from Uint32 WindowID.
  904. bool WindowOwned;
  905. SDL_GLContext GLContext;
  906. ImGui_ImplSDL3_ViewportData() { Window = ParentWindow = nullptr; WindowID = 0; WindowOwned = false; GLContext = nullptr; }
  907. ~ImGui_ImplSDL3_ViewportData() { IM_ASSERT(Window == nullptr && GLContext == nullptr); }
  908. };
  909. static SDL_Window* ImGui_ImplSDL3_GetSDLWindowFromViewportID(ImGuiID viewport_id)
  910. {
  911. if (viewport_id != 0)
  912. if (ImGuiViewport* viewport = ImGui::FindViewportByID(viewport_id))
  913. {
  914. SDL_WindowID window_id = (SDL_WindowID)(intptr_t)viewport->PlatformHandle;
  915. return SDL_GetWindowFromID(window_id);
  916. }
  917. return nullptr;
  918. }
  919. static void ImGui_ImplSDL3_CreateWindow(ImGuiViewport* viewport)
  920. {
  921. ImGui_ImplSDL3_Data* bd = ImGui_ImplSDL3_GetBackendData();
  922. ImGui_ImplSDL3_ViewportData* vd = IM_NEW(ImGui_ImplSDL3_ViewportData)();
  923. viewport->PlatformUserData = vd;
  924. vd->ParentWindow = ImGui_ImplSDL3_GetSDLWindowFromViewportID(viewport->ParentViewportId);
  925. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  926. ImGui_ImplSDL3_ViewportData* main_viewport_data = (ImGui_ImplSDL3_ViewportData*)main_viewport->PlatformUserData;
  927. // Share GL resources with main context
  928. bool use_opengl = (main_viewport_data->GLContext != nullptr);
  929. SDL_GLContext backup_context = nullptr;
  930. if (use_opengl)
  931. {
  932. backup_context = SDL_GL_GetCurrentContext();
  933. SDL_GL_SetAttribute(SDL_GL_SHARE_WITH_CURRENT_CONTEXT, 1);
  934. SDL_GL_MakeCurrent(main_viewport_data->Window, main_viewport_data->GLContext);
  935. }
  936. SDL_WindowFlags sdl_flags = 0;
  937. sdl_flags |= SDL_WINDOW_HIDDEN;
  938. sdl_flags |= use_opengl ? SDL_WINDOW_OPENGL : (bd->UseVulkan ? SDL_WINDOW_VULKAN : 0);
  939. sdl_flags |= SDL_GetWindowFlags(bd->Window) & SDL_WINDOW_HIGH_PIXEL_DENSITY;
  940. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_NoDecoration) ? SDL_WINDOW_BORDERLESS : 0;
  941. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_NoDecoration) ? 0 : SDL_WINDOW_RESIZABLE;
  942. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_NoTaskBarIcon) ? SDL_WINDOW_UTILITY : 0;
  943. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_TopMost) ? SDL_WINDOW_ALWAYS_ON_TOP : 0;
  944. vd->Window = SDL_CreateWindow("No Title Yet", (int)viewport->Size.x, (int)viewport->Size.y, sdl_flags);
  945. #ifndef __APPLE__ // On Mac, SDL3 Parenting appears to prevent viewport from appearing in another monitor
  946. SDL_SetWindowParent(vd->Window, vd->ParentWindow);
  947. #endif
  948. SDL_SetWindowPosition(vd->Window, (int)viewport->Pos.x, (int)viewport->Pos.y);
  949. vd->WindowOwned = true;
  950. if (use_opengl)
  951. {
  952. vd->GLContext = SDL_GL_CreateContext(vd->Window);
  953. SDL_GL_SetSwapInterval(0);
  954. }
  955. if (use_opengl && backup_context)
  956. SDL_GL_MakeCurrent(vd->Window, backup_context);
  957. ImGui_ImplSDL3_SetupPlatformHandles(viewport, vd->Window);
  958. }
  959. static void ImGui_ImplSDL3_DestroyWindow(ImGuiViewport* viewport)
  960. {
  961. if (ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData)
  962. {
  963. if (vd->GLContext && vd->WindowOwned)
  964. SDL_GL_DestroyContext(vd->GLContext);
  965. if (vd->Window && vd->WindowOwned)
  966. SDL_DestroyWindow(vd->Window);
  967. vd->GLContext = nullptr;
  968. vd->Window = nullptr;
  969. IM_DELETE(vd);
  970. }
  971. viewport->PlatformUserData = viewport->PlatformHandle = nullptr;
  972. }
  973. static void ImGui_ImplSDL3_ShowWindow(ImGuiViewport* viewport)
  974. {
  975. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  976. #if defined(_WIN32) && !(defined(WINAPI_FAMILY) && ((defined(WINAPI_FAMILY_APP) && WINAPI_FAMILY == WINAPI_FAMILY_APP) || (defined(WINAPI_FAMILY_GAMES) && WINAPI_FAMILY == WINAPI_FAMILY_GAMES)))
  977. HWND hwnd = (HWND)viewport->PlatformHandleRaw;
  978. // SDL hack: Show icon in task bar (#7989)
  979. // Note: SDL_WINDOW_UTILITY can be used to control task bar visibility, but on Windows, it does not affect child windows.
  980. if (!(viewport->Flags & ImGuiViewportFlags_NoTaskBarIcon))
  981. {
  982. LONG ex_style = ::GetWindowLong(hwnd, GWL_EXSTYLE);
  983. ex_style |= WS_EX_APPWINDOW;
  984. ex_style &= ~WS_EX_TOOLWINDOW;
  985. ::ShowWindow(hwnd, SW_HIDE);
  986. ::SetWindowLong(hwnd, GWL_EXSTYLE, ex_style);
  987. }
  988. #endif
  989. #ifdef __APPLE__
  990. SDL_SetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_SHOWN, "1"); // Otherwise new window appear under
  991. #else
  992. SDL_SetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_SHOWN, (viewport->Flags & ImGuiViewportFlags_NoFocusOnAppearing) ? "0" : "1");
  993. #endif
  994. SDL_ShowWindow(vd->Window);
  995. }
  996. static void ImGui_ImplSDL3_UpdateWindow(ImGuiViewport* viewport)
  997. {
  998. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  999. IM_UNUSED(vd);
  1000. #ifndef __APPLE__ // On Mac, SDL3 Parenting appears to prevent viewport from appearing in another monitor
  1001. // Update SDL3 parent if it changed _after_ creation.
  1002. // This is for advanced apps that are manipulating ParentViewportID manually.
  1003. SDL_Window* new_parent = ImGui_ImplSDL3_GetSDLWindowFromViewportID(viewport->ParentViewportId);
  1004. if (new_parent != vd->ParentWindow)
  1005. {
  1006. vd->ParentWindow = new_parent;
  1007. SDL_SetWindowParent(vd->Window, vd->ParentWindow);
  1008. }
  1009. #endif
  1010. }
  1011. static ImVec2 ImGui_ImplSDL3_GetWindowPos(ImGuiViewport* viewport)
  1012. {
  1013. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1014. int x = 0, y = 0;
  1015. SDL_GetWindowPosition(vd->Window, &x, &y);
  1016. return ImVec2((float)x, (float)y);
  1017. }
  1018. static void ImGui_ImplSDL3_SetWindowPos(ImGuiViewport* viewport, ImVec2 pos)
  1019. {
  1020. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1021. SDL_SetWindowPosition(vd->Window, (int)pos.x, (int)pos.y);
  1022. }
  1023. static ImVec2 ImGui_ImplSDL3_GetWindowSize(ImGuiViewport* viewport)
  1024. {
  1025. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1026. int w = 0, h = 0;
  1027. SDL_GetWindowSize(vd->Window, &w, &h);
  1028. return ImVec2((float)w, (float)h);
  1029. }
  1030. static void ImGui_ImplSDL3_SetWindowSize(ImGuiViewport* viewport, ImVec2 size)
  1031. {
  1032. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1033. SDL_SetWindowSize(vd->Window, (int)size.x, (int)size.y);
  1034. }
  1035. static ImVec2 ImGui_ImplSDL3_GetWindowFramebufferScale(ImGuiViewport* viewport)
  1036. {
  1037. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1038. ImVec2 framebuffer_scale;
  1039. ImGui_ImplSDL3_GetWindowSizeAndFramebufferScale(vd->Window, nullptr, &framebuffer_scale);
  1040. return framebuffer_scale;
  1041. }
  1042. static void ImGui_ImplSDL3_SetWindowTitle(ImGuiViewport* viewport, const char* title)
  1043. {
  1044. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1045. SDL_SetWindowTitle(vd->Window, title);
  1046. }
  1047. static void ImGui_ImplSDL3_SetWindowAlpha(ImGuiViewport* viewport, float alpha)
  1048. {
  1049. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1050. SDL_SetWindowOpacity(vd->Window, alpha);
  1051. }
  1052. static void ImGui_ImplSDL3_SetWindowFocus(ImGuiViewport* viewport)
  1053. {
  1054. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1055. SDL_RaiseWindow(vd->Window);
  1056. }
  1057. static bool ImGui_ImplSDL3_GetWindowFocus(ImGuiViewport* viewport)
  1058. {
  1059. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1060. return (SDL_GetWindowFlags(vd->Window) & SDL_WINDOW_INPUT_FOCUS) != 0;
  1061. }
  1062. static bool ImGui_ImplSDL3_GetWindowMinimized(ImGuiViewport* viewport)
  1063. {
  1064. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1065. return (SDL_GetWindowFlags(vd->Window) & SDL_WINDOW_MINIMIZED) != 0;
  1066. }
  1067. static void ImGui_ImplSDL3_RenderWindow(ImGuiViewport* viewport, void*)
  1068. {
  1069. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1070. if (vd->GLContext)
  1071. SDL_GL_MakeCurrent(vd->Window, vd->GLContext);
  1072. }
  1073. static void ImGui_ImplSDL3_SwapBuffers(ImGuiViewport* viewport, void*)
  1074. {
  1075. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1076. if (vd->GLContext)
  1077. {
  1078. SDL_GL_MakeCurrent(vd->Window, vd->GLContext);
  1079. SDL_GL_SwapWindow(vd->Window);
  1080. }
  1081. }
  1082. // Vulkan support (the Vulkan renderer needs to call a platform-side support function to create the surface)
  1083. // SDL is graceful enough to _not_ need <vulkan/vulkan.h> so we can safely include this.
  1084. #include <SDL3/SDL_vulkan.h>
  1085. static int ImGui_ImplSDL3_CreateVkSurface(ImGuiViewport* viewport, ImU64 vk_instance, const void* vk_allocator, ImU64* out_vk_surface)
  1086. {
  1087. ImGui_ImplSDL3_ViewportData* vd = (ImGui_ImplSDL3_ViewportData*)viewport->PlatformUserData;
  1088. (void)vk_allocator;
  1089. bool ret = SDL_Vulkan_CreateSurface(vd->Window, (VkInstance)vk_instance, (const VkAllocationCallbacks*)vk_allocator, (VkSurfaceKHR*)out_vk_surface);
  1090. return ret ? 0 : 1; // ret ? VK_SUCCESS : VK_NOT_READY
  1091. }
  1092. static void ImGui_ImplSDL3_InitMultiViewportSupport(SDL_Window* window, void* sdl_gl_context)
  1093. {
  1094. // Register platform interface (will be coupled with a renderer interface)
  1095. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  1096. platform_io.Platform_CreateWindow = ImGui_ImplSDL3_CreateWindow;
  1097. platform_io.Platform_DestroyWindow = ImGui_ImplSDL3_DestroyWindow;
  1098. platform_io.Platform_ShowWindow = ImGui_ImplSDL3_ShowWindow;
  1099. platform_io.Platform_UpdateWindow = ImGui_ImplSDL3_UpdateWindow;
  1100. platform_io.Platform_SetWindowPos = ImGui_ImplSDL3_SetWindowPos;
  1101. platform_io.Platform_GetWindowPos = ImGui_ImplSDL3_GetWindowPos;
  1102. platform_io.Platform_SetWindowSize = ImGui_ImplSDL3_SetWindowSize;
  1103. platform_io.Platform_GetWindowSize = ImGui_ImplSDL3_GetWindowSize;
  1104. platform_io.Platform_GetWindowFramebufferScale = ImGui_ImplSDL3_GetWindowFramebufferScale;
  1105. platform_io.Platform_SetWindowFocus = ImGui_ImplSDL3_SetWindowFocus;
  1106. platform_io.Platform_GetWindowFocus = ImGui_ImplSDL3_GetWindowFocus;
  1107. platform_io.Platform_GetWindowMinimized = ImGui_ImplSDL3_GetWindowMinimized;
  1108. platform_io.Platform_SetWindowTitle = ImGui_ImplSDL3_SetWindowTitle;
  1109. platform_io.Platform_RenderWindow = ImGui_ImplSDL3_RenderWindow;
  1110. platform_io.Platform_SwapBuffers = ImGui_ImplSDL3_SwapBuffers;
  1111. platform_io.Platform_SetWindowAlpha = ImGui_ImplSDL3_SetWindowAlpha;
  1112. platform_io.Platform_CreateVkSurface = ImGui_ImplSDL3_CreateVkSurface;
  1113. // Register main window handle (which is owned by the main application, not by us)
  1114. // This is mostly for simplicity and consistency, so that our code (e.g. mouse handling etc.) can use same logic for main and secondary viewports.
  1115. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  1116. ImGui_ImplSDL3_ViewportData* vd = IM_NEW(ImGui_ImplSDL3_ViewportData)();
  1117. vd->Window = window;
  1118. vd->WindowID = SDL_GetWindowID(window);
  1119. vd->WindowOwned = false;
  1120. vd->GLContext = (SDL_GLContext)sdl_gl_context;
  1121. main_viewport->PlatformUserData = vd;
  1122. main_viewport->PlatformHandle = (void*)(intptr_t)vd->WindowID;
  1123. }
  1124. static void ImGui_ImplSDL3_ShutdownMultiViewportSupport()
  1125. {
  1126. ImGui::DestroyPlatformWindows();
  1127. }
  1128. //-----------------------------------------------------------------------------
  1129. #if defined(__clang__)
  1130. #pragma clang diagnostic pop
  1131. #endif
  1132. #endif // #ifndef IMGUI_DISABLE