imgui_impl_sdl2.cpp 61 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213
  1. // dear imgui: Platform Backend for SDL2
  2. // This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..)
  3. // (Info: SDL2 is a cross-platform general purpose library for handling windows, inputs, graphics context creation, etc.)
  4. // (Prefer SDL 2.0.5+ for full feature support.)
  5. // Implemented features:
  6. // [X] Platform: Clipboard support.
  7. // [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen.
  8. // [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]
  9. // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
  10. // [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  11. // [X] Platform: Basic IME support. App needs to call 'SDL_SetHint(SDL_HINT_IME_SHOW_UI, "1");' before SDL_CreateWindow()!.
  12. // [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  13. // Missing features or Issues:
  14. // [ ] Platform: Multi-viewport: Minimized windows seems to break mouse wheel events (at least under Windows).
  15. // [ ] Platform: Multi-viewport: ParentViewportID not honored, and so io.ConfigViewportsNoDefaultParent has no effect (minor).
  16. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  17. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  18. // Learn about Dear ImGui:
  19. // - FAQ https://dearimgui.com/faq
  20. // - Getting Started https://dearimgui.com/getting-started
  21. // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
  22. // - Introduction, links and more at the top of imgui.cpp
  23. // CHANGELOG
  24. // (minor and older changes stripped away, please see git history for details)
  25. // 2025-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  26. // 2025-02-10: Using SDL_OpenURL() in platform_io.Platform_OpenInShellFn handler.
  27. // 2025-01-20: Made ImGui_ImplSDL2_SetGamepadMode(ImGui_ImplSDL2_GamepadMode_Manual) accept an empty array.
  28. // 2024-10-24: Emscripten: from SDL 2.30.9, SDL_EVENT_MOUSE_WHEEL event doesn't require dividing by 100.0f.
  29. // 2024-09-09: use SDL_Vulkan_GetDrawableSize() when available. (#7967, #3190)
  30. // 2024-08-22: moved some OS/backend related function pointers from ImGuiIO to ImGuiPlatformIO:
  31. // - io.GetClipboardTextFn -> platform_io.Platform_GetClipboardTextFn
  32. // - io.SetClipboardTextFn -> platform_io.Platform_SetClipboardTextFn
  33. // - io.PlatformOpenInShellFn -> platform_io.Platform_OpenInShellFn
  34. // - io.PlatformSetImeDataFn -> platform_io.Platform_SetImeDataFn
  35. // 2024-08-19: Storing SDL's Uint32 WindowID inside ImGuiViewport::PlatformHandle instead of SDL_Window*.
  36. // 2024-08-19: ImGui_ImplSDL2_ProcessEvent() now ignores events intended for other SDL windows. (#7853)
  37. // 2024-07-02: Emscripten: Added io.PlatformOpenInShellFn() handler for Emscripten versions.
  38. // 2024-07-02: Update for io.SetPlatformImeDataFn() -> io.PlatformSetImeDataFn() renaming in main library.
  39. // 2024-02-14: Inputs: Handle gamepad disconnection. Added ImGui_ImplSDL2_SetGamepadMode().
  40. // 2023-10-05: Inputs: Added support for extra ImGuiKey values: F13 to F24 function keys, app back/forward keys.
  41. // 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)
  42. // 2023-04-04: Inputs: Added support for io.AddMouseSourceEvent() to discriminate ImGuiMouseSource_Mouse/ImGuiMouseSource_TouchScreen. (#2702)
  43. // 2023-02-23: Accept SDL_GetPerformanceCounter() not returning a monotonically increasing value. (#6189, #6114, #3644)
  44. // 2023-02-07: Implement IME handler (io.SetPlatformImeDataFn will call SDL_SetTextInputRect()/SDL_StartTextInput()).
  45. // 2023-02-07: *BREAKING CHANGE* Renamed this backend file from imgui_impl_sdl.cpp/.h to imgui_impl_sdl2.cpp/.h in prevision for the future release of SDL3.
  46. // 2023-02-02: Avoid calling SDL_SetCursor() when cursor has not changed, as the function is surprisingly costly on Mac with latest SDL (may be fixed in next SDL version).
  47. // 2023-02-02: Added support for SDL 2.0.18+ preciseX/preciseY mouse wheel data for smooth scrolling + Scaling X value on Emscripten (bug?). (#4019, #6096)
  48. // 2023-02-02: Removed SDL_MOUSEWHEEL value clamping, as values seem correct in latest Emscripten. (#4019)
  49. // 2023-02-01: Flipping SDL_MOUSEWHEEL 'wheel.x' value to match other backends and offer consistent horizontal scrolling direction. (#4019, #6096, #1463)
  50. // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
  51. // 2022-09-26: Inputs: Disable SDL 2.0.22 new "auto capture" (SDL_HINT_MOUSE_AUTO_CAPTURE) which prevents drag and drop across windows for multi-viewport support + don't capture when drag and dropping. (#5710)
  52. // 2022-09-26: Inputs: Renamed ImGuiKey_ModXXX introduced in 1.87 to ImGuiMod_XXX (old names still supported).
  53. // 2022-03-22: Inputs: Fix mouse position issues when dragging outside of boundaries. SDL_CaptureMouse() erroneously still gives out LEAVE events when hovering OS decorations.
  54. // 2022-03-22: Inputs: Added support for extra mouse buttons (SDL_BUTTON_X1/SDL_BUTTON_X2).
  55. // 2022-02-04: Added SDL_Renderer* parameter to ImGui_ImplSDL2_InitForSDLRenderer(), so we can use SDL_GetRendererOutputSize() instead of SDL_GL_GetDrawableSize() when bound to a SDL_Renderer.
  56. // 2022-01-26: Inputs: replaced short-lived io.AddKeyModsEvent() (added two weeks ago) with io.AddKeyEvent() using ImGuiKey_ModXXX flags. Sorry for the confusion.
  57. // 2021-01-20: Inputs: calling new io.AddKeyAnalogEvent() for gamepad support, instead of writing directly to io.NavInputs[].
  58. // 2022-01-17: Inputs: calling new io.AddMousePosEvent(), io.AddMouseButtonEvent(), io.AddMouseWheelEvent() API (1.87+).
  59. // 2022-01-17: Inputs: always update key mods next and before key event (not in NewFrame) to fix input queue with very low framerates.
  60. // 2022-01-12: Update mouse inputs using SDL_MOUSEMOTION/SDL_WINDOWEVENT_LEAVE + fallback to provide it when focused but not hovered/captured. More standard and will allow us to pass it to future input queue API.
  61. // 2022-01-12: Maintain our own copy of MouseButtonsDown mask instead of using ImGui::IsAnyMouseDown() which will be obsoleted.
  62. // 2022-01-10: Inputs: calling new io.AddKeyEvent(), io.AddKeyModsEvent() + io.SetKeyEventNativeData() API (1.87+). Support for full ImGuiKey range.
  63. // 2021-08-17: Calling io.AddFocusEvent() on SDL_WINDOWEVENT_FOCUS_GAINED/SDL_WINDOWEVENT_FOCUS_LOST.
  64. // 2021-07-29: Inputs: MousePos is correctly reported when the host platform window is hovered but not focused (using SDL_GetMouseFocus() + SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH, requires SDL 2.0.5+)
  65. // 2021-06:29: *BREAKING CHANGE* Removed 'SDL_Window* window' parameter to ImGui_ImplSDL2_NewFrame() which was unnecessary.
  66. // 2021-06-29: Reorganized backend to pull data from a single structure to facilitate usage with multiple-contexts (all g_XXXX access changed to bd->XXXX).
  67. // 2021-03-22: Rework global mouse pos availability check listing supported platforms explicitly, effectively fixing mouse access on Raspberry Pi. (#2837, #3950)
  68. // 2020-05-25: Misc: Report a zero display-size when window is minimized, to be consistent with other backends.
  69. // 2020-02-20: Inputs: Fixed mapping for ImGuiKey_KeyPadEnter (using SDL_SCANCODE_KP_ENTER instead of SDL_SCANCODE_RETURN2).
  70. // 2019-12-17: Inputs: On Wayland, use SDL_GetMouseState (because there is no global mouse state).
  71. // 2019-12-05: Inputs: Added support for ImGuiMouseCursor_NotAllowed mouse cursor.
  72. // 2019-07-21: Inputs: Added mapping for ImGuiKey_KeyPadEnter.
  73. // 2019-04-23: Inputs: Added support for SDL_GameController (if ImGuiConfigFlags_NavEnableGamepad is set by user application).
  74. // 2019-03-12: Misc: Preserve DisplayFramebufferScale when main window is minimized.
  75. // 2018-12-21: Inputs: Workaround for Android/iOS which don't seem to handle focus related calls.
  76. // 2018-11-30: Misc: Setting up io.BackendPlatformName so it can be displayed in the About Window.
  77. // 2018-11-14: Changed the signature of ImGui_ImplSDL2_ProcessEvent() to take a 'const SDL_Event*'.
  78. // 2018-08-01: Inputs: Workaround for Emscripten which doesn't seem to handle focus related calls.
  79. // 2018-06-29: Inputs: Added support for the ImGuiMouseCursor_Hand cursor.
  80. // 2018-06-08: Misc: Extracted imgui_impl_sdl.cpp/.h away from the old combined SDL2+OpenGL/Vulkan examples.
  81. // 2018-06-08: Misc: ImGui_ImplSDL2_InitForOpenGL() now takes a SDL_GLContext parameter.
  82. // 2018-05-09: Misc: Fixed clipboard paste memory leak (we didn't call SDL_FreeMemory on the data returned by SDL_GetClipboardText).
  83. // 2018-03-20: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors flag + honor ImGuiConfigFlags_NoMouseCursorChange flag.
  84. // 2018-02-16: Inputs: Added support for mouse cursors, honoring ImGui::GetMouseCursor() value.
  85. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  86. // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
  87. // 2018-02-05: Misc: Using SDL_GetPerformanceCounter() instead of SDL_GetTicks() to be able to handle very high framerate (1000+ FPS).
  88. // 2018-02-05: Inputs: Keyboard mapping is using scancodes everywhere instead of a confusing mixture of keycodes and scancodes.
  89. // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
  90. // 2018-01-19: Inputs: When available (SDL 2.0.4+) using SDL_CaptureMouse() to retrieve coordinates outside of client area when dragging. Otherwise (SDL 2.0.3 and before) testing for SDL_WINDOW_INPUT_FOCUS instead of SDL_WINDOW_MOUSE_FOCUS.
  91. // 2018-01-18: Inputs: Added mapping for ImGuiKey_Insert.
  92. // 2017-08-25: Inputs: MousePos set to -FLT_MAX,-FLT_MAX when mouse is unavailable/missing (instead of -1,-1).
  93. // 2016-10-15: Misc: Added a void* user_data parameter to Clipboard function handlers.
  94. #include "imgui.h"
  95. #ifndef IMGUI_DISABLE
  96. #include "imgui_impl_sdl2.h"
  97. // Clang warnings with -Weverything
  98. #if defined(__clang__)
  99. #pragma clang diagnostic push
  100. #pragma clang diagnostic ignored "-Wimplicit-int-float-conversion" // warning: implicit conversion from 'xxx' to 'float' may lose precision
  101. #endif
  102. // SDL
  103. // (the multi-viewports feature requires SDL features supported from SDL 2.0.4+. SDL 2.0.5+ is highly recommended)
  104. #include <SDL.h>
  105. #include <SDL_syswm.h>
  106. #ifdef __APPLE__
  107. #include <TargetConditionals.h>
  108. #endif
  109. #ifdef __EMSCRIPTEN__
  110. #include <emscripten/em_js.h>
  111. #endif
  112. #if SDL_VERSION_ATLEAST(2,0,4) && !defined(__EMSCRIPTEN__) && !defined(__ANDROID__) && !(defined(__APPLE__) && TARGET_OS_IOS) && !defined(__amigaos4__)
  113. #define SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE 1
  114. #else
  115. #define SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE 0
  116. #endif
  117. #define SDL_HAS_WINDOW_ALPHA SDL_VERSION_ATLEAST(2,0,5)
  118. #define SDL_HAS_ALWAYS_ON_TOP SDL_VERSION_ATLEAST(2,0,5)
  119. #define SDL_HAS_USABLE_DISPLAY_BOUNDS SDL_VERSION_ATLEAST(2,0,5)
  120. #define SDL_HAS_PER_MONITOR_DPI SDL_VERSION_ATLEAST(2,0,4)
  121. #define SDL_HAS_VULKAN SDL_VERSION_ATLEAST(2,0,6)
  122. #define SDL_HAS_DISPLAY_EVENT SDL_VERSION_ATLEAST(2,0,9)
  123. #define SDL_HAS_OPEN_URL SDL_VERSION_ATLEAST(2,0,14)
  124. #define SDL_HAS_SHOW_WINDOW_ACTIVATION_HINT SDL_VERSION_ATLEAST(2,0,18)
  125. #if SDL_HAS_VULKAN
  126. #include <SDL_vulkan.h>
  127. #else
  128. static const Uint32 SDL_WINDOW_VULKAN = 0x10000000;
  129. #endif
  130. // SDL Data
  131. struct ImGui_ImplSDL2_Data
  132. {
  133. SDL_Window* Window;
  134. Uint32 WindowID;
  135. SDL_Renderer* Renderer;
  136. Uint64 Time;
  137. char* ClipboardTextData;
  138. bool UseVulkan;
  139. bool WantUpdateMonitors;
  140. // Mouse handling
  141. Uint32 MouseWindowID;
  142. int MouseButtonsDown;
  143. SDL_Cursor* MouseCursors[ImGuiMouseCursor_COUNT];
  144. SDL_Cursor* MouseLastCursor;
  145. int MouseLastLeaveFrame;
  146. bool MouseCanUseGlobalState;
  147. bool MouseCanReportHoveredViewport; // This is hard to use/unreliable on SDL so we'll set ImGuiBackendFlags_HasMouseHoveredViewport dynamically based on state.
  148. // Gamepad handling
  149. ImVector<SDL_GameController*> Gamepads;
  150. ImGui_ImplSDL2_GamepadMode GamepadMode;
  151. bool WantUpdateGamepadsList;
  152. ImGui_ImplSDL2_Data() { memset((void*)this, 0, sizeof(*this)); }
  153. };
  154. // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts
  155. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  156. // FIXME: multi-context support is not well tested and probably dysfunctional in this backend.
  157. // FIXME: some shared resources (mouse cursor shape, gamepad) are mishandled when using multi-context.
  158. static ImGui_ImplSDL2_Data* ImGui_ImplSDL2_GetBackendData()
  159. {
  160. return ImGui::GetCurrentContext() ? (ImGui_ImplSDL2_Data*)ImGui::GetIO().BackendPlatformUserData : nullptr;
  161. }
  162. // Forward Declarations
  163. static void ImGui_ImplSDL2_UpdateMonitors();
  164. static void ImGui_ImplSDL2_InitMultiViewportSupport(SDL_Window* window, void* sdl_gl_context);
  165. static void ImGui_ImplSDL2_ShutdownMultiViewportSupport();
  166. // Functions
  167. static const char* ImGui_ImplSDL2_GetClipboardText(ImGuiContext*)
  168. {
  169. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  170. if (bd->ClipboardTextData)
  171. SDL_free(bd->ClipboardTextData);
  172. bd->ClipboardTextData = SDL_GetClipboardText();
  173. return bd->ClipboardTextData;
  174. }
  175. static void ImGui_ImplSDL2_SetClipboardText(ImGuiContext*, const char* text)
  176. {
  177. SDL_SetClipboardText(text);
  178. }
  179. // Note: native IME will only display if user calls SDL_SetHint(SDL_HINT_IME_SHOW_UI, "1") _before_ SDL_CreateWindow().
  180. static void ImGui_ImplSDL2_PlatformSetImeData(ImGuiContext*, ImGuiViewport* viewport, ImGuiPlatformImeData* data)
  181. {
  182. if (data->WantVisible)
  183. {
  184. SDL_Rect r;
  185. r.x = (int)(data->InputPos.x - viewport->Pos.x);
  186. r.y = (int)(data->InputPos.y - viewport->Pos.y + data->InputLineHeight);
  187. r.w = 1;
  188. r.h = (int)data->InputLineHeight;
  189. SDL_SetTextInputRect(&r);
  190. }
  191. }
  192. // Not static to allow third-party code to use that if they want to (but undocumented)
  193. ImGuiKey ImGui_ImplSDL2_KeyEventToImGuiKey(SDL_Keycode keycode, SDL_Scancode scancode);
  194. ImGuiKey ImGui_ImplSDL2_KeyEventToImGuiKey(SDL_Keycode keycode, SDL_Scancode scancode)
  195. {
  196. IM_UNUSED(scancode);
  197. switch (keycode)
  198. {
  199. case SDLK_TAB: return ImGuiKey_Tab;
  200. case SDLK_LEFT: return ImGuiKey_LeftArrow;
  201. case SDLK_RIGHT: return ImGuiKey_RightArrow;
  202. case SDLK_UP: return ImGuiKey_UpArrow;
  203. case SDLK_DOWN: return ImGuiKey_DownArrow;
  204. case SDLK_PAGEUP: return ImGuiKey_PageUp;
  205. case SDLK_PAGEDOWN: return ImGuiKey_PageDown;
  206. case SDLK_HOME: return ImGuiKey_Home;
  207. case SDLK_END: return ImGuiKey_End;
  208. case SDLK_INSERT: return ImGuiKey_Insert;
  209. case SDLK_DELETE: return ImGuiKey_Delete;
  210. case SDLK_BACKSPACE: return ImGuiKey_Backspace;
  211. case SDLK_SPACE: return ImGuiKey_Space;
  212. case SDLK_RETURN: return ImGuiKey_Enter;
  213. case SDLK_ESCAPE: return ImGuiKey_Escape;
  214. case SDLK_QUOTE: return ImGuiKey_Apostrophe;
  215. case SDLK_COMMA: return ImGuiKey_Comma;
  216. case SDLK_MINUS: return ImGuiKey_Minus;
  217. case SDLK_PERIOD: return ImGuiKey_Period;
  218. case SDLK_SLASH: return ImGuiKey_Slash;
  219. case SDLK_SEMICOLON: return ImGuiKey_Semicolon;
  220. case SDLK_EQUALS: return ImGuiKey_Equal;
  221. case SDLK_LEFTBRACKET: return ImGuiKey_LeftBracket;
  222. case SDLK_BACKSLASH: return ImGuiKey_Backslash;
  223. case SDLK_RIGHTBRACKET: return ImGuiKey_RightBracket;
  224. case SDLK_BACKQUOTE: return ImGuiKey_GraveAccent;
  225. case SDLK_CAPSLOCK: return ImGuiKey_CapsLock;
  226. case SDLK_SCROLLLOCK: return ImGuiKey_ScrollLock;
  227. case SDLK_NUMLOCKCLEAR: return ImGuiKey_NumLock;
  228. case SDLK_PRINTSCREEN: return ImGuiKey_PrintScreen;
  229. case SDLK_PAUSE: return ImGuiKey_Pause;
  230. case SDLK_KP_0: return ImGuiKey_Keypad0;
  231. case SDLK_KP_1: return ImGuiKey_Keypad1;
  232. case SDLK_KP_2: return ImGuiKey_Keypad2;
  233. case SDLK_KP_3: return ImGuiKey_Keypad3;
  234. case SDLK_KP_4: return ImGuiKey_Keypad4;
  235. case SDLK_KP_5: return ImGuiKey_Keypad5;
  236. case SDLK_KP_6: return ImGuiKey_Keypad6;
  237. case SDLK_KP_7: return ImGuiKey_Keypad7;
  238. case SDLK_KP_8: return ImGuiKey_Keypad8;
  239. case SDLK_KP_9: return ImGuiKey_Keypad9;
  240. case SDLK_KP_PERIOD: return ImGuiKey_KeypadDecimal;
  241. case SDLK_KP_DIVIDE: return ImGuiKey_KeypadDivide;
  242. case SDLK_KP_MULTIPLY: return ImGuiKey_KeypadMultiply;
  243. case SDLK_KP_MINUS: return ImGuiKey_KeypadSubtract;
  244. case SDLK_KP_PLUS: return ImGuiKey_KeypadAdd;
  245. case SDLK_KP_ENTER: return ImGuiKey_KeypadEnter;
  246. case SDLK_KP_EQUALS: return ImGuiKey_KeypadEqual;
  247. case SDLK_LCTRL: return ImGuiKey_LeftCtrl;
  248. case SDLK_LSHIFT: return ImGuiKey_LeftShift;
  249. case SDLK_LALT: return ImGuiKey_LeftAlt;
  250. case SDLK_LGUI: return ImGuiKey_LeftSuper;
  251. case SDLK_RCTRL: return ImGuiKey_RightCtrl;
  252. case SDLK_RSHIFT: return ImGuiKey_RightShift;
  253. case SDLK_RALT: return ImGuiKey_RightAlt;
  254. case SDLK_RGUI: return ImGuiKey_RightSuper;
  255. case SDLK_APPLICATION: return ImGuiKey_Menu;
  256. case SDLK_0: return ImGuiKey_0;
  257. case SDLK_1: return ImGuiKey_1;
  258. case SDLK_2: return ImGuiKey_2;
  259. case SDLK_3: return ImGuiKey_3;
  260. case SDLK_4: return ImGuiKey_4;
  261. case SDLK_5: return ImGuiKey_5;
  262. case SDLK_6: return ImGuiKey_6;
  263. case SDLK_7: return ImGuiKey_7;
  264. case SDLK_8: return ImGuiKey_8;
  265. case SDLK_9: return ImGuiKey_9;
  266. case SDLK_a: return ImGuiKey_A;
  267. case SDLK_b: return ImGuiKey_B;
  268. case SDLK_c: return ImGuiKey_C;
  269. case SDLK_d: return ImGuiKey_D;
  270. case SDLK_e: return ImGuiKey_E;
  271. case SDLK_f: return ImGuiKey_F;
  272. case SDLK_g: return ImGuiKey_G;
  273. case SDLK_h: return ImGuiKey_H;
  274. case SDLK_i: return ImGuiKey_I;
  275. case SDLK_j: return ImGuiKey_J;
  276. case SDLK_k: return ImGuiKey_K;
  277. case SDLK_l: return ImGuiKey_L;
  278. case SDLK_m: return ImGuiKey_M;
  279. case SDLK_n: return ImGuiKey_N;
  280. case SDLK_o: return ImGuiKey_O;
  281. case SDLK_p: return ImGuiKey_P;
  282. case SDLK_q: return ImGuiKey_Q;
  283. case SDLK_r: return ImGuiKey_R;
  284. case SDLK_s: return ImGuiKey_S;
  285. case SDLK_t: return ImGuiKey_T;
  286. case SDLK_u: return ImGuiKey_U;
  287. case SDLK_v: return ImGuiKey_V;
  288. case SDLK_w: return ImGuiKey_W;
  289. case SDLK_x: return ImGuiKey_X;
  290. case SDLK_y: return ImGuiKey_Y;
  291. case SDLK_z: return ImGuiKey_Z;
  292. case SDLK_F1: return ImGuiKey_F1;
  293. case SDLK_F2: return ImGuiKey_F2;
  294. case SDLK_F3: return ImGuiKey_F3;
  295. case SDLK_F4: return ImGuiKey_F4;
  296. case SDLK_F5: return ImGuiKey_F5;
  297. case SDLK_F6: return ImGuiKey_F6;
  298. case SDLK_F7: return ImGuiKey_F7;
  299. case SDLK_F8: return ImGuiKey_F8;
  300. case SDLK_F9: return ImGuiKey_F9;
  301. case SDLK_F10: return ImGuiKey_F10;
  302. case SDLK_F11: return ImGuiKey_F11;
  303. case SDLK_F12: return ImGuiKey_F12;
  304. case SDLK_F13: return ImGuiKey_F13;
  305. case SDLK_F14: return ImGuiKey_F14;
  306. case SDLK_F15: return ImGuiKey_F15;
  307. case SDLK_F16: return ImGuiKey_F16;
  308. case SDLK_F17: return ImGuiKey_F17;
  309. case SDLK_F18: return ImGuiKey_F18;
  310. case SDLK_F19: return ImGuiKey_F19;
  311. case SDLK_F20: return ImGuiKey_F20;
  312. case SDLK_F21: return ImGuiKey_F21;
  313. case SDLK_F22: return ImGuiKey_F22;
  314. case SDLK_F23: return ImGuiKey_F23;
  315. case SDLK_F24: return ImGuiKey_F24;
  316. case SDLK_AC_BACK: return ImGuiKey_AppBack;
  317. case SDLK_AC_FORWARD: return ImGuiKey_AppForward;
  318. default: break;
  319. }
  320. return ImGuiKey_None;
  321. }
  322. static void ImGui_ImplSDL2_UpdateKeyModifiers(SDL_Keymod sdl_key_mods)
  323. {
  324. ImGuiIO& io = ImGui::GetIO();
  325. io.AddKeyEvent(ImGuiMod_Ctrl, (sdl_key_mods & KMOD_CTRL) != 0);
  326. io.AddKeyEvent(ImGuiMod_Shift, (sdl_key_mods & KMOD_SHIFT) != 0);
  327. io.AddKeyEvent(ImGuiMod_Alt, (sdl_key_mods & KMOD_ALT) != 0);
  328. io.AddKeyEvent(ImGuiMod_Super, (sdl_key_mods & KMOD_GUI) != 0);
  329. }
  330. static ImGuiViewport* ImGui_ImplSDL2_GetViewportForWindowID(Uint32 window_id)
  331. {
  332. return ImGui::FindViewportByPlatformHandle((void*)(intptr_t)window_id);
  333. }
  334. // You can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if dear imgui wants to use your inputs.
  335. // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application, or clear/overwrite your copy of the mouse data.
  336. // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application, or clear/overwrite your copy of the keyboard data.
  337. // Generally you may always pass all inputs to dear imgui, and hide them from your application based on those two flags.
  338. bool ImGui_ImplSDL2_ProcessEvent(const SDL_Event* event)
  339. {
  340. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  341. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplSDL2_Init()?");
  342. ImGuiIO& io = ImGui::GetIO();
  343. switch (event->type)
  344. {
  345. case SDL_MOUSEMOTION:
  346. {
  347. if (ImGui_ImplSDL2_GetViewportForWindowID(event->motion.windowID) == nullptr)
  348. return false;
  349. ImVec2 mouse_pos((float)event->motion.x, (float)event->motion.y);
  350. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  351. {
  352. int window_x, window_y;
  353. SDL_GetWindowPosition(SDL_GetWindowFromID(event->motion.windowID), &window_x, &window_y);
  354. mouse_pos.x += window_x;
  355. mouse_pos.y += window_y;
  356. }
  357. io.AddMouseSourceEvent(event->motion.which == SDL_TOUCH_MOUSEID ? ImGuiMouseSource_TouchScreen : ImGuiMouseSource_Mouse);
  358. io.AddMousePosEvent(mouse_pos.x, mouse_pos.y);
  359. return true;
  360. }
  361. case SDL_MOUSEWHEEL:
  362. {
  363. if (ImGui_ImplSDL2_GetViewportForWindowID(event->wheel.windowID) == nullptr)
  364. return false;
  365. //IMGUI_DEBUG_LOG("wheel %.2f %.2f, precise %.2f %.2f\n", (float)event->wheel.x, (float)event->wheel.y, event->wheel.preciseX, event->wheel.preciseY);
  366. #if SDL_VERSION_ATLEAST(2,0,18) // If this fails to compile on Emscripten: update to latest Emscripten!
  367. float wheel_x = -event->wheel.preciseX;
  368. float wheel_y = event->wheel.preciseY;
  369. #else
  370. float wheel_x = -(float)event->wheel.x;
  371. float wheel_y = (float)event->wheel.y;
  372. #endif
  373. #if defined(__EMSCRIPTEN__) && !SDL_VERSION_ATLEAST(2,31,0)
  374. wheel_x /= 100.0f;
  375. #endif
  376. io.AddMouseSourceEvent(event->wheel.which == SDL_TOUCH_MOUSEID ? ImGuiMouseSource_TouchScreen : ImGuiMouseSource_Mouse);
  377. io.AddMouseWheelEvent(wheel_x, wheel_y);
  378. return true;
  379. }
  380. case SDL_MOUSEBUTTONDOWN:
  381. case SDL_MOUSEBUTTONUP:
  382. {
  383. if (ImGui_ImplSDL2_GetViewportForWindowID(event->button.windowID) == nullptr)
  384. return false;
  385. int mouse_button = -1;
  386. if (event->button.button == SDL_BUTTON_LEFT) { mouse_button = 0; }
  387. if (event->button.button == SDL_BUTTON_RIGHT) { mouse_button = 1; }
  388. if (event->button.button == SDL_BUTTON_MIDDLE) { mouse_button = 2; }
  389. if (event->button.button == SDL_BUTTON_X1) { mouse_button = 3; }
  390. if (event->button.button == SDL_BUTTON_X2) { mouse_button = 4; }
  391. if (mouse_button == -1)
  392. break;
  393. io.AddMouseSourceEvent(event->button.which == SDL_TOUCH_MOUSEID ? ImGuiMouseSource_TouchScreen : ImGuiMouseSource_Mouse);
  394. io.AddMouseButtonEvent(mouse_button, (event->type == SDL_MOUSEBUTTONDOWN));
  395. bd->MouseButtonsDown = (event->type == SDL_MOUSEBUTTONDOWN) ? (bd->MouseButtonsDown | (1 << mouse_button)) : (bd->MouseButtonsDown & ~(1 << mouse_button));
  396. return true;
  397. }
  398. case SDL_TEXTINPUT:
  399. {
  400. if (ImGui_ImplSDL2_GetViewportForWindowID(event->text.windowID) == nullptr)
  401. return false;
  402. io.AddInputCharactersUTF8(event->text.text);
  403. return true;
  404. }
  405. case SDL_KEYDOWN:
  406. case SDL_KEYUP:
  407. {
  408. if (ImGui_ImplSDL2_GetViewportForWindowID(event->key.windowID) == nullptr)
  409. return false;
  410. ImGui_ImplSDL2_UpdateKeyModifiers((SDL_Keymod)event->key.keysym.mod);
  411. //IMGUI_DEBUG_LOG("SDL_KEY_%s : key=%d ('%s'), scancode=%d ('%s'), mod=%X\n",
  412. // (event->type == SDL_KEYDOWN) ? "DOWN" : "UP ", event->key.keysym.sym, SDL_GetKeyName(event->key.keysym.sym), event->key.keysym.scancode, SDL_GetScancodeName(event->key.keysym.scancode), event->key.keysym.mod);
  413. ImGuiKey key = ImGui_ImplSDL2_KeyEventToImGuiKey(event->key.keysym.sym, event->key.keysym.scancode);
  414. io.AddKeyEvent(key, (event->type == SDL_KEYDOWN));
  415. io.SetKeyEventNativeData(key, event->key.keysym.sym, event->key.keysym.scancode, event->key.keysym.scancode); // To support legacy indexing (<1.87 user code). Legacy backend uses SDLK_*** as indices to IsKeyXXX() functions.
  416. return true;
  417. }
  418. #if SDL_HAS_DISPLAY_EVENT
  419. case SDL_DISPLAYEVENT:
  420. {
  421. // 2.0.26 has SDL_DISPLAYEVENT_CONNECTED/SDL_DISPLAYEVENT_DISCONNECTED/SDL_DISPLAYEVENT_ORIENTATION,
  422. // so change of DPI/Scaling are not reflected in this event. (SDL3 has it)
  423. bd->WantUpdateMonitors = true;
  424. return true;
  425. }
  426. #endif
  427. case SDL_WINDOWEVENT:
  428. {
  429. ImGuiViewport* viewport = ImGui_ImplSDL2_GetViewportForWindowID(event->window.windowID);
  430. if (viewport == NULL)
  431. return false;
  432. // - When capturing mouse, SDL will send a bunch of conflicting LEAVE/ENTER event on every mouse move, but the final ENTER tends to be right.
  433. // - However we won't get a correct LEAVE event for a captured window.
  434. // - In some cases, when detaching a window from main viewport SDL may send SDL_WINDOWEVENT_ENTER one frame too late,
  435. // causing SDL_WINDOWEVENT_LEAVE on previous frame to interrupt drag operation by clear mouse position. This is why
  436. // we delay process the SDL_WINDOWEVENT_LEAVE events by one frame. See issue #5012 for details.
  437. Uint8 window_event = event->window.event;
  438. if (window_event == SDL_WINDOWEVENT_ENTER)
  439. {
  440. bd->MouseWindowID = event->window.windowID;
  441. bd->MouseLastLeaveFrame = 0;
  442. }
  443. if (window_event == SDL_WINDOWEVENT_LEAVE)
  444. bd->MouseLastLeaveFrame = ImGui::GetFrameCount() + 1;
  445. if (window_event == SDL_WINDOWEVENT_FOCUS_GAINED)
  446. io.AddFocusEvent(true);
  447. else if (window_event == SDL_WINDOWEVENT_FOCUS_LOST)
  448. io.AddFocusEvent(false);
  449. else if (window_event == SDL_WINDOWEVENT_CLOSE)
  450. viewport->PlatformRequestClose = true;
  451. else if (window_event == SDL_WINDOWEVENT_MOVED)
  452. viewport->PlatformRequestMove = true;
  453. else if (window_event == SDL_WINDOWEVENT_RESIZED)
  454. viewport->PlatformRequestResize = true;
  455. return true;
  456. }
  457. case SDL_CONTROLLERDEVICEADDED:
  458. case SDL_CONTROLLERDEVICEREMOVED:
  459. {
  460. bd->WantUpdateGamepadsList = true;
  461. return true;
  462. }
  463. }
  464. return false;
  465. }
  466. #ifdef __EMSCRIPTEN__
  467. EM_JS(void, ImGui_ImplSDL2_EmscriptenOpenURL, (char const* url), { url = url ? UTF8ToString(url) : null; if (url) window.open(url, '_blank'); });
  468. #endif
  469. static bool ImGui_ImplSDL2_Init(SDL_Window* window, SDL_Renderer* renderer, void* sdl_gl_context)
  470. {
  471. ImGuiIO& io = ImGui::GetIO();
  472. IMGUI_CHECKVERSION();
  473. IM_ASSERT(io.BackendPlatformUserData == nullptr && "Already initialized a platform backend!");
  474. // Check and store if we are on a SDL backend that supports global mouse position
  475. // ("wayland" and "rpi" don't support it, but we chose to use a white-list instead of a black-list)
  476. bool mouse_can_use_global_state = false;
  477. #if SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE
  478. const char* sdl_backend = SDL_GetCurrentVideoDriver();
  479. const char* global_mouse_whitelist[] = { "windows", "cocoa", "x11", "DIVE", "VMAN" };
  480. for (int n = 0; n < IM_ARRAYSIZE(global_mouse_whitelist); n++)
  481. if (strncmp(sdl_backend, global_mouse_whitelist[n], strlen(global_mouse_whitelist[n])) == 0)
  482. mouse_can_use_global_state = true;
  483. #endif
  484. // Setup backend capabilities flags
  485. ImGui_ImplSDL2_Data* bd = IM_NEW(ImGui_ImplSDL2_Data)();
  486. io.BackendPlatformUserData = (void*)bd;
  487. io.BackendPlatformName = "imgui_impl_sdl2";
  488. io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
  489. io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
  490. if (mouse_can_use_global_state)
  491. io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports; // We can create multi-viewports on the Platform side (optional)
  492. bd->Window = window;
  493. bd->WindowID = SDL_GetWindowID(window);
  494. bd->Renderer = renderer;
  495. // SDL on Linux/OSX doesn't report events for unfocused windows (see https://github.com/ocornut/imgui/issues/4960)
  496. // We will use 'MouseCanReportHoveredViewport' to set 'ImGuiBackendFlags_HasMouseHoveredViewport' dynamically each frame.
  497. bd->MouseCanUseGlobalState = mouse_can_use_global_state;
  498. #ifndef __APPLE__
  499. bd->MouseCanReportHoveredViewport = bd->MouseCanUseGlobalState;
  500. #else
  501. bd->MouseCanReportHoveredViewport = false;
  502. #endif
  503. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  504. platform_io.Platform_SetClipboardTextFn = ImGui_ImplSDL2_SetClipboardText;
  505. platform_io.Platform_GetClipboardTextFn = ImGui_ImplSDL2_GetClipboardText;
  506. platform_io.Platform_ClipboardUserData = nullptr;
  507. platform_io.Platform_SetImeDataFn = ImGui_ImplSDL2_PlatformSetImeData;
  508. #ifdef __EMSCRIPTEN__
  509. platform_io.Platform_OpenInShellFn = [](ImGuiContext*, const char* url) { ImGui_ImplSDL2_EmscriptenOpenURL(url); return true; };
  510. #elif SDL_HAS_OPEN_URL
  511. platform_io.Platform_OpenInShellFn = [](ImGuiContext*, const char* url) { return SDL_OpenURL(url) == 0; };
  512. #endif
  513. // Update monitor a first time during init
  514. ImGui_ImplSDL2_UpdateMonitors();
  515. // Gamepad handling
  516. bd->GamepadMode = ImGui_ImplSDL2_GamepadMode_AutoFirst;
  517. bd->WantUpdateGamepadsList = true;
  518. // Load mouse cursors
  519. bd->MouseCursors[ImGuiMouseCursor_Arrow] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_ARROW);
  520. bd->MouseCursors[ImGuiMouseCursor_TextInput] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_IBEAM);
  521. bd->MouseCursors[ImGuiMouseCursor_ResizeAll] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZEALL);
  522. bd->MouseCursors[ImGuiMouseCursor_ResizeNS] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZENS);
  523. bd->MouseCursors[ImGuiMouseCursor_ResizeEW] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZEWE);
  524. bd->MouseCursors[ImGuiMouseCursor_ResizeNESW] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZENESW);
  525. bd->MouseCursors[ImGuiMouseCursor_ResizeNWSE] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZENWSE);
  526. bd->MouseCursors[ImGuiMouseCursor_Hand] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_HAND);
  527. bd->MouseCursors[ImGuiMouseCursor_NotAllowed] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_NO);
  528. // Set platform dependent data in viewport
  529. // Our mouse update function expect PlatformHandle to be filled for the main viewport
  530. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  531. main_viewport->PlatformHandle = (void*)(intptr_t)bd->WindowID;
  532. main_viewport->PlatformHandleRaw = nullptr;
  533. SDL_SysWMinfo info;
  534. SDL_VERSION(&info.version);
  535. if (SDL_GetWindowWMInfo(window, &info))
  536. {
  537. #if defined(SDL_VIDEO_DRIVER_WINDOWS)
  538. main_viewport->PlatformHandleRaw = (void*)info.info.win.window;
  539. #elif defined(__APPLE__) && defined(SDL_VIDEO_DRIVER_COCOA)
  540. main_viewport->PlatformHandleRaw = (void*)info.info.cocoa.window;
  541. #endif
  542. }
  543. // From 2.0.5: Set SDL hint to receive mouse click events on window focus, otherwise SDL doesn't emit the event.
  544. // Without this, when clicking to gain focus, our widgets wouldn't activate even though they showed as hovered.
  545. // (This is unfortunately a global SDL setting, so enabling it might have a side-effect on your application.
  546. // It is unlikely to make a difference, but if your app absolutely needs to ignore the initial on-focus click:
  547. // you can ignore SDL_MOUSEBUTTONDOWN events coming right after a SDL_WINDOWEVENT_FOCUS_GAINED)
  548. #ifdef SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH
  549. SDL_SetHint(SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH, "1");
  550. #endif
  551. // From 2.0.18: Enable native IME.
  552. // IMPORTANT: This is used at the time of SDL_CreateWindow() so this will only affects secondary windows, if any.
  553. // For the main window to be affected, your application needs to call this manually before calling SDL_CreateWindow().
  554. #ifdef SDL_HINT_IME_SHOW_UI
  555. SDL_SetHint(SDL_HINT_IME_SHOW_UI, "1");
  556. #endif
  557. // From 2.0.22: Disable auto-capture, this is preventing drag and drop across multiple windows (see #5710)
  558. #ifdef SDL_HINT_MOUSE_AUTO_CAPTURE
  559. SDL_SetHint(SDL_HINT_MOUSE_AUTO_CAPTURE, "0");
  560. #endif
  561. // We need SDL_CaptureMouse(), SDL_GetGlobalMouseState() from SDL 2.0.4+ to support multiple viewports.
  562. // We left the call to ImGui_ImplSDL2_InitMultiViewportSupport() outside of #ifdef to avoid unused-function warnings.
  563. if (io.BackendFlags & ImGuiBackendFlags_PlatformHasViewports)
  564. ImGui_ImplSDL2_InitMultiViewportSupport(window, sdl_gl_context);
  565. return true;
  566. }
  567. bool ImGui_ImplSDL2_InitForOpenGL(SDL_Window* window, void* sdl_gl_context)
  568. {
  569. return ImGui_ImplSDL2_Init(window, nullptr, sdl_gl_context);
  570. }
  571. bool ImGui_ImplSDL2_InitForVulkan(SDL_Window* window)
  572. {
  573. #if !SDL_HAS_VULKAN
  574. IM_ASSERT(0 && "Unsupported");
  575. #endif
  576. if (!ImGui_ImplSDL2_Init(window, nullptr, nullptr))
  577. return false;
  578. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  579. bd->UseVulkan = true;
  580. return true;
  581. }
  582. bool ImGui_ImplSDL2_InitForD3D(SDL_Window* window)
  583. {
  584. #if !defined(_WIN32)
  585. IM_ASSERT(0 && "Unsupported");
  586. #endif
  587. return ImGui_ImplSDL2_Init(window, nullptr, nullptr);
  588. }
  589. bool ImGui_ImplSDL2_InitForMetal(SDL_Window* window)
  590. {
  591. return ImGui_ImplSDL2_Init(window, nullptr, nullptr);
  592. }
  593. bool ImGui_ImplSDL2_InitForSDLRenderer(SDL_Window* window, SDL_Renderer* renderer)
  594. {
  595. return ImGui_ImplSDL2_Init(window, renderer, nullptr);
  596. }
  597. bool ImGui_ImplSDL2_InitForOther(SDL_Window* window)
  598. {
  599. return ImGui_ImplSDL2_Init(window, nullptr, nullptr);
  600. }
  601. static void ImGui_ImplSDL2_CloseGamepads();
  602. void ImGui_ImplSDL2_Shutdown()
  603. {
  604. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  605. IM_ASSERT(bd != nullptr && "No platform backend to shutdown, or already shutdown?");
  606. ImGuiIO& io = ImGui::GetIO();
  607. ImGui_ImplSDL2_ShutdownMultiViewportSupport();
  608. if (bd->ClipboardTextData)
  609. SDL_free(bd->ClipboardTextData);
  610. for (ImGuiMouseCursor cursor_n = 0; cursor_n < ImGuiMouseCursor_COUNT; cursor_n++)
  611. SDL_FreeCursor(bd->MouseCursors[cursor_n]);
  612. ImGui_ImplSDL2_CloseGamepads();
  613. io.BackendPlatformName = nullptr;
  614. io.BackendPlatformUserData = nullptr;
  615. io.BackendFlags &= ~(ImGuiBackendFlags_HasMouseCursors | ImGuiBackendFlags_HasSetMousePos | ImGuiBackendFlags_HasGamepad | ImGuiBackendFlags_PlatformHasViewports | ImGuiBackendFlags_HasMouseHoveredViewport);
  616. IM_DELETE(bd);
  617. }
  618. // This code is incredibly messy because some of the functions we need for full viewport support are not available in SDL < 2.0.4.
  619. static void ImGui_ImplSDL2_UpdateMouseData()
  620. {
  621. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  622. ImGuiIO& io = ImGui::GetIO();
  623. // We forward mouse input when hovered or captured (via SDL_MOUSEMOTION) or when focused (below)
  624. #if SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE
  625. // SDL_CaptureMouse() let the OS know e.g. that our imgui drag outside the SDL window boundaries shouldn't e.g. trigger other operations outside
  626. SDL_CaptureMouse((bd->MouseButtonsDown != 0) ? SDL_TRUE : SDL_FALSE);
  627. SDL_Window* focused_window = SDL_GetKeyboardFocus();
  628. const bool is_app_focused = (focused_window && (bd->Window == focused_window || ImGui_ImplSDL2_GetViewportForWindowID(SDL_GetWindowID(focused_window)) != NULL));
  629. #else
  630. SDL_Window* focused_window = bd->Window;
  631. 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
  632. #endif
  633. if (is_app_focused)
  634. {
  635. // (Optional) Set OS mouse position from Dear ImGui if requested (rarely used, only when io.ConfigNavMoveSetMousePos is enabled by user)
  636. if (io.WantSetMousePos)
  637. {
  638. #if SDL_HAS_CAPTURE_AND_GLOBAL_MOUSE
  639. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  640. SDL_WarpMouseGlobal((int)io.MousePos.x, (int)io.MousePos.y);
  641. else
  642. #endif
  643. SDL_WarpMouseInWindow(bd->Window, (int)io.MousePos.x, (int)io.MousePos.y);
  644. }
  645. // (Optional) Fallback to provide mouse position when focused (SDL_MOUSEMOTION already provides this when hovered or captured)
  646. if (bd->MouseCanUseGlobalState && bd->MouseButtonsDown == 0)
  647. {
  648. // 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)
  649. // 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)
  650. int mouse_x, mouse_y, window_x, window_y;
  651. SDL_GetGlobalMouseState(&mouse_x, &mouse_y);
  652. if (!(io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable))
  653. {
  654. SDL_GetWindowPosition(focused_window, &window_x, &window_y);
  655. mouse_x -= window_x;
  656. mouse_y -= window_y;
  657. }
  658. io.AddMousePosEvent((float)mouse_x, (float)mouse_y);
  659. }
  660. }
  661. // (Optional) When using multiple viewports: call io.AddMouseViewportEvent() with the viewport the OS mouse cursor is hovering.
  662. // If ImGuiBackendFlags_HasMouseHoveredViewport is not set by the backend, Dear imGui will ignore this field and infer the information using its flawed heuristic.
  663. // - [!] SDL backend does NOT correctly ignore viewports with the _NoInputs flag.
  664. // 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
  665. // 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
  666. // by the backend, and use its flawed heuristic to guess the viewport behind.
  667. // - [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).
  668. if (io.BackendFlags & ImGuiBackendFlags_HasMouseHoveredViewport)
  669. {
  670. ImGuiID mouse_viewport_id = 0;
  671. if (ImGuiViewport* mouse_viewport = ImGui_ImplSDL2_GetViewportForWindowID(bd->MouseWindowID))
  672. mouse_viewport_id = mouse_viewport->ID;
  673. io.AddMouseViewportEvent(mouse_viewport_id);
  674. }
  675. }
  676. static void ImGui_ImplSDL2_UpdateMouseCursor()
  677. {
  678. ImGuiIO& io = ImGui::GetIO();
  679. if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
  680. return;
  681. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  682. ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
  683. if (io.MouseDrawCursor || imgui_cursor == ImGuiMouseCursor_None)
  684. {
  685. // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
  686. SDL_ShowCursor(SDL_FALSE);
  687. }
  688. else
  689. {
  690. // Show OS mouse cursor
  691. SDL_Cursor* expected_cursor = bd->MouseCursors[imgui_cursor] ? bd->MouseCursors[imgui_cursor] : bd->MouseCursors[ImGuiMouseCursor_Arrow];
  692. if (bd->MouseLastCursor != expected_cursor)
  693. {
  694. SDL_SetCursor(expected_cursor); // SDL function doesn't have an early out (see #6113)
  695. bd->MouseLastCursor = expected_cursor;
  696. }
  697. SDL_ShowCursor(SDL_TRUE);
  698. }
  699. }
  700. static void ImGui_ImplSDL2_CloseGamepads()
  701. {
  702. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  703. if (bd->GamepadMode != ImGui_ImplSDL2_GamepadMode_Manual)
  704. for (SDL_GameController* gamepad : bd->Gamepads)
  705. SDL_GameControllerClose(gamepad);
  706. bd->Gamepads.resize(0);
  707. }
  708. void ImGui_ImplSDL2_SetGamepadMode(ImGui_ImplSDL2_GamepadMode mode, struct _SDL_GameController** manual_gamepads_array, int manual_gamepads_count)
  709. {
  710. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  711. ImGui_ImplSDL2_CloseGamepads();
  712. if (mode == ImGui_ImplSDL2_GamepadMode_Manual)
  713. {
  714. IM_ASSERT(manual_gamepads_array != nullptr || manual_gamepads_count <= 0);
  715. for (int n = 0; n < manual_gamepads_count; n++)
  716. bd->Gamepads.push_back(manual_gamepads_array[n]);
  717. }
  718. else
  719. {
  720. IM_ASSERT(manual_gamepads_array == nullptr && manual_gamepads_count <= 0);
  721. bd->WantUpdateGamepadsList = true;
  722. }
  723. bd->GamepadMode = mode;
  724. }
  725. static void ImGui_ImplSDL2_UpdateGamepadButton(ImGui_ImplSDL2_Data* bd, ImGuiIO& io, ImGuiKey key, SDL_GameControllerButton button_no)
  726. {
  727. bool merged_value = false;
  728. for (SDL_GameController* gamepad : bd->Gamepads)
  729. merged_value |= SDL_GameControllerGetButton(gamepad, button_no) != 0;
  730. io.AddKeyEvent(key, merged_value);
  731. }
  732. static inline float Saturate(float v) { return v < 0.0f ? 0.0f : v > 1.0f ? 1.0f : v; }
  733. static void ImGui_ImplSDL2_UpdateGamepadAnalog(ImGui_ImplSDL2_Data* bd, ImGuiIO& io, ImGuiKey key, SDL_GameControllerAxis axis_no, float v0, float v1)
  734. {
  735. float merged_value = 0.0f;
  736. for (SDL_GameController* gamepad : bd->Gamepads)
  737. {
  738. float vn = Saturate((float)(SDL_GameControllerGetAxis(gamepad, axis_no) - v0) / (float)(v1 - v0));
  739. if (merged_value < vn)
  740. merged_value = vn;
  741. }
  742. io.AddKeyAnalogEvent(key, merged_value > 0.1f, merged_value);
  743. }
  744. static void ImGui_ImplSDL2_UpdateGamepads()
  745. {
  746. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  747. ImGuiIO& io = ImGui::GetIO();
  748. // Update list of controller(s) to use
  749. if (bd->WantUpdateGamepadsList && bd->GamepadMode != ImGui_ImplSDL2_GamepadMode_Manual)
  750. {
  751. ImGui_ImplSDL2_CloseGamepads();
  752. int joystick_count = SDL_NumJoysticks();
  753. for (int n = 0; n < joystick_count; n++)
  754. if (SDL_IsGameController(n))
  755. if (SDL_GameController* gamepad = SDL_GameControllerOpen(n))
  756. {
  757. bd->Gamepads.push_back(gamepad);
  758. if (bd->GamepadMode == ImGui_ImplSDL2_GamepadMode_AutoFirst)
  759. break;
  760. }
  761. bd->WantUpdateGamepadsList = false;
  762. }
  763. // FIXME: Technically feeding gamepad shouldn't depend on this now that they are regular inputs.
  764. if ((io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) == 0)
  765. return;
  766. io.BackendFlags &= ~ImGuiBackendFlags_HasGamepad;
  767. if (bd->Gamepads.Size == 0)
  768. return;
  769. io.BackendFlags |= ImGuiBackendFlags_HasGamepad;
  770. // Update gamepad inputs
  771. const int thumb_dead_zone = 8000; // SDL_gamecontroller.h suggests using this value.
  772. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadStart, SDL_CONTROLLER_BUTTON_START);
  773. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadBack, SDL_CONTROLLER_BUTTON_BACK);
  774. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadFaceLeft, SDL_CONTROLLER_BUTTON_X); // Xbox X, PS Square
  775. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadFaceRight, SDL_CONTROLLER_BUTTON_B); // Xbox B, PS Circle
  776. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadFaceUp, SDL_CONTROLLER_BUTTON_Y); // Xbox Y, PS Triangle
  777. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadFaceDown, SDL_CONTROLLER_BUTTON_A); // Xbox A, PS Cross
  778. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadDpadLeft, SDL_CONTROLLER_BUTTON_DPAD_LEFT);
  779. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadDpadRight, SDL_CONTROLLER_BUTTON_DPAD_RIGHT);
  780. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadDpadUp, SDL_CONTROLLER_BUTTON_DPAD_UP);
  781. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadDpadDown, SDL_CONTROLLER_BUTTON_DPAD_DOWN);
  782. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadL1, SDL_CONTROLLER_BUTTON_LEFTSHOULDER);
  783. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadR1, SDL_CONTROLLER_BUTTON_RIGHTSHOULDER);
  784. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadL2, SDL_CONTROLLER_AXIS_TRIGGERLEFT, 0.0f, 32767);
  785. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadR2, SDL_CONTROLLER_AXIS_TRIGGERRIGHT, 0.0f, 32767);
  786. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadL3, SDL_CONTROLLER_BUTTON_LEFTSTICK);
  787. ImGui_ImplSDL2_UpdateGamepadButton(bd, io, ImGuiKey_GamepadR3, SDL_CONTROLLER_BUTTON_RIGHTSTICK);
  788. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadLStickLeft, SDL_CONTROLLER_AXIS_LEFTX, -thumb_dead_zone, -32768);
  789. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadLStickRight, SDL_CONTROLLER_AXIS_LEFTX, +thumb_dead_zone, +32767);
  790. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadLStickUp, SDL_CONTROLLER_AXIS_LEFTY, -thumb_dead_zone, -32768);
  791. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadLStickDown, SDL_CONTROLLER_AXIS_LEFTY, +thumb_dead_zone, +32767);
  792. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadRStickLeft, SDL_CONTROLLER_AXIS_RIGHTX, -thumb_dead_zone, -32768);
  793. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadRStickRight, SDL_CONTROLLER_AXIS_RIGHTX, +thumb_dead_zone, +32767);
  794. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadRStickUp, SDL_CONTROLLER_AXIS_RIGHTY, -thumb_dead_zone, -32768);
  795. ImGui_ImplSDL2_UpdateGamepadAnalog(bd, io, ImGuiKey_GamepadRStickDown, SDL_CONTROLLER_AXIS_RIGHTY, +thumb_dead_zone, +32767);
  796. }
  797. // FIXME: Note that doesn't update with DPI/Scaling change only as SDL2 doesn't have an event for it (SDL3 has).
  798. static void ImGui_ImplSDL2_UpdateMonitors()
  799. {
  800. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  801. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  802. platform_io.Monitors.resize(0);
  803. bd->WantUpdateMonitors = false;
  804. int display_count = SDL_GetNumVideoDisplays();
  805. for (int n = 0; n < display_count; n++)
  806. {
  807. // 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.
  808. ImGuiPlatformMonitor monitor;
  809. SDL_Rect r;
  810. SDL_GetDisplayBounds(n, &r);
  811. monitor.MainPos = monitor.WorkPos = ImVec2((float)r.x, (float)r.y);
  812. monitor.MainSize = monitor.WorkSize = ImVec2((float)r.w, (float)r.h);
  813. #if SDL_HAS_USABLE_DISPLAY_BOUNDS
  814. SDL_GetDisplayUsableBounds(n, &r);
  815. monitor.WorkPos = ImVec2((float)r.x, (float)r.y);
  816. monitor.WorkSize = ImVec2((float)r.w, (float)r.h);
  817. #endif
  818. #if SDL_HAS_PER_MONITOR_DPI
  819. // FIXME-VIEWPORT: On MacOS SDL reports actual monitor DPI scale, ignoring OS configuration. We may want to set
  820. // DpiScale to cocoa_window.backingScaleFactor here.
  821. float dpi = 0.0f;
  822. if (!SDL_GetDisplayDPI(n, &dpi, nullptr, nullptr))
  823. {
  824. if (dpi <= 0.0f)
  825. continue; // Some accessibility applications are declaring virtual monitors with a DPI of 0, see #7902.
  826. monitor.DpiScale = dpi / 96.0f;
  827. }
  828. #endif
  829. monitor.PlatformHandle = (void*)(intptr_t)n;
  830. platform_io.Monitors.push_back(monitor);
  831. }
  832. }
  833. void ImGui_ImplSDL2_NewFrame()
  834. {
  835. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  836. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplSDL2_Init()?");
  837. ImGuiIO& io = ImGui::GetIO();
  838. // Setup display size (every frame to accommodate for window resizing)
  839. int w, h;
  840. int display_w, display_h;
  841. SDL_GetWindowSize(bd->Window, &w, &h);
  842. if (SDL_GetWindowFlags(bd->Window) & SDL_WINDOW_MINIMIZED)
  843. w = h = 0;
  844. if (bd->Renderer != nullptr)
  845. SDL_GetRendererOutputSize(bd->Renderer, &display_w, &display_h);
  846. #if SDL_HAS_VULKAN
  847. else if (SDL_GetWindowFlags(bd->Window) & SDL_WINDOW_VULKAN)
  848. SDL_Vulkan_GetDrawableSize(bd->Window, &display_w, &display_h);
  849. #endif
  850. else
  851. SDL_GL_GetDrawableSize(bd->Window, &display_w, &display_h);
  852. io.DisplaySize = ImVec2((float)w, (float)h);
  853. if (w > 0 && h > 0)
  854. io.DisplayFramebufferScale = ImVec2((float)display_w / w, (float)display_h / h);
  855. // Update monitors
  856. if (bd->WantUpdateMonitors)
  857. ImGui_ImplSDL2_UpdateMonitors();
  858. // Setup time step (we don't use SDL_GetTicks() because it is using millisecond resolution)
  859. // (Accept SDL_GetPerformanceCounter() not returning a monotonically increasing value. Happens in VMs and Emscripten, see #6189, #6114, #3644)
  860. static Uint64 frequency = SDL_GetPerformanceFrequency();
  861. Uint64 current_time = SDL_GetPerformanceCounter();
  862. if (current_time <= bd->Time)
  863. current_time = bd->Time + 1;
  864. io.DeltaTime = bd->Time > 0 ? (float)((double)(current_time - bd->Time) / frequency) : (float)(1.0f / 60.0f);
  865. bd->Time = current_time;
  866. if (bd->MouseLastLeaveFrame && bd->MouseLastLeaveFrame >= ImGui::GetFrameCount() && bd->MouseButtonsDown == 0)
  867. {
  868. bd->MouseWindowID = 0;
  869. bd->MouseLastLeaveFrame = 0;
  870. io.AddMousePosEvent(-FLT_MAX, -FLT_MAX);
  871. }
  872. // Our io.AddMouseViewportEvent() calls will only be valid when not capturing.
  873. // Technically speaking testing for 'bd->MouseButtonsDown == 0' would be more rigorous, but testing for payload reduces noise and potential side-effects.
  874. if (bd->MouseCanReportHoveredViewport && ImGui::GetDragDropPayload() == nullptr)
  875. io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport;
  876. else
  877. io.BackendFlags &= ~ImGuiBackendFlags_HasMouseHoveredViewport;
  878. ImGui_ImplSDL2_UpdateMouseData();
  879. ImGui_ImplSDL2_UpdateMouseCursor();
  880. // Update game controllers (if enabled and available)
  881. ImGui_ImplSDL2_UpdateGamepads();
  882. }
  883. //--------------------------------------------------------------------------------------------------------
  884. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  885. // This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports simultaneously.
  886. // 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..
  887. //--------------------------------------------------------------------------------------------------------
  888. // Helper structure we store in the void* RendererUserData field of each ImGuiViewport to easily retrieve our backend data.
  889. struct ImGui_ImplSDL2_ViewportData
  890. {
  891. SDL_Window* Window;
  892. Uint32 WindowID;
  893. bool WindowOwned;
  894. SDL_GLContext GLContext;
  895. ImGui_ImplSDL2_ViewportData() { Window = nullptr; WindowID = 0; WindowOwned = false; GLContext = nullptr; }
  896. ~ImGui_ImplSDL2_ViewportData() { IM_ASSERT(Window == nullptr && GLContext == nullptr); }
  897. };
  898. static void ImGui_ImplSDL2_CreateWindow(ImGuiViewport* viewport)
  899. {
  900. ImGui_ImplSDL2_Data* bd = ImGui_ImplSDL2_GetBackendData();
  901. ImGui_ImplSDL2_ViewportData* vd = IM_NEW(ImGui_ImplSDL2_ViewportData)();
  902. viewport->PlatformUserData = vd;
  903. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  904. ImGui_ImplSDL2_ViewportData* main_viewport_data = (ImGui_ImplSDL2_ViewportData*)main_viewport->PlatformUserData;
  905. // Share GL resources with main context
  906. bool use_opengl = (main_viewport_data->GLContext != nullptr);
  907. SDL_GLContext backup_context = nullptr;
  908. if (use_opengl)
  909. {
  910. backup_context = SDL_GL_GetCurrentContext();
  911. SDL_GL_SetAttribute(SDL_GL_SHARE_WITH_CURRENT_CONTEXT, 1);
  912. SDL_GL_MakeCurrent(main_viewport_data->Window, main_viewport_data->GLContext);
  913. }
  914. Uint32 sdl_flags = 0;
  915. sdl_flags |= use_opengl ? SDL_WINDOW_OPENGL : (bd->UseVulkan ? SDL_WINDOW_VULKAN : 0);
  916. sdl_flags |= SDL_GetWindowFlags(bd->Window) & SDL_WINDOW_ALLOW_HIGHDPI;
  917. sdl_flags |= SDL_WINDOW_HIDDEN;
  918. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_NoDecoration) ? SDL_WINDOW_BORDERLESS : 0;
  919. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_NoDecoration) ? 0 : SDL_WINDOW_RESIZABLE;
  920. #if !defined(_WIN32)
  921. // See SDL hack in ImGui_ImplSDL2_ShowWindow().
  922. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_NoTaskBarIcon) ? SDL_WINDOW_SKIP_TASKBAR : 0;
  923. #endif
  924. #if SDL_HAS_ALWAYS_ON_TOP
  925. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_TopMost) ? SDL_WINDOW_ALWAYS_ON_TOP : 0;
  926. #endif
  927. vd->Window = SDL_CreateWindow("No Title Yet", (int)viewport->Pos.x, (int)viewport->Pos.y, (int)viewport->Size.x, (int)viewport->Size.y, sdl_flags);
  928. vd->WindowOwned = true;
  929. if (use_opengl)
  930. {
  931. vd->GLContext = SDL_GL_CreateContext(vd->Window);
  932. SDL_GL_SetSwapInterval(0);
  933. }
  934. if (use_opengl && backup_context)
  935. SDL_GL_MakeCurrent(vd->Window, backup_context);
  936. viewport->PlatformHandle = (void*)(intptr_t)SDL_GetWindowID(vd->Window);
  937. viewport->PlatformHandleRaw = nullptr;
  938. SDL_SysWMinfo info;
  939. SDL_VERSION(&info.version);
  940. if (SDL_GetWindowWMInfo(vd->Window, &info))
  941. {
  942. #if defined(SDL_VIDEO_DRIVER_WINDOWS)
  943. viewport->PlatformHandleRaw = info.info.win.window;
  944. #elif defined(__APPLE__) && defined(SDL_VIDEO_DRIVER_COCOA)
  945. viewport->PlatformHandleRaw = (void*)info.info.cocoa.window;
  946. #endif
  947. }
  948. }
  949. static void ImGui_ImplSDL2_DestroyWindow(ImGuiViewport* viewport)
  950. {
  951. if (ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData)
  952. {
  953. if (vd->GLContext && vd->WindowOwned)
  954. SDL_GL_DeleteContext(vd->GLContext);
  955. if (vd->Window && vd->WindowOwned)
  956. SDL_DestroyWindow(vd->Window);
  957. vd->GLContext = nullptr;
  958. vd->Window = nullptr;
  959. IM_DELETE(vd);
  960. }
  961. viewport->PlatformUserData = viewport->PlatformHandle = nullptr;
  962. }
  963. static void ImGui_ImplSDL2_ShowWindow(ImGuiViewport* viewport)
  964. {
  965. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  966. #if defined(_WIN32) && !(defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_APP || WINAPI_FAMILY == WINAPI_FAMILY_GAMES))
  967. HWND hwnd = (HWND)viewport->PlatformHandleRaw;
  968. // SDL hack: Hide icon from task bar
  969. // Note: SDL 2.0.6+ has a SDL_WINDOW_SKIP_TASKBAR flag which is supported under Windows but the way it create the window breaks our seamless transition.
  970. if (viewport->Flags & ImGuiViewportFlags_NoTaskBarIcon)
  971. {
  972. LONG ex_style = ::GetWindowLong(hwnd, GWL_EXSTYLE);
  973. ex_style &= ~WS_EX_APPWINDOW;
  974. ex_style |= WS_EX_TOOLWINDOW;
  975. ::SetWindowLong(hwnd, GWL_EXSTYLE, ex_style);
  976. }
  977. #endif
  978. #if SDL_HAS_SHOW_WINDOW_ACTIVATION_HINT
  979. SDL_SetHint(SDL_HINT_WINDOW_NO_ACTIVATION_WHEN_SHOWN, (viewport->Flags & ImGuiViewportFlags_NoFocusOnAppearing) ? "1" : "0");
  980. #elif defined(_WIN32)
  981. // SDL hack: SDL always activate/focus windows :/
  982. if (viewport->Flags & ImGuiViewportFlags_NoFocusOnAppearing)
  983. {
  984. ::ShowWindow(hwnd, SW_SHOWNA);
  985. return;
  986. }
  987. #endif
  988. SDL_ShowWindow(vd->Window);
  989. }
  990. static ImVec2 ImGui_ImplSDL2_GetWindowPos(ImGuiViewport* viewport)
  991. {
  992. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  993. int x = 0, y = 0;
  994. SDL_GetWindowPosition(vd->Window, &x, &y);
  995. return ImVec2((float)x, (float)y);
  996. }
  997. static void ImGui_ImplSDL2_SetWindowPos(ImGuiViewport* viewport, ImVec2 pos)
  998. {
  999. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1000. SDL_SetWindowPosition(vd->Window, (int)pos.x, (int)pos.y);
  1001. }
  1002. static ImVec2 ImGui_ImplSDL2_GetWindowSize(ImGuiViewport* viewport)
  1003. {
  1004. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1005. int w = 0, h = 0;
  1006. SDL_GetWindowSize(vd->Window, &w, &h);
  1007. return ImVec2((float)w, (float)h);
  1008. }
  1009. static void ImGui_ImplSDL2_SetWindowSize(ImGuiViewport* viewport, ImVec2 size)
  1010. {
  1011. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1012. SDL_SetWindowSize(vd->Window, (int)size.x, (int)size.y);
  1013. }
  1014. static void ImGui_ImplSDL2_SetWindowTitle(ImGuiViewport* viewport, const char* title)
  1015. {
  1016. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1017. SDL_SetWindowTitle(vd->Window, title);
  1018. }
  1019. #if SDL_HAS_WINDOW_ALPHA
  1020. static void ImGui_ImplSDL2_SetWindowAlpha(ImGuiViewport* viewport, float alpha)
  1021. {
  1022. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1023. SDL_SetWindowOpacity(vd->Window, alpha);
  1024. }
  1025. #endif
  1026. static void ImGui_ImplSDL2_SetWindowFocus(ImGuiViewport* viewport)
  1027. {
  1028. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1029. SDL_RaiseWindow(vd->Window);
  1030. }
  1031. static bool ImGui_ImplSDL2_GetWindowFocus(ImGuiViewport* viewport)
  1032. {
  1033. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1034. return (SDL_GetWindowFlags(vd->Window) & SDL_WINDOW_INPUT_FOCUS) != 0;
  1035. }
  1036. static bool ImGui_ImplSDL2_GetWindowMinimized(ImGuiViewport* viewport)
  1037. {
  1038. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1039. return (SDL_GetWindowFlags(vd->Window) & SDL_WINDOW_MINIMIZED) != 0;
  1040. }
  1041. static void ImGui_ImplSDL2_RenderWindow(ImGuiViewport* viewport, void*)
  1042. {
  1043. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1044. if (vd->GLContext)
  1045. SDL_GL_MakeCurrent(vd->Window, vd->GLContext);
  1046. }
  1047. static void ImGui_ImplSDL2_SwapBuffers(ImGuiViewport* viewport, void*)
  1048. {
  1049. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1050. if (vd->GLContext)
  1051. {
  1052. SDL_GL_MakeCurrent(vd->Window, vd->GLContext);
  1053. SDL_GL_SwapWindow(vd->Window);
  1054. }
  1055. }
  1056. // Vulkan support (the Vulkan renderer needs to call a platform-side support function to create the surface)
  1057. // SDL is graceful enough to _not_ need <vulkan/vulkan.h> so we can safely include this.
  1058. #if SDL_HAS_VULKAN
  1059. #include <SDL_vulkan.h>
  1060. static int ImGui_ImplSDL2_CreateVkSurface(ImGuiViewport* viewport, ImU64 vk_instance, const void* vk_allocator, ImU64* out_vk_surface)
  1061. {
  1062. ImGui_ImplSDL2_ViewportData* vd = (ImGui_ImplSDL2_ViewportData*)viewport->PlatformUserData;
  1063. (void)vk_allocator;
  1064. SDL_bool ret = SDL_Vulkan_CreateSurface(vd->Window, (VkInstance)vk_instance, (VkSurfaceKHR*)out_vk_surface);
  1065. return ret ? 0 : 1; // ret ? VK_SUCCESS : VK_NOT_READY
  1066. }
  1067. #endif // SDL_HAS_VULKAN
  1068. static void ImGui_ImplSDL2_InitMultiViewportSupport(SDL_Window* window, void* sdl_gl_context)
  1069. {
  1070. // Register platform interface (will be coupled with a renderer interface)
  1071. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  1072. platform_io.Platform_CreateWindow = ImGui_ImplSDL2_CreateWindow;
  1073. platform_io.Platform_DestroyWindow = ImGui_ImplSDL2_DestroyWindow;
  1074. platform_io.Platform_ShowWindow = ImGui_ImplSDL2_ShowWindow;
  1075. platform_io.Platform_SetWindowPos = ImGui_ImplSDL2_SetWindowPos;
  1076. platform_io.Platform_GetWindowPos = ImGui_ImplSDL2_GetWindowPos;
  1077. platform_io.Platform_SetWindowSize = ImGui_ImplSDL2_SetWindowSize;
  1078. platform_io.Platform_GetWindowSize = ImGui_ImplSDL2_GetWindowSize;
  1079. platform_io.Platform_SetWindowFocus = ImGui_ImplSDL2_SetWindowFocus;
  1080. platform_io.Platform_GetWindowFocus = ImGui_ImplSDL2_GetWindowFocus;
  1081. platform_io.Platform_GetWindowMinimized = ImGui_ImplSDL2_GetWindowMinimized;
  1082. platform_io.Platform_SetWindowTitle = ImGui_ImplSDL2_SetWindowTitle;
  1083. platform_io.Platform_RenderWindow = ImGui_ImplSDL2_RenderWindow;
  1084. platform_io.Platform_SwapBuffers = ImGui_ImplSDL2_SwapBuffers;
  1085. #if SDL_HAS_WINDOW_ALPHA
  1086. platform_io.Platform_SetWindowAlpha = ImGui_ImplSDL2_SetWindowAlpha;
  1087. #endif
  1088. #if SDL_HAS_VULKAN
  1089. platform_io.Platform_CreateVkSurface = ImGui_ImplSDL2_CreateVkSurface;
  1090. #endif
  1091. // Register main window handle (which is owned by the main application, not by us)
  1092. // 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.
  1093. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  1094. ImGui_ImplSDL2_ViewportData* vd = IM_NEW(ImGui_ImplSDL2_ViewportData)();
  1095. vd->Window = window;
  1096. vd->WindowID = SDL_GetWindowID(window);
  1097. vd->WindowOwned = false;
  1098. vd->GLContext = sdl_gl_context;
  1099. main_viewport->PlatformUserData = vd;
  1100. main_viewport->PlatformHandle = (void*)(intptr_t)vd->WindowID;
  1101. }
  1102. static void ImGui_ImplSDL2_ShutdownMultiViewportSupport()
  1103. {
  1104. ImGui::DestroyPlatformWindows();
  1105. }
  1106. //-----------------------------------------------------------------------------
  1107. #if defined(__clang__)
  1108. #pragma clang diagnostic pop
  1109. #endif
  1110. #endif // #ifndef IMGUI_DISABLE