imgui_impl_sdl.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574
  1. // ImGui Platform Binding 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. // Implemented features:
  5. // [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  6. // [X] Platform: Clipboard support.
  7. // [X] Platform: Keyboard arrays indexed using SDL_SCANCODE_* codes, e.g. ImGui::IsKeyPressed(SDL_SCANCODE_SPACE).
  8. // [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  9. // Missing features:
  10. // [ ] Platform: SDL2 handling of IME under Windows appears to be broken and it explicitly disable the regular Windows IME. You can restore Windows IME by compiling SDL with SDL_DISABLE_WINDOWS_IME.
  11. // You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
  12. // If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
  13. // If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
  14. // https://github.com/ocornut/imgui
  15. // CHANGELOG
  16. // (minor and older changes stripped away, please see git history for details)
  17. // 2018-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  18. // 2018-06-29: Inputs: Added support for the ImGuiMouseCursor_Hand cursor.
  19. // 2018-06-08: Misc: Extracted imgui_impl_sdl.cpp/.h away from the old combined SDL2+OpenGL/Vulkan examples.
  20. // 2018-06-08: Misc: ImGui_ImplSDL2_InitForOpenGL() now takes a SDL_GLContext parameter.
  21. // 2018-05-09: Misc: Fixed clipboard paste memory leak (we didn't call SDL_FreeMemory on the data returned by SDL_GetClipboardText).
  22. // 2018-03-20: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors flag + honor ImGuiConfigFlags_NoMouseCursorChange flag.
  23. // 2018-02-16: Inputs: Added support for mouse cursors, honoring ImGui::GetMouseCursor() value.
  24. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  25. // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
  26. // 2018-02-05: Misc: Using SDL_GetPerformanceCounter() instead of SDL_GetTicks() to be able to handle very high framerate (1000+ FPS).
  27. // 2018-02-05: Inputs: Keyboard mapping is using scancodes everywhere instead of a confusing mixture of keycodes and scancodes.
  28. // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
  29. // 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.
  30. // 2018-01-18: Inputs: Added mapping for ImGuiKey_Insert.
  31. // 2017-08-25: Inputs: MousePos set to -FLT_MAX,-FLT_MAX when mouse is unavailable/missing (instead of -1,-1).
  32. // 2016-10-15: Misc: Added a void* user_data parameter to Clipboard function handlers.
  33. #include "imgui.h"
  34. #include "imgui_impl_sdl.h"
  35. // SDL
  36. // (the multi-viewports feature requires SDL features supported from SDL 2.0.5+)
  37. #include <SDL.h>
  38. #include <SDL_syswm.h>
  39. #define SDL_HAS_WARP_MOUSE_GLOBAL SDL_VERSION_ATLEAST(2,0,4)
  40. #define SDL_HAS_CAPTURE_MOUSE SDL_VERSION_ATLEAST(2,0,4)
  41. #define SDL_HAS_WINDOW_OPACITY SDL_VERSION_ATLEAST(2,0,5)
  42. #define SDL_HAS_ALWAYS_ON_TOP SDL_VERSION_ATLEAST(2,0,5)
  43. #define SDL_HAS_USABLE_DISPLAY_BOUNDS SDL_VERSION_ATLEAST(2,0,5)
  44. #define SDL_HAS_PER_MONITOR_DPI SDL_VERSION_ATLEAST(2,0,4)
  45. #define SDL_HAS_VULKAN SDL_VERSION_ATLEAST(2,0,6)
  46. #define SDL_HAS_MOUSE_FOCUS_CLICKTHROUGH SDL_VERSION_ATLEAST(2,0,5)
  47. #if !SDL_HAS_VULKAN
  48. static const Uint32 SDL_WINDOW_VULKAN = 0x10000000;
  49. #endif
  50. // Data
  51. static SDL_Window* g_Window = NULL;
  52. static Uint64 g_Time = 0;
  53. static bool g_MousePressed[3] = { false, false, false };
  54. static SDL_Cursor* g_MouseCursors[ImGuiMouseCursor_COUNT] = { 0 };
  55. static char* g_ClipboardTextData = NULL;
  56. // Forward Declarations
  57. static void ImGui_ImplSDL2_InitPlatformInterface(SDL_Window* window, void* sdl_gl_context);
  58. static void ImGui_ImplSDL2_ShutdownPlatformInterface();
  59. static const char* ImGui_ImplSDL2_GetClipboardText(void*)
  60. {
  61. if (g_ClipboardTextData)
  62. SDL_free(g_ClipboardTextData);
  63. g_ClipboardTextData = SDL_GetClipboardText();
  64. return g_ClipboardTextData;
  65. }
  66. static void ImGui_ImplSDL2_SetClipboardText(void*, const char* text)
  67. {
  68. SDL_SetClipboardText(text);
  69. }
  70. // You can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if dear imgui wants to use your inputs.
  71. // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application.
  72. // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application.
  73. // Generally you may always pass all inputs to dear imgui, and hide them from your application based on those two flags.
  74. bool ImGui_ImplSDL2_ProcessEvent(SDL_Event* event)
  75. {
  76. ImGuiIO& io = ImGui::GetIO();
  77. switch (event->type)
  78. {
  79. case SDL_MOUSEWHEEL:
  80. {
  81. if (event->wheel.x > 0) io.MouseWheelH += 1;
  82. if (event->wheel.x < 0) io.MouseWheelH -= 1;
  83. if (event->wheel.y > 0) io.MouseWheel += 1;
  84. if (event->wheel.y < 0) io.MouseWheel -= 1;
  85. return true;
  86. }
  87. case SDL_MOUSEBUTTONDOWN:
  88. {
  89. if (event->button.button == SDL_BUTTON_LEFT) g_MousePressed[0] = true;
  90. if (event->button.button == SDL_BUTTON_RIGHT) g_MousePressed[1] = true;
  91. if (event->button.button == SDL_BUTTON_MIDDLE) g_MousePressed[2] = true;
  92. return true;
  93. }
  94. case SDL_TEXTINPUT:
  95. {
  96. io.AddInputCharactersUTF8(event->text.text);
  97. return true;
  98. }
  99. case SDL_KEYDOWN:
  100. case SDL_KEYUP:
  101. {
  102. int key = event->key.keysym.scancode;
  103. IM_ASSERT(key >= 0 && key < IM_ARRAYSIZE(io.KeysDown));
  104. io.KeysDown[key] = (event->type == SDL_KEYDOWN);
  105. io.KeyShift = ((SDL_GetModState() & KMOD_SHIFT) != 0);
  106. io.KeyCtrl = ((SDL_GetModState() & KMOD_CTRL) != 0);
  107. io.KeyAlt = ((SDL_GetModState() & KMOD_ALT) != 0);
  108. io.KeySuper = ((SDL_GetModState() & KMOD_GUI) != 0);
  109. return true;
  110. }
  111. // Multi-viewport support
  112. case SDL_WINDOWEVENT:
  113. Uint8 window_event = event->window.event;
  114. if (window_event == SDL_WINDOWEVENT_CLOSE || window_event == SDL_WINDOWEVENT_MOVED || window_event == SDL_WINDOWEVENT_RESIZED)
  115. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle((void*)SDL_GetWindowFromID(event->window.windowID)))
  116. {
  117. if (window_event == SDL_WINDOWEVENT_CLOSE)
  118. viewport->PlatformRequestClose = true;
  119. if (window_event == SDL_WINDOWEVENT_MOVED)
  120. viewport->PlatformRequestMove = true;
  121. if (window_event == SDL_WINDOWEVENT_RESIZED)
  122. viewport->PlatformRequestResize = true;
  123. return true;
  124. }
  125. break;
  126. }
  127. return false;
  128. }
  129. static bool ImGui_ImplSDL2_Init(SDL_Window* window, void* sdl_gl_context)
  130. {
  131. g_Window = window;
  132. // Setup back-end capabilities flags
  133. ImGuiIO& io = ImGui::GetIO();
  134. io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
  135. #if SDL_HAS_WARP_MOUSE_GLOBAL
  136. io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
  137. #endif
  138. #if SDL_HAS_CAPTURE_MOUSE
  139. io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports; // We can create multi-viewports on the Platform side (optional)
  140. #endif
  141. // Keyboard mapping. ImGui will use those indices to peek into the io.KeysDown[] array.
  142. io.KeyMap[ImGuiKey_Tab] = SDL_SCANCODE_TAB;
  143. io.KeyMap[ImGuiKey_LeftArrow] = SDL_SCANCODE_LEFT;
  144. io.KeyMap[ImGuiKey_RightArrow] = SDL_SCANCODE_RIGHT;
  145. io.KeyMap[ImGuiKey_UpArrow] = SDL_SCANCODE_UP;
  146. io.KeyMap[ImGuiKey_DownArrow] = SDL_SCANCODE_DOWN;
  147. io.KeyMap[ImGuiKey_PageUp] = SDL_SCANCODE_PAGEUP;
  148. io.KeyMap[ImGuiKey_PageDown] = SDL_SCANCODE_PAGEDOWN;
  149. io.KeyMap[ImGuiKey_Home] = SDL_SCANCODE_HOME;
  150. io.KeyMap[ImGuiKey_End] = SDL_SCANCODE_END;
  151. io.KeyMap[ImGuiKey_Insert] = SDL_SCANCODE_INSERT;
  152. io.KeyMap[ImGuiKey_Delete] = SDL_SCANCODE_DELETE;
  153. io.KeyMap[ImGuiKey_Backspace] = SDL_SCANCODE_BACKSPACE;
  154. io.KeyMap[ImGuiKey_Space] = SDL_SCANCODE_SPACE;
  155. io.KeyMap[ImGuiKey_Enter] = SDL_SCANCODE_RETURN;
  156. io.KeyMap[ImGuiKey_Escape] = SDL_SCANCODE_ESCAPE;
  157. io.KeyMap[ImGuiKey_A] = SDL_SCANCODE_A;
  158. io.KeyMap[ImGuiKey_C] = SDL_SCANCODE_C;
  159. io.KeyMap[ImGuiKey_V] = SDL_SCANCODE_V;
  160. io.KeyMap[ImGuiKey_X] = SDL_SCANCODE_X;
  161. io.KeyMap[ImGuiKey_Y] = SDL_SCANCODE_Y;
  162. io.KeyMap[ImGuiKey_Z] = SDL_SCANCODE_Z;
  163. io.SetClipboardTextFn = ImGui_ImplSDL2_SetClipboardText;
  164. io.GetClipboardTextFn = ImGui_ImplSDL2_GetClipboardText;
  165. io.ClipboardUserData = NULL;
  166. g_MouseCursors[ImGuiMouseCursor_Arrow] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_ARROW);
  167. g_MouseCursors[ImGuiMouseCursor_TextInput] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_IBEAM);
  168. g_MouseCursors[ImGuiMouseCursor_ResizeAll] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZEALL);
  169. g_MouseCursors[ImGuiMouseCursor_ResizeNS] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZENS);
  170. g_MouseCursors[ImGuiMouseCursor_ResizeEW] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZEWE);
  171. g_MouseCursors[ImGuiMouseCursor_ResizeNESW] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZENESW);
  172. g_MouseCursors[ImGuiMouseCursor_ResizeNWSE] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_SIZENWSE);
  173. g_MouseCursors[ImGuiMouseCursor_Hand] = SDL_CreateSystemCursor(SDL_SYSTEM_CURSOR_HAND);
  174. // Our mouse update function expect PlatformHandle to be filled for the main viewport
  175. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  176. main_viewport->PlatformHandle = (void*)window;
  177. // We need SDL_CaptureMouse(), SDL_GetGlobalMouseState() from SDL 2.0.4+ to support multiple viewports.
  178. // We left the call to ImGui_ImplSDL2_InitPlatformInterface() outside of #ifdef to avoid unused-function warnings.
  179. if ((io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable) && (io.BackendFlags & ImGuiBackendFlags_PlatformHasViewports))
  180. ImGui_ImplSDL2_InitPlatformInterface(window, sdl_gl_context);
  181. return true;
  182. }
  183. bool ImGui_ImplSDL2_InitForOpenGL(SDL_Window* window, void* sdl_gl_context)
  184. {
  185. (void)sdl_gl_context; // Viewport branch will need this.
  186. return ImGui_ImplSDL2_Init(window, sdl_gl_context);
  187. }
  188. bool ImGui_ImplSDL2_InitForVulkan(SDL_Window* window)
  189. {
  190. #if !SDL_HAS_VULKAN
  191. IM_ASSERT(0 && "Unsupported");
  192. #endif
  193. return ImGui_ImplSDL2_Init(window, NULL);
  194. }
  195. void ImGui_ImplSDL2_Shutdown()
  196. {
  197. ImGui_ImplSDL2_ShutdownPlatformInterface();
  198. g_Window = NULL;
  199. // Destroy last known clipboard data
  200. if (g_ClipboardTextData)
  201. SDL_free(g_ClipboardTextData);
  202. g_ClipboardTextData = NULL;
  203. // Destroy SDL mouse cursors
  204. for (ImGuiMouseCursor cursor_n = 0; cursor_n < ImGuiMouseCursor_COUNT; cursor_n++)
  205. SDL_FreeCursor(g_MouseCursors[cursor_n]);
  206. memset(g_MouseCursors, 0, sizeof(g_MouseCursors));
  207. }
  208. static void ImGui_ImplSDL2_UpdateMousePosAndButtons()
  209. {
  210. ImGuiIO& io = ImGui::GetIO();
  211. const ImVec2 mouse_pos_backup = io.MousePos;
  212. io.MousePos = ImVec2(-FLT_MAX, -FLT_MAX);
  213. io.MousePosViewport = 0;
  214. io.MouseHoveredViewport = 0;
  215. // Set OS mouse position if requested (rarely used, only when ImGuiConfigFlags_NavEnableSetMousePos is enabled by user)
  216. // (When multi-viewports are enabled, all imgui positions are same as OS positions.)
  217. #if SDL_HAS_WARP_MOUSE_GLOBAL
  218. if (io.WantSetMousePos)
  219. {
  220. if ((io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable) == 0)
  221. SDL_WarpMouseInWindow(g_Window, (int)mouse_pos_backup.x, (int)mouse_pos_backup.y);
  222. else
  223. SDL_WarpMouseGlobal((int)mouse_pos_backup.x, (int)mouse_pos_backup.y);
  224. }
  225. #endif
  226. int mx, my;
  227. Uint32 mouse_buttons = SDL_GetMouseState(&mx, &my);
  228. io.MouseDown[0] = g_MousePressed[0] || (mouse_buttons & SDL_BUTTON(SDL_BUTTON_LEFT)) != 0; // If a mouse press event came, always pass it as "mouse held this frame", so we don't miss click-release events that are shorter than 1 frame.
  229. io.MouseDown[1] = g_MousePressed[1] || (mouse_buttons & SDL_BUTTON(SDL_BUTTON_RIGHT)) != 0;
  230. io.MouseDown[2] = g_MousePressed[2] || (mouse_buttons & SDL_BUTTON(SDL_BUTTON_MIDDLE)) != 0;
  231. g_MousePressed[0] = g_MousePressed[1] = g_MousePressed[2] = false;
  232. #if SDL_HAS_CAPTURE_MOUSE
  233. SDL_Window* focused_window = SDL_GetKeyboardFocus();
  234. if (focused_window)
  235. {
  236. // SDL_GetMouseState() gives mouse position seemingly based on the last window entered/focused(?)
  237. // The creation of new windows at runtime and SDL_CaptureMouse both seems to severely mess up with that, so we retrieve that position globally.
  238. int wx, wy;
  239. SDL_GetWindowPosition(focused_window, &wx, &wy);
  240. SDL_GetGlobalMouseState(&mx, &my);
  241. mx -= wx;
  242. my -= wy;
  243. }
  244. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle((void*)focused_window))
  245. {
  246. io.MousePos = ImVec2(viewport->Pos.x + (float)mx, viewport->Pos.y + (float)my);
  247. io.MousePosViewport = viewport->ID;
  248. }
  249. // We already retrieve global mouse position, SDL_CaptureMouse() also let the OS know e.g. that our imgui drag outside the SDL window boundaries shouldn't trigger the OS window resize cursor
  250. // The function is only supported from SDL 2.0.4 (released Jan 2016)
  251. bool any_mouse_button_down = ImGui::IsAnyMouseDown();
  252. SDL_CaptureMouse(any_mouse_button_down ? SDL_TRUE : SDL_FALSE);
  253. #else
  254. if (SDL_GetWindowFlags(g_Window) & SDL_WINDOW_INPUT_FOCUS)
  255. io.MousePos = ImVec2((float)mx, (float)my);
  256. #endif
  257. }
  258. static void ImGui_ImplSDL2_UpdateMouseCursor()
  259. {
  260. ImGuiIO& io = ImGui::GetIO();
  261. if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
  262. return;
  263. ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
  264. if (io.MouseDrawCursor || imgui_cursor == ImGuiMouseCursor_None)
  265. {
  266. // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
  267. SDL_ShowCursor(SDL_FALSE);
  268. }
  269. else
  270. {
  271. // Show OS mouse cursor
  272. SDL_SetCursor(g_MouseCursors[imgui_cursor] ? g_MouseCursors[imgui_cursor] : g_MouseCursors[ImGuiMouseCursor_Arrow]);
  273. SDL_ShowCursor(SDL_TRUE);
  274. }
  275. }
  276. void ImGui_ImplSDL2_NewFrame(SDL_Window* window)
  277. {
  278. ImGuiIO& io = ImGui::GetIO();
  279. IM_ASSERT(io.Fonts->IsBuilt()); // Font atlas needs to be built, call renderer _NewFrame() function e.g. ImGui_ImplOpenGL3_NewFrame()
  280. // Setup display size (every frame to accommodate for window resizing)
  281. int w, h;
  282. int display_w, display_h;
  283. SDL_GetWindowSize(window, &w, &h);
  284. SDL_GL_GetDrawableSize(window, &display_w, &display_h);
  285. io.DisplaySize = ImVec2((float)w, (float)h);
  286. io.DisplayFramebufferScale = ImVec2(w > 0 ? ((float)display_w / w) : 0, h > 0 ? ((float)display_h / h) : 0);
  287. // Setup time step (we don't use SDL_GetTicks() because it is using millisecond resolution)
  288. static Uint64 frequency = SDL_GetPerformanceFrequency();
  289. Uint64 current_time = SDL_GetPerformanceCounter();
  290. io.DeltaTime = g_Time > 0 ? (float)((double)(current_time - g_Time) / frequency) : (float)(1.0f / 60.0f);
  291. g_Time = current_time;
  292. ImGui_ImplSDL2_UpdateMousePosAndButtons();
  293. ImGui_ImplSDL2_UpdateMouseCursor();
  294. }
  295. //--------------------------------------------------------------------------------------------------------
  296. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  297. // This is an _advanced_ and _optional_ feature, allowing the back-end to create and handle multiple viewports simultaneously.
  298. // 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..
  299. //--------------------------------------------------------------------------------------------------------
  300. struct ImGuiViewportDataSDL2
  301. {
  302. SDL_Window* Window;
  303. Uint32 WindowID;
  304. bool WindowOwned;
  305. SDL_GLContext GLContext;
  306. ImGuiViewportDataSDL2() { Window = NULL; WindowID = 0; WindowOwned = false; GLContext = NULL; }
  307. ~ImGuiViewportDataSDL2() { IM_ASSERT(Window == NULL && GLContext == NULL); }
  308. };
  309. static void ImGui_ImplSDL2_CreateWindow(ImGuiViewport* viewport)
  310. {
  311. ImGuiViewportDataSDL2* data = IM_NEW(ImGuiViewportDataSDL2)();
  312. viewport->PlatformUserData = data;
  313. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  314. ImGuiViewportDataSDL2* main_viewport_data = (ImGuiViewportDataSDL2*)main_viewport->PlatformUserData;
  315. // Share GL resources with main context
  316. bool use_opengl = (main_viewport_data->GLContext != NULL);
  317. SDL_GLContext backup_context = NULL;
  318. if (use_opengl)
  319. {
  320. backup_context = SDL_GL_GetCurrentContext();
  321. SDL_GL_SetAttribute(SDL_GL_SHARE_WITH_CURRENT_CONTEXT, 1);
  322. SDL_GL_MakeCurrent(main_viewport_data->Window, main_viewport_data->GLContext);
  323. }
  324. // We don't enable SDL_WINDOW_RESIZABLE because it enforce windows decorations
  325. Uint32 sdl_flags = 0;
  326. sdl_flags |= use_opengl ? SDL_WINDOW_OPENGL : SDL_WINDOW_VULKAN;
  327. sdl_flags |= SDL_WINDOW_HIDDEN;
  328. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_NoDecoration) ? SDL_WINDOW_BORDERLESS : 0;
  329. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_NoDecoration) ? 0 : SDL_WINDOW_RESIZABLE;
  330. #if SDL_HAS_ALWAYS_ON_TOP
  331. sdl_flags |= (viewport->Flags & ImGuiViewportFlags_TopMost) ? SDL_WINDOW_ALWAYS_ON_TOP : 0;
  332. #endif
  333. data->Window = SDL_CreateWindow("No Title Yet", (int)viewport->Pos.x, (int)viewport->Pos.y, (int)viewport->Size.x, (int)viewport->Size.y, sdl_flags);
  334. data->WindowOwned = true;
  335. if (use_opengl)
  336. data->GLContext = SDL_GL_CreateContext(data->Window);
  337. if (use_opengl && backup_context)
  338. SDL_GL_MakeCurrent(data->Window, backup_context);
  339. viewport->PlatformHandle = (void*)data->Window;
  340. }
  341. static void ImGui_ImplSDL2_DestroyWindow(ImGuiViewport* viewport)
  342. {
  343. if (ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData)
  344. {
  345. if (data->GLContext && data->WindowOwned)
  346. SDL_GL_DeleteContext(data->GLContext);
  347. if (data->Window && data->WindowOwned)
  348. SDL_DestroyWindow(data->Window);
  349. data->GLContext = NULL;
  350. data->Window = NULL;
  351. IM_DELETE(data);
  352. }
  353. viewport->PlatformUserData = viewport->PlatformHandle = NULL;
  354. }
  355. static void ImGui_ImplSDL2_ShowWindow(ImGuiViewport* viewport)
  356. {
  357. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  358. #if defined(_WIN32)
  359. SDL_SysWMinfo info;
  360. SDL_VERSION(&info.version);
  361. if (SDL_GetWindowWMInfo(data->Window, &info))
  362. {
  363. HWND hwnd = info.info.win.window;
  364. // SDL hack: Hide icon from task bar
  365. // 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.
  366. if (viewport->Flags & ImGuiViewportFlags_NoTaskBarIcon)
  367. {
  368. LONG ex_style = ::GetWindowLong(hwnd, GWL_EXSTYLE);
  369. ex_style &= ~WS_EX_APPWINDOW;
  370. ex_style |= WS_EX_TOOLWINDOW;
  371. ::SetWindowLong(hwnd, GWL_EXSTYLE, ex_style);
  372. }
  373. // SDL hack: SDL always activate/focus windows :/
  374. if (viewport->Flags & ImGuiViewportFlags_NoFocusOnAppearing)
  375. {
  376. ::ShowWindow(hwnd, SW_SHOWNA);
  377. return;
  378. }
  379. }
  380. #endif
  381. SDL_ShowWindow(data->Window);
  382. }
  383. static ImVec2 ImGui_ImplSDL2_GetWindowPos(ImGuiViewport* viewport)
  384. {
  385. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  386. int x = 0, y = 0;
  387. SDL_GetWindowPosition(data->Window, &x, &y);
  388. return ImVec2((float)x, (float)y);
  389. }
  390. static void ImGui_ImplSDL2_SetWindowPos(ImGuiViewport* viewport, ImVec2 pos)
  391. {
  392. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  393. SDL_SetWindowPosition(data->Window, (int)pos.x, (int)pos.y);
  394. }
  395. static ImVec2 ImGui_ImplSDL2_GetWindowSize(ImGuiViewport* viewport)
  396. {
  397. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  398. int w = 0, h = 0;
  399. SDL_GetWindowSize(data->Window, &w, &h);
  400. return ImVec2((float)w, (float)h);
  401. }
  402. static void ImGui_ImplSDL2_SetWindowSize(ImGuiViewport* viewport, ImVec2 size)
  403. {
  404. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  405. SDL_SetWindowSize(data->Window, (int)size.x, (int)size.y);
  406. }
  407. static void ImGui_ImplSDL2_SetWindowTitle(ImGuiViewport* viewport, const char* title)
  408. {
  409. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  410. SDL_SetWindowTitle(data->Window, title);
  411. }
  412. static void ImGui_ImplSDL2_SetWindowFocus(ImGuiViewport* viewport)
  413. {
  414. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  415. SDL_RaiseWindow(data->Window);
  416. }
  417. static bool ImGui_ImplSDL2_GetWindowFocus(ImGuiViewport* viewport)
  418. {
  419. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  420. return (SDL_GetWindowFlags(data->Window) & SDL_WINDOW_INPUT_FOCUS) != 0;
  421. }
  422. static void ImGui_ImplSDL2_RenderWindow(ImGuiViewport* viewport, void*)
  423. {
  424. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  425. if (data->GLContext)
  426. SDL_GL_MakeCurrent(data->Window, data->GLContext);
  427. }
  428. static void ImGui_ImplSDL2_SwapBuffers(ImGuiViewport* viewport, void*)
  429. {
  430. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  431. if (data->GLContext)
  432. {
  433. SDL_GL_MakeCurrent(data->Window, data->GLContext);
  434. SDL_GL_SwapWindow(data->Window);
  435. }
  436. }
  437. // Vulkan support (the Vulkan renderer needs to call a platform-side support function to create the surface)
  438. // SDL is graceful enough to _not_ need <vulkan/vulkan.h> so we can safely include this.
  439. #if SDL_HAS_VULKAN
  440. #include <SDL_vulkan.h>
  441. static int ImGui_ImplSDL2_CreateVkSurface(ImGuiViewport* viewport, ImU64 vk_instance, const void* vk_allocator, ImU64* out_vk_surface)
  442. {
  443. ImGuiViewportDataSDL2* data = (ImGuiViewportDataSDL2*)viewport->PlatformUserData;
  444. (void)vk_allocator;
  445. SDL_bool ret = SDL_Vulkan_CreateSurface(data->Window, (VkInstance)vk_instance, (VkSurfaceKHR*)out_vk_surface);
  446. return ret ? 0 : 1; // ret ? VK_SUCCESS : VK_NOT_READY
  447. }
  448. #endif // SDL_HAS_VULKAN
  449. // FIXME-PLATFORM: SDL doesn't have an event to notify the application of display/monitor changes
  450. static void ImGui_ImplSDL2_UpdateMonitors()
  451. {
  452. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  453. platform_io.Monitors.resize(0);
  454. int display_count = SDL_GetNumVideoDisplays();
  455. for (int n = 0; n < display_count; n++)
  456. {
  457. // 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.
  458. ImGuiPlatformMonitor monitor;
  459. SDL_Rect r;
  460. SDL_GetDisplayBounds(n, &r);
  461. monitor.MainPos = monitor.WorkPos = ImVec2((float)r.x, (float)r.y);
  462. monitor.MainSize = monitor.WorkSize = ImVec2((float)r.w, (float)r.h);
  463. #if SDL_HAS_USABLE_DISPLAY_BOUNDS
  464. SDL_GetDisplayUsableBounds(n, &r);
  465. monitor.WorkPos = ImVec2((float)r.x, (float)r.y);
  466. monitor.WorkSize = ImVec2((float)r.w, (float)r.h);
  467. #endif
  468. #if SDL_HAS_PER_MONITOR_DPI
  469. float dpi = 0.0f;
  470. if (SDL_GetDisplayDPI(n, &dpi, NULL, NULL))
  471. monitor.DpiScale = dpi / 96.0f;
  472. #endif
  473. platform_io.Monitors.push_back(monitor);
  474. }
  475. }
  476. static void ImGui_ImplSDL2_InitPlatformInterface(SDL_Window* window, void* sdl_gl_context)
  477. {
  478. // Register platform interface (will be coupled with a renderer interface)
  479. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  480. platform_io.Platform_CreateWindow = ImGui_ImplSDL2_CreateWindow;
  481. platform_io.Platform_DestroyWindow = ImGui_ImplSDL2_DestroyWindow;
  482. platform_io.Platform_ShowWindow = ImGui_ImplSDL2_ShowWindow;
  483. platform_io.Platform_SetWindowPos = ImGui_ImplSDL2_SetWindowPos;
  484. platform_io.Platform_GetWindowPos = ImGui_ImplSDL2_GetWindowPos;
  485. platform_io.Platform_SetWindowSize = ImGui_ImplSDL2_SetWindowSize;
  486. platform_io.Platform_GetWindowSize = ImGui_ImplSDL2_GetWindowSize;
  487. platform_io.Platform_SetWindowFocus = ImGui_ImplSDL2_SetWindowFocus;
  488. platform_io.Platform_GetWindowFocus = ImGui_ImplSDL2_GetWindowFocus;
  489. platform_io.Platform_SetWindowTitle = ImGui_ImplSDL2_SetWindowTitle;
  490. platform_io.Platform_RenderWindow = ImGui_ImplSDL2_RenderWindow;
  491. platform_io.Platform_SwapBuffers = ImGui_ImplSDL2_SwapBuffers;
  492. #if SDL_HAS_VULKAN
  493. platform_io.Platform_CreateVkSurface = ImGui_ImplSDL2_CreateVkSurface;
  494. #endif
  495. // SDL2 by default doesn't pass mouse clicks to the application when the click focused a window. This is getting in the way of our interactions and we disable that behavior.
  496. #if SDL_HAS_MOUSE_FOCUS_CLICKTHROUGH
  497. SDL_SetHint(SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH, "1");
  498. #endif
  499. ImGui_ImplSDL2_UpdateMonitors();
  500. // Register main window handle (which is owned by the main application, not by us)
  501. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  502. ImGuiViewportDataSDL2* data = IM_NEW(ImGuiViewportDataSDL2)();
  503. data->Window = window;
  504. data->WindowID = SDL_GetWindowID(window);
  505. data->WindowOwned = false;
  506. data->GLContext = sdl_gl_context;
  507. main_viewport->PlatformUserData = data;
  508. main_viewport->PlatformHandle = data->Window;
  509. }
  510. static void ImGui_ImplSDL2_ShutdownPlatformInterface()
  511. {
  512. }