imgui_impl_win32.cpp 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048
  1. // dear imgui: Platform Backend for Windows (standard windows API for 32 and 64 bits applications)
  2. // This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..)
  3. // Implemented features:
  4. // [X] Platform: Clipboard support (for Win32 this is actually part of core dear imgui)
  5. // [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  6. // [X] Platform: Keyboard arrays indexed using VK_* Virtual Key Codes, e.g. ImGui::IsKeyPressed(VK_SPACE).
  7. // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
  8. // [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  9. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  10. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  11. // If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.
  12. // Read online: https://github.com/ocornut/imgui/tree/master/docs
  13. #include "imgui.h"
  14. #include "imgui_impl_win32.h"
  15. #ifndef WIN32_LEAN_AND_MEAN
  16. #define WIN32_LEAN_AND_MEAN
  17. #endif
  18. #include <windows.h>
  19. #include <tchar.h>
  20. #include <dwmapi.h>
  21. // Configuration flags to add in your imconfig.h file:
  22. //#define IMGUI_IMPL_WIN32_DISABLE_GAMEPAD // Disable gamepad support. This was meaningful before <1.81 but we now load XInput dynamically so the option is now less relevant.
  23. // Using XInput for gamepad (will load DLL dynamically)
  24. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  25. #include <xinput.h>
  26. typedef DWORD (WINAPI *PFN_XInputGetCapabilities)(DWORD, DWORD, XINPUT_CAPABILITIES*);
  27. typedef DWORD (WINAPI *PFN_XInputGetState)(DWORD, XINPUT_STATE*);
  28. #endif
  29. // CHANGELOG
  30. // (minor and older changes stripped away, please see git history for details)
  31. // 2021-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  32. // 2021-07-29: Inputs: MousePos is correctly reported when the host platform window is hovered but not focused (using TrackMouseEvent() to receive WM_MOUSELEAVE events).
  33. // 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).
  34. // 2021-06-08: Fix ImGui_ImplWin32_EnableDpiAwareness() and ImGui_ImplWin32_GetDpiScaleForMonitor() to handle Windows 8.1/10 features without a manifest (per-monitor DPI, and properly calls SetProcessDpiAwareness() on 8.1).
  35. // 2021-03-23: Inputs: Clearing keyboard down array when losing focus (WM_KILLFOCUS).
  36. // 2021-02-18: Added ImGui_ImplWin32_EnableAlphaCompositing(). Non Visual Studio users will need to link with dwmapi.lib (MinGW/gcc: use -ldwmapi).
  37. // 2021-02-17: Fixed ImGui_ImplWin32_EnableDpiAwareness() attempting to get SetProcessDpiAwareness from shcore.dll on Windows 8 whereas it is only supported on Windows 8.1.
  38. // 2021-01-25: Inputs: Dynamically loading XInput DLL.
  39. // 2020-12-04: Misc: Fixed setting of io.DisplaySize to invalid/uninitialized data when after hwnd has been closed.
  40. // 2020-03-03: Inputs: Calling AddInputCharacterUTF16() to support surrogate pairs leading to codepoint >= 0x10000 (for more complete CJK inputs)
  41. // 2020-02-17: Added ImGui_ImplWin32_EnableDpiAwareness(), ImGui_ImplWin32_GetDpiScaleForHwnd(), ImGui_ImplWin32_GetDpiScaleForMonitor() helper functions.
  42. // 2020-01-14: Inputs: Added support for #define IMGUI_IMPL_WIN32_DISABLE_GAMEPAD/IMGUI_IMPL_WIN32_DISABLE_LINKING_XINPUT.
  43. // 2019-12-05: Inputs: Added support for ImGuiMouseCursor_NotAllowed mouse cursor.
  44. // 2019-05-11: Inputs: Don't filter value from WM_CHAR before calling AddInputCharacter().
  45. // 2019-01-17: Misc: Using GetForegroundWindow()+IsChild() instead of GetActiveWindow() to be compatible with windows created in a different thread or parent.
  46. // 2019-01-17: Inputs: Added support for mouse buttons 4 and 5 via WM_XBUTTON* messages.
  47. // 2019-01-15: Inputs: Added support for XInput gamepads (if ImGuiConfigFlags_NavEnableGamepad is set by user application).
  48. // 2018-11-30: Misc: Setting up io.BackendPlatformName so it can be displayed in the About Window.
  49. // 2018-06-29: Inputs: Added support for the ImGuiMouseCursor_Hand cursor.
  50. // 2018-06-10: Inputs: Fixed handling of mouse wheel messages to support fine position messages (typically sent by track-pads).
  51. // 2018-06-08: Misc: Extracted imgui_impl_win32.cpp/.h away from the old combined DX9/DX10/DX11/DX12 examples.
  52. // 2018-03-20: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors and ImGuiBackendFlags_HasSetMousePos flags + honor ImGuiConfigFlags_NoMouseCursorChange flag.
  53. // 2018-02-20: Inputs: Added support for mouse cursors (ImGui::GetMouseCursor() value and WM_SETCURSOR message handling).
  54. // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
  55. // 2018-02-06: Inputs: Honoring the io.WantSetMousePos by repositioning the mouse (when using navigation and ImGuiConfigFlags_NavMoveMouse is set).
  56. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  57. // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
  58. // 2018-01-08: Inputs: Added mapping for ImGuiKey_Insert.
  59. // 2018-01-05: Inputs: Added WM_LBUTTONDBLCLK double-click handlers for window classes with the CS_DBLCLKS flag.
  60. // 2017-10-23: Inputs: Added WM_SYSKEYDOWN / WM_SYSKEYUP handlers so e.g. the VK_MENU key can be read.
  61. // 2017-10-23: Inputs: Using Win32 ::SetCapture/::GetCapture() to retrieve mouse positions outside the client area when dragging.
  62. // 2016-11-12: Inputs: Only call Win32 ::SetCursor(NULL) when io.MouseDrawCursor is set.
  63. // Forward Declarations
  64. static void ImGui_ImplWin32_InitPlatformInterface();
  65. static void ImGui_ImplWin32_ShutdownPlatformInterface();
  66. static void ImGui_ImplWin32_UpdateMonitors();
  67. // Win32
  68. struct ImGui_ImplWin32_Data
  69. {
  70. HWND hWnd;
  71. HWND MouseHwnd;
  72. bool MouseTracked;
  73. INT64 Time;
  74. INT64 TicksPerSecond;
  75. ImGuiMouseCursor LastMouseCursor;
  76. bool HasGamepad;
  77. bool WantUpdateHasGamepad;
  78. bool WantUpdateMonitors;
  79. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  80. HMODULE XInputDLL;
  81. PFN_XInputGetCapabilities XInputGetCapabilities;
  82. PFN_XInputGetState XInputGetState;
  83. #endif
  84. ImGui_ImplWin32_Data() { memset(this, 0, sizeof(*this)); }
  85. };
  86. // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts
  87. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  88. // FIXME: multi-context support is not well tested and probably dysfunctional in this backend.
  89. // FIXME: some shared resources (mouse cursor shape, gamepad) are mishandled when using multi-context.
  90. static ImGui_ImplWin32_Data* ImGui_ImplWin32_GetBackendData()
  91. {
  92. return ImGui::GetCurrentContext() ? (ImGui_ImplWin32_Data*)ImGui::GetIO().BackendPlatformUserData : NULL;
  93. }
  94. // Functions
  95. bool ImGui_ImplWin32_Init(void* hwnd)
  96. {
  97. ImGuiIO& io = ImGui::GetIO();
  98. IM_ASSERT(io.BackendPlatformUserData == NULL && "Already initialized a platform backend!");
  99. INT64 perf_frequency, perf_counter;
  100. if (!::QueryPerformanceFrequency((LARGE_INTEGER*)&perf_frequency))
  101. return false;
  102. if (!::QueryPerformanceCounter((LARGE_INTEGER*)&perf_counter))
  103. return false;
  104. // Setup backend capabilities flags
  105. ImGui_ImplWin32_Data* bd = IM_NEW(ImGui_ImplWin32_Data)();
  106. io.BackendPlatformUserData = (void*)bd;
  107. io.BackendPlatformName = "imgui_impl_win32";
  108. io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
  109. io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
  110. io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports; // We can create multi-viewports on the Platform side (optional)
  111. io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport; // We can set io.MouseHoveredViewport correctly (optional, not easy)
  112. bd->hWnd = (HWND)hwnd;
  113. bd->WantUpdateHasGamepad = true;
  114. bd->WantUpdateMonitors = true;
  115. bd->TicksPerSecond = perf_frequency;
  116. bd->Time = perf_counter;
  117. bd->LastMouseCursor = ImGuiMouseCursor_COUNT;
  118. // Our mouse update function expect PlatformHandle to be filled for the main viewport
  119. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  120. main_viewport->PlatformHandle = main_viewport->PlatformHandleRaw = (void*)bd->hWnd;
  121. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  122. ImGui_ImplWin32_InitPlatformInterface();
  123. // Keyboard mapping. Dear ImGui will use those indices to peek into the io.KeysDown[] array that we will update during the application lifetime.
  124. io.KeyMap[ImGuiKey_Tab] = VK_TAB;
  125. io.KeyMap[ImGuiKey_LeftArrow] = VK_LEFT;
  126. io.KeyMap[ImGuiKey_RightArrow] = VK_RIGHT;
  127. io.KeyMap[ImGuiKey_UpArrow] = VK_UP;
  128. io.KeyMap[ImGuiKey_DownArrow] = VK_DOWN;
  129. io.KeyMap[ImGuiKey_PageUp] = VK_PRIOR;
  130. io.KeyMap[ImGuiKey_PageDown] = VK_NEXT;
  131. io.KeyMap[ImGuiKey_Home] = VK_HOME;
  132. io.KeyMap[ImGuiKey_End] = VK_END;
  133. io.KeyMap[ImGuiKey_Insert] = VK_INSERT;
  134. io.KeyMap[ImGuiKey_Delete] = VK_DELETE;
  135. io.KeyMap[ImGuiKey_Backspace] = VK_BACK;
  136. io.KeyMap[ImGuiKey_Space] = VK_SPACE;
  137. io.KeyMap[ImGuiKey_Enter] = VK_RETURN;
  138. io.KeyMap[ImGuiKey_Escape] = VK_ESCAPE;
  139. io.KeyMap[ImGuiKey_KeyPadEnter] = VK_RETURN;
  140. io.KeyMap[ImGuiKey_A] = 'A';
  141. io.KeyMap[ImGuiKey_C] = 'C';
  142. io.KeyMap[ImGuiKey_V] = 'V';
  143. io.KeyMap[ImGuiKey_X] = 'X';
  144. io.KeyMap[ImGuiKey_Y] = 'Y';
  145. io.KeyMap[ImGuiKey_Z] = 'Z';
  146. // Dynamically load XInput library
  147. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  148. const char* xinput_dll_names[] =
  149. {
  150. "xinput1_4.dll", // Windows 8+
  151. "xinput1_3.dll", // DirectX SDK
  152. "xinput9_1_0.dll", // Windows Vista, Windows 7
  153. "xinput1_2.dll", // DirectX SDK
  154. "xinput1_1.dll" // DirectX SDK
  155. };
  156. for (int n = 0; n < IM_ARRAYSIZE(xinput_dll_names); n++)
  157. if (HMODULE dll = ::LoadLibraryA(xinput_dll_names[n]))
  158. {
  159. bd->XInputDLL = dll;
  160. bd->XInputGetCapabilities = (PFN_XInputGetCapabilities)::GetProcAddress(dll, "XInputGetCapabilities");
  161. bd->XInputGetState = (PFN_XInputGetState)::GetProcAddress(dll, "XInputGetState");
  162. break;
  163. }
  164. #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  165. return true;
  166. }
  167. void ImGui_ImplWin32_Shutdown()
  168. {
  169. ImGuiIO& io = ImGui::GetIO();
  170. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  171. ImGui_ImplWin32_ShutdownPlatformInterface();
  172. // Unload XInput library
  173. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  174. if (bd->XInputDLL)
  175. ::FreeLibrary(bd->XInputDLL);
  176. #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  177. io.BackendPlatformName = NULL;
  178. io.BackendPlatformUserData = NULL;
  179. IM_DELETE(bd);
  180. }
  181. static bool ImGui_ImplWin32_UpdateMouseCursor()
  182. {
  183. ImGuiIO& io = ImGui::GetIO();
  184. if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
  185. return false;
  186. ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
  187. if (imgui_cursor == ImGuiMouseCursor_None || io.MouseDrawCursor)
  188. {
  189. // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
  190. ::SetCursor(NULL);
  191. }
  192. else
  193. {
  194. // Show OS mouse cursor
  195. LPTSTR win32_cursor = IDC_ARROW;
  196. switch (imgui_cursor)
  197. {
  198. case ImGuiMouseCursor_Arrow: win32_cursor = IDC_ARROW; break;
  199. case ImGuiMouseCursor_TextInput: win32_cursor = IDC_IBEAM; break;
  200. case ImGuiMouseCursor_ResizeAll: win32_cursor = IDC_SIZEALL; break;
  201. case ImGuiMouseCursor_ResizeEW: win32_cursor = IDC_SIZEWE; break;
  202. case ImGuiMouseCursor_ResizeNS: win32_cursor = IDC_SIZENS; break;
  203. case ImGuiMouseCursor_ResizeNESW: win32_cursor = IDC_SIZENESW; break;
  204. case ImGuiMouseCursor_ResizeNWSE: win32_cursor = IDC_SIZENWSE; break;
  205. case ImGuiMouseCursor_Hand: win32_cursor = IDC_HAND; break;
  206. case ImGuiMouseCursor_NotAllowed: win32_cursor = IDC_NO; break;
  207. }
  208. ::SetCursor(::LoadCursor(NULL, win32_cursor));
  209. }
  210. return true;
  211. }
  212. // This code supports multi-viewports (multiple OS Windows mapped into different Dear ImGui viewports)
  213. // Because of that, it is a little more complicated than your typical single-viewport binding code!
  214. static void ImGui_ImplWin32_UpdateMousePos()
  215. {
  216. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  217. ImGuiIO& io = ImGui::GetIO();
  218. IM_ASSERT(bd->hWnd != 0);
  219. const ImVec2 mouse_pos_prev = io.MousePos;
  220. io.MousePos = ImVec2(-FLT_MAX, -FLT_MAX);
  221. io.MouseHoveredViewport = 0;
  222. // Obtain focused and hovered window. We forward mouse input when focused or when hovered (and no other window is capturing)
  223. HWND focused_window = ::GetForegroundWindow();
  224. HWND hovered_window = bd->MouseHwnd;
  225. HWND mouse_window = NULL;
  226. if (hovered_window && (hovered_window == bd->hWnd || ::IsChild(hovered_window, bd->hWnd) || ImGui::FindViewportByPlatformHandle((void*)hovered_window)))
  227. mouse_window = hovered_window;
  228. else if (focused_window && (focused_window == bd->hWnd || ::IsChild(focused_window, bd->hWnd) || ImGui::FindViewportByPlatformHandle((void*)focused_window)))
  229. mouse_window = focused_window;
  230. if (mouse_window == NULL)
  231. return;
  232. // Set OS mouse position from Dear ImGui if requested (rarely used, only when ImGuiConfigFlags_NavEnableSetMousePos is enabled by user)
  233. // (When multi-viewports are enabled, all Dear ImGui positions are same as OS positions)
  234. if (io.WantSetMousePos && mouse_window != NULL)
  235. {
  236. POINT pos = { (int)mouse_pos_prev.x, (int)mouse_pos_prev.y };
  237. if ((io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable) == 0)
  238. ::ClientToScreen(mouse_window, &pos);
  239. ::SetCursorPos(pos.x, pos.y);
  240. }
  241. // Set Dear ImGui mouse position from OS position
  242. POINT mouse_screen_pos;
  243. if (!::GetCursorPos(&mouse_screen_pos))
  244. return;
  245. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  246. {
  247. // 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)
  248. // This is the position you can get with ::GetCursorPos() or WM_MOUSEMOVE + ::ClientToScreen(). In theory adding viewport->Pos to a client position would also be the same.
  249. io.MousePos = ImVec2((float)mouse_screen_pos.x, (float)mouse_screen_pos.y);
  250. }
  251. else
  252. {
  253. // 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)
  254. // This is the position you can get with ::GetCursorPos() + ::ScreenToClient() or WM_MOUSEMOVE.
  255. POINT mouse_client_pos = mouse_screen_pos;
  256. ::ScreenToClient(bd->hWnd, &mouse_client_pos);
  257. io.MousePos = ImVec2((float)mouse_client_pos.x, (float)mouse_client_pos.y);
  258. }
  259. // (Optional) When using multiple viewports: set io.MouseHoveredViewport to the viewport the OS mouse cursor is hovering.
  260. // Important: this information is not easy to provide and many high-level windowing library won't be able to provide it correctly, because
  261. // - This is _ignoring_ viewports with the ImGuiViewportFlags_NoInputs flag (pass-through windows).
  262. // - This is _regardless_ of whether another viewport is focused or being dragged from.
  263. // If ImGuiBackendFlags_HasMouseHoveredViewport is not set by the backend, imgui will ignore this field and infer the information by relying on the
  264. // rectangles and last focused time of every viewports it knows about. It will be unaware of foreign windows that may be sitting between or over your windows.
  265. if (HWND hovered_hwnd = ::WindowFromPoint(mouse_screen_pos))
  266. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle((void*)hovered_hwnd))
  267. if ((viewport->Flags & ImGuiViewportFlags_NoInputs) == 0) // FIXME: We still get our NoInputs window with WM_NCHITTEST/HTTRANSPARENT code when decorated?
  268. io.MouseHoveredViewport = viewport->ID;
  269. }
  270. // Gamepad navigation mapping
  271. static void ImGui_ImplWin32_UpdateGamepads()
  272. {
  273. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  274. ImGuiIO& io = ImGui::GetIO();
  275. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  276. memset(io.NavInputs, 0, sizeof(io.NavInputs));
  277. if ((io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) == 0)
  278. return;
  279. // Calling XInputGetState() every frame on disconnected gamepads is unfortunately too slow.
  280. // Instead we refresh gamepad availability by calling XInputGetCapabilities() _only_ after receiving WM_DEVICECHANGE.
  281. if (bd->WantUpdateHasGamepad)
  282. {
  283. XINPUT_CAPABILITIES caps;
  284. bd->HasGamepad = bd->XInputGetCapabilities ? (bd->XInputGetCapabilities(0, XINPUT_FLAG_GAMEPAD, &caps) == ERROR_SUCCESS) : false;
  285. bd->WantUpdateHasGamepad = false;
  286. }
  287. io.BackendFlags &= ~ImGuiBackendFlags_HasGamepad;
  288. XINPUT_STATE xinput_state;
  289. if (bd->HasGamepad && bd->XInputGetState && bd->XInputGetState(0, &xinput_state) == ERROR_SUCCESS)
  290. {
  291. const XINPUT_GAMEPAD& gamepad = xinput_state.Gamepad;
  292. io.BackendFlags |= ImGuiBackendFlags_HasGamepad;
  293. #define MAP_BUTTON(NAV_NO, BUTTON_ENUM) { io.NavInputs[NAV_NO] = (gamepad.wButtons & BUTTON_ENUM) ? 1.0f : 0.0f; }
  294. #define MAP_ANALOG(NAV_NO, VALUE, V0, V1) { float vn = (float)(VALUE - V0) / (float)(V1 - V0); if (vn > 1.0f) vn = 1.0f; if (vn > 0.0f && io.NavInputs[NAV_NO] < vn) io.NavInputs[NAV_NO] = vn; }
  295. MAP_BUTTON(ImGuiNavInput_Activate, XINPUT_GAMEPAD_A); // Cross / A
  296. MAP_BUTTON(ImGuiNavInput_Cancel, XINPUT_GAMEPAD_B); // Circle / B
  297. MAP_BUTTON(ImGuiNavInput_Menu, XINPUT_GAMEPAD_X); // Square / X
  298. MAP_BUTTON(ImGuiNavInput_Input, XINPUT_GAMEPAD_Y); // Triangle / Y
  299. MAP_BUTTON(ImGuiNavInput_DpadLeft, XINPUT_GAMEPAD_DPAD_LEFT); // D-Pad Left
  300. MAP_BUTTON(ImGuiNavInput_DpadRight, XINPUT_GAMEPAD_DPAD_RIGHT); // D-Pad Right
  301. MAP_BUTTON(ImGuiNavInput_DpadUp, XINPUT_GAMEPAD_DPAD_UP); // D-Pad Up
  302. MAP_BUTTON(ImGuiNavInput_DpadDown, XINPUT_GAMEPAD_DPAD_DOWN); // D-Pad Down
  303. MAP_BUTTON(ImGuiNavInput_FocusPrev, XINPUT_GAMEPAD_LEFT_SHOULDER); // L1 / LB
  304. MAP_BUTTON(ImGuiNavInput_FocusNext, XINPUT_GAMEPAD_RIGHT_SHOULDER); // R1 / RB
  305. MAP_BUTTON(ImGuiNavInput_TweakSlow, XINPUT_GAMEPAD_LEFT_SHOULDER); // L1 / LB
  306. MAP_BUTTON(ImGuiNavInput_TweakFast, XINPUT_GAMEPAD_RIGHT_SHOULDER); // R1 / RB
  307. MAP_ANALOG(ImGuiNavInput_LStickLeft, gamepad.sThumbLX, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
  308. MAP_ANALOG(ImGuiNavInput_LStickRight, gamepad.sThumbLX, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  309. MAP_ANALOG(ImGuiNavInput_LStickUp, gamepad.sThumbLY, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  310. MAP_ANALOG(ImGuiNavInput_LStickDown, gamepad.sThumbLY, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32767);
  311. #undef MAP_BUTTON
  312. #undef MAP_ANALOG
  313. }
  314. #endif // #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  315. }
  316. static BOOL CALLBACK ImGui_ImplWin32_UpdateMonitors_EnumFunc(HMONITOR monitor, HDC, LPRECT, LPARAM)
  317. {
  318. MONITORINFO info = {};
  319. info.cbSize = sizeof(MONITORINFO);
  320. if (!::GetMonitorInfo(monitor, &info))
  321. return TRUE;
  322. ImGuiPlatformMonitor imgui_monitor;
  323. imgui_monitor.MainPos = ImVec2((float)info.rcMonitor.left, (float)info.rcMonitor.top);
  324. imgui_monitor.MainSize = ImVec2((float)(info.rcMonitor.right - info.rcMonitor.left), (float)(info.rcMonitor.bottom - info.rcMonitor.top));
  325. imgui_monitor.WorkPos = ImVec2((float)info.rcWork.left, (float)info.rcWork.top);
  326. imgui_monitor.WorkSize = ImVec2((float)(info.rcWork.right - info.rcWork.left), (float)(info.rcWork.bottom - info.rcWork.top));
  327. imgui_monitor.DpiScale = ImGui_ImplWin32_GetDpiScaleForMonitor(monitor);
  328. ImGuiPlatformIO& io = ImGui::GetPlatformIO();
  329. if (info.dwFlags & MONITORINFOF_PRIMARY)
  330. io.Monitors.push_front(imgui_monitor);
  331. else
  332. io.Monitors.push_back(imgui_monitor);
  333. return TRUE;
  334. }
  335. static void ImGui_ImplWin32_UpdateMonitors()
  336. {
  337. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  338. ImGui::GetPlatformIO().Monitors.resize(0);
  339. ::EnumDisplayMonitors(NULL, NULL, ImGui_ImplWin32_UpdateMonitors_EnumFunc, 0);
  340. bd->WantUpdateMonitors = false;
  341. }
  342. void ImGui_ImplWin32_NewFrame()
  343. {
  344. ImGuiIO& io = ImGui::GetIO();
  345. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  346. IM_ASSERT(bd != NULL && "Did you call ImGui_ImplWin32_Init()?");
  347. // Setup display size (every frame to accommodate for window resizing)
  348. RECT rect = { 0, 0, 0, 0 };
  349. ::GetClientRect(bd->hWnd, &rect);
  350. io.DisplaySize = ImVec2((float)(rect.right - rect.left), (float)(rect.bottom - rect.top));
  351. if (bd->WantUpdateMonitors)
  352. ImGui_ImplWin32_UpdateMonitors();
  353. // Setup time step
  354. INT64 current_time = 0;
  355. ::QueryPerformanceCounter((LARGE_INTEGER*)&current_time);
  356. io.DeltaTime = (float)(current_time - bd->Time) / bd->TicksPerSecond;
  357. bd->Time = current_time;
  358. // Read keyboard modifiers inputs
  359. io.KeyCtrl = (::GetKeyState(VK_CONTROL) & 0x8000) != 0;
  360. io.KeyShift = (::GetKeyState(VK_SHIFT) & 0x8000) != 0;
  361. io.KeyAlt = (::GetKeyState(VK_MENU) & 0x8000) != 0;
  362. io.KeySuper = false;
  363. // io.KeysDown[], io.MousePos, io.MouseDown[], io.MouseWheel: filled by the WndProc handler below.
  364. // Update OS mouse position
  365. ImGui_ImplWin32_UpdateMousePos();
  366. // Update OS mouse cursor with the cursor requested by imgui
  367. ImGuiMouseCursor mouse_cursor = io.MouseDrawCursor ? ImGuiMouseCursor_None : ImGui::GetMouseCursor();
  368. if (bd->LastMouseCursor != mouse_cursor)
  369. {
  370. bd->LastMouseCursor = mouse_cursor;
  371. ImGui_ImplWin32_UpdateMouseCursor();
  372. }
  373. // Update game controllers (if enabled and available)
  374. ImGui_ImplWin32_UpdateGamepads();
  375. }
  376. // Allow compilation with old Windows SDK. MinGW doesn't have default _WIN32_WINNT/WINVER versions.
  377. #ifndef WM_MOUSEHWHEEL
  378. #define WM_MOUSEHWHEEL 0x020E
  379. #endif
  380. #ifndef DBT_DEVNODES_CHANGED
  381. #define DBT_DEVNODES_CHANGED 0x0007
  382. #endif
  383. // Win32 message handler (process Win32 mouse/keyboard inputs, etc.)
  384. // Call from your application's message handler.
  385. // When implementing your own backend, you can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if Dear ImGui wants to use your inputs.
  386. // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application.
  387. // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application.
  388. // Generally you may always pass all inputs to Dear ImGui, and hide them from your application based on those two flags.
  389. // PS: In this Win32 handler, we use the capture API (GetCapture/SetCapture/ReleaseCapture) to be able to read mouse coordinates when dragging mouse outside of our window bounds.
  390. // PS: We treat DBLCLK messages as regular mouse down messages, so this code will work on windows classes that have the CS_DBLCLKS flag set. Our own example app code doesn't set this flag.
  391. #if 0
  392. // Copy this line into your .cpp file to forward declare the function.
  393. extern IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
  394. #endif
  395. IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
  396. {
  397. if (ImGui::GetCurrentContext() == NULL)
  398. return 0;
  399. ImGuiIO& io = ImGui::GetIO();
  400. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  401. switch (msg)
  402. {
  403. case WM_MOUSEMOVE:
  404. // We need to call TrackMouseEvent in order to receive WM_MOUSELEAVE events
  405. bd->MouseHwnd = hwnd;
  406. if (!bd->MouseTracked)
  407. {
  408. TRACKMOUSEEVENT tme = { sizeof(tme), TME_LEAVE, hwnd, 0 };
  409. ::TrackMouseEvent(&tme);
  410. bd->MouseTracked = true;
  411. }
  412. break;
  413. case WM_MOUSELEAVE:
  414. if (bd->MouseHwnd == hwnd)
  415. bd->MouseHwnd = NULL;
  416. bd->MouseTracked = false;
  417. break;
  418. case WM_LBUTTONDOWN: case WM_LBUTTONDBLCLK:
  419. case WM_RBUTTONDOWN: case WM_RBUTTONDBLCLK:
  420. case WM_MBUTTONDOWN: case WM_MBUTTONDBLCLK:
  421. case WM_XBUTTONDOWN: case WM_XBUTTONDBLCLK:
  422. {
  423. int button = 0;
  424. if (msg == WM_LBUTTONDOWN || msg == WM_LBUTTONDBLCLK) { button = 0; }
  425. if (msg == WM_RBUTTONDOWN || msg == WM_RBUTTONDBLCLK) { button = 1; }
  426. if (msg == WM_MBUTTONDOWN || msg == WM_MBUTTONDBLCLK) { button = 2; }
  427. if (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONDBLCLK) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; }
  428. if (!ImGui::IsAnyMouseDown() && ::GetCapture() == NULL)
  429. ::SetCapture(hwnd);
  430. io.MouseDown[button] = true;
  431. return 0;
  432. }
  433. case WM_LBUTTONUP:
  434. case WM_RBUTTONUP:
  435. case WM_MBUTTONUP:
  436. case WM_XBUTTONUP:
  437. {
  438. int button = 0;
  439. if (msg == WM_LBUTTONUP) { button = 0; }
  440. if (msg == WM_RBUTTONUP) { button = 1; }
  441. if (msg == WM_MBUTTONUP) { button = 2; }
  442. if (msg == WM_XBUTTONUP) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; }
  443. io.MouseDown[button] = false;
  444. if (!ImGui::IsAnyMouseDown() && ::GetCapture() == hwnd)
  445. ::ReleaseCapture();
  446. return 0;
  447. }
  448. case WM_MOUSEWHEEL:
  449. io.MouseWheel += (float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA;
  450. return 0;
  451. case WM_MOUSEHWHEEL:
  452. io.MouseWheelH += (float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA;
  453. return 0;
  454. case WM_KEYDOWN:
  455. case WM_SYSKEYDOWN:
  456. if (wParam < 256)
  457. io.KeysDown[wParam] = 1;
  458. return 0;
  459. case WM_KEYUP:
  460. case WM_SYSKEYUP:
  461. if (wParam < 256)
  462. io.KeysDown[wParam] = 0;
  463. return 0;
  464. case WM_KILLFOCUS:
  465. memset(io.KeysDown, 0, sizeof(io.KeysDown));
  466. return 0;
  467. case WM_CHAR:
  468. // You can also use ToAscii()+GetKeyboardState() to retrieve characters.
  469. if (wParam > 0 && wParam < 0x10000)
  470. io.AddInputCharacterUTF16((unsigned short)wParam);
  471. return 0;
  472. case WM_SETCURSOR:
  473. if (LOWORD(lParam) == HTCLIENT && ImGui_ImplWin32_UpdateMouseCursor())
  474. return 1;
  475. return 0;
  476. case WM_DEVICECHANGE:
  477. if ((UINT)wParam == DBT_DEVNODES_CHANGED)
  478. bd->WantUpdateHasGamepad = true;
  479. return 0;
  480. case WM_DISPLAYCHANGE:
  481. bd->WantUpdateMonitors = true;
  482. return 0;
  483. }
  484. return 0;
  485. }
  486. //--------------------------------------------------------------------------------------------------------
  487. // DPI-related helpers (optional)
  488. //--------------------------------------------------------------------------------------------------------
  489. // - Use to enable DPI awareness without having to create an application manifest.
  490. // - Your own app may already do this via a manifest or explicit calls. This is mostly useful for our examples/ apps.
  491. // - In theory we could call simple functions from Windows SDK such as SetProcessDPIAware(), SetProcessDpiAwareness(), etc.
  492. // but most of the functions provided by Microsoft require Windows 8.1/10+ SDK at compile time and Windows 8/10+ at runtime,
  493. // neither we want to require the user to have. So we dynamically select and load those functions to avoid dependencies.
  494. //---------------------------------------------------------------------------------------------------------
  495. // This is the scheme successfully used by GLFW (from which we borrowed some of the code) and other apps aiming to be highly portable.
  496. // ImGui_ImplWin32_EnableDpiAwareness() is just a helper called by main.cpp, we don't call it automatically.
  497. // If you are trying to implement your own backend for your own engine, you may ignore that noise.
  498. //---------------------------------------------------------------------------------------------------------
  499. // Perform our own check with RtlVerifyVersionInfo() instead of using functions from <VersionHelpers.h> as they
  500. // require a manifest to be functional for checks above 8.1. See https://github.com/ocornut/imgui/issues/4200
  501. static BOOL _IsWindowsVersionOrGreater(WORD major, WORD minor, WORD)
  502. {
  503. typedef LONG(WINAPI* PFN_RtlVerifyVersionInfo)(OSVERSIONINFOEXW*, ULONG, ULONGLONG);
  504. static PFN_RtlVerifyVersionInfo RtlVerifyVersionInfoFn = NULL;
  505. if (RtlVerifyVersionInfoFn == NULL)
  506. if (HMODULE ntdllModule = ::GetModuleHandleA("ntdll.dll"))
  507. RtlVerifyVersionInfoFn = (PFN_RtlVerifyVersionInfo)GetProcAddress(ntdllModule, "RtlVerifyVersionInfo");
  508. if (RtlVerifyVersionInfoFn == NULL)
  509. return FALSE;
  510. RTL_OSVERSIONINFOEXW versionInfo = { };
  511. ULONGLONG conditionMask = 0;
  512. versionInfo.dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW);
  513. versionInfo.dwMajorVersion = major;
  514. versionInfo.dwMinorVersion = minor;
  515. VER_SET_CONDITION(conditionMask, VER_MAJORVERSION, VER_GREATER_EQUAL);
  516. VER_SET_CONDITION(conditionMask, VER_MINORVERSION, VER_GREATER_EQUAL);
  517. return (RtlVerifyVersionInfoFn(&versionInfo, VER_MAJORVERSION | VER_MINORVERSION, conditionMask) == 0) ? TRUE : FALSE;
  518. }
  519. #define _IsWindowsVistaOrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0600), LOBYTE(0x0600), 0) // _WIN32_WINNT_VISTA
  520. #define _IsWindows8OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0602), LOBYTE(0x0602), 0) // _WIN32_WINNT_WIN8
  521. #define _IsWindows8Point1OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0603), LOBYTE(0x0603), 0) // _WIN32_WINNT_WINBLUE
  522. #define _IsWindows10OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0A00), LOBYTE(0x0A00), 0) // _WIN32_WINNT_WINTHRESHOLD / _WIN32_WINNT_WIN10
  523. #ifndef DPI_ENUMS_DECLARED
  524. typedef enum { PROCESS_DPI_UNAWARE = 0, PROCESS_SYSTEM_DPI_AWARE = 1, PROCESS_PER_MONITOR_DPI_AWARE = 2 } PROCESS_DPI_AWARENESS;
  525. typedef enum { MDT_EFFECTIVE_DPI = 0, MDT_ANGULAR_DPI = 1, MDT_RAW_DPI = 2, MDT_DEFAULT = MDT_EFFECTIVE_DPI } MONITOR_DPI_TYPE;
  526. #endif
  527. #ifndef _DPI_AWARENESS_CONTEXTS_
  528. DECLARE_HANDLE(DPI_AWARENESS_CONTEXT);
  529. #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE (DPI_AWARENESS_CONTEXT)-3
  530. #endif
  531. #ifndef DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2
  532. #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2 (DPI_AWARENESS_CONTEXT)-4
  533. #endif
  534. typedef HRESULT(WINAPI* PFN_SetProcessDpiAwareness)(PROCESS_DPI_AWARENESS); // Shcore.lib + dll, Windows 8.1+
  535. typedef HRESULT(WINAPI* PFN_GetDpiForMonitor)(HMONITOR, MONITOR_DPI_TYPE, UINT*, UINT*); // Shcore.lib + dll, Windows 8.1+
  536. typedef DPI_AWARENESS_CONTEXT(WINAPI* PFN_SetThreadDpiAwarenessContext)(DPI_AWARENESS_CONTEXT); // User32.lib + dll, Windows 10 v1607+ (Creators Update)
  537. // Helper function to enable DPI awareness without setting up a manifest
  538. void ImGui_ImplWin32_EnableDpiAwareness()
  539. {
  540. // Make sure monitors will be updated with latest correct scaling
  541. if (ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData())
  542. bd->WantUpdateMonitors = true;
  543. if (_IsWindows10OrGreater())
  544. {
  545. static HINSTANCE user32_dll = ::LoadLibraryA("user32.dll"); // Reference counted per-process
  546. if (PFN_SetThreadDpiAwarenessContext SetThreadDpiAwarenessContextFn = (PFN_SetThreadDpiAwarenessContext)::GetProcAddress(user32_dll, "SetThreadDpiAwarenessContext"))
  547. {
  548. SetThreadDpiAwarenessContextFn(DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2);
  549. return;
  550. }
  551. }
  552. if (_IsWindows8Point1OrGreater())
  553. {
  554. static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
  555. if (PFN_SetProcessDpiAwareness SetProcessDpiAwarenessFn = (PFN_SetProcessDpiAwareness)::GetProcAddress(shcore_dll, "SetProcessDpiAwareness"))
  556. {
  557. SetProcessDpiAwarenessFn(PROCESS_PER_MONITOR_DPI_AWARE);
  558. return;
  559. }
  560. }
  561. #if _WIN32_WINNT >= 0x0600
  562. ::SetProcessDPIAware();
  563. #endif
  564. }
  565. #if defined(_MSC_VER) && !defined(NOGDI)
  566. #pragma comment(lib, "gdi32") // Link with gdi32.lib for GetDeviceCaps(). MinGW will require linking with '-lgdi32'
  567. #endif
  568. float ImGui_ImplWin32_GetDpiScaleForMonitor(void* monitor)
  569. {
  570. UINT xdpi = 96, ydpi = 96;
  571. if (_IsWindows8Point1OrGreater())
  572. {
  573. static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
  574. static PFN_GetDpiForMonitor GetDpiForMonitorFn = NULL;
  575. if (GetDpiForMonitorFn == NULL && shcore_dll != NULL)
  576. GetDpiForMonitorFn = (PFN_GetDpiForMonitor)::GetProcAddress(shcore_dll, "GetDpiForMonitor");
  577. if (GetDpiForMonitorFn != NULL)
  578. {
  579. GetDpiForMonitorFn((HMONITOR)monitor, MDT_EFFECTIVE_DPI, &xdpi, &ydpi);
  580. IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert!
  581. return xdpi / 96.0f;
  582. }
  583. }
  584. #ifndef NOGDI
  585. const HDC dc = ::GetDC(NULL);
  586. xdpi = ::GetDeviceCaps(dc, LOGPIXELSX);
  587. ydpi = ::GetDeviceCaps(dc, LOGPIXELSY);
  588. IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert!
  589. ::ReleaseDC(NULL, dc);
  590. #endif
  591. return xdpi / 96.0f;
  592. }
  593. float ImGui_ImplWin32_GetDpiScaleForHwnd(void* hwnd)
  594. {
  595. HMONITOR monitor = ::MonitorFromWindow((HWND)hwnd, MONITOR_DEFAULTTONEAREST);
  596. return ImGui_ImplWin32_GetDpiScaleForMonitor(monitor);
  597. }
  598. //--------------------------------------------------------------------------------------------------------
  599. // IME (Input Method Editor) basic support for e.g. Asian language users
  600. //--------------------------------------------------------------------------------------------------------
  601. #if defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_APP) // UWP doesn't have Win32 functions
  602. #define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS
  603. #endif
  604. #if defined(_WIN32) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS) && !defined(IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS)
  605. #define HAS_WIN32_IME 1
  606. #include <imm.h>
  607. #ifdef _MSC_VER
  608. #pragma comment(lib, "imm32")
  609. #endif
  610. static void ImGui_ImplWin32_SetImeInputPos(ImGuiViewport* viewport, ImVec2 pos)
  611. {
  612. COMPOSITIONFORM cf = { CFS_FORCE_POSITION,{ (LONG)(pos.x - viewport->Pos.x), (LONG)(pos.y - viewport->Pos.y) },{ 0, 0, 0, 0 } };
  613. if (HWND hwnd = (HWND)viewport->PlatformHandle)
  614. if (HIMC himc = ::ImmGetContext(hwnd))
  615. {
  616. ::ImmSetCompositionWindow(himc, &cf);
  617. ::ImmReleaseContext(hwnd, himc);
  618. }
  619. }
  620. #else
  621. #define HAS_WIN32_IME 0
  622. #endif
  623. //--------------------------------------------------------------------------------------------------------
  624. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  625. // This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports simultaneously.
  626. // 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..
  627. //--------------------------------------------------------------------------------------------------------
  628. // Helper structure we store in the void* RenderUserData field of each ImGuiViewport to easily retrieve our backend data.
  629. struct ImGui_ImplWin32_ViewportData
  630. {
  631. HWND Hwnd;
  632. bool HwndOwned;
  633. DWORD DwStyle;
  634. DWORD DwExStyle;
  635. ImGui_ImplWin32_ViewportData() { Hwnd = NULL; HwndOwned = false; DwStyle = DwExStyle = 0; }
  636. ~ImGui_ImplWin32_ViewportData() { IM_ASSERT(Hwnd == NULL); }
  637. };
  638. static void ImGui_ImplWin32_GetWin32StyleFromViewportFlags(ImGuiViewportFlags flags, DWORD* out_style, DWORD* out_ex_style)
  639. {
  640. if (flags & ImGuiViewportFlags_NoDecoration)
  641. *out_style = WS_POPUP;
  642. else
  643. *out_style = WS_OVERLAPPEDWINDOW;
  644. if (flags & ImGuiViewportFlags_NoTaskBarIcon)
  645. *out_ex_style = WS_EX_TOOLWINDOW;
  646. else
  647. *out_ex_style = WS_EX_APPWINDOW;
  648. if (flags & ImGuiViewportFlags_TopMost)
  649. *out_ex_style |= WS_EX_TOPMOST;
  650. }
  651. static void ImGui_ImplWin32_CreateWindow(ImGuiViewport* viewport)
  652. {
  653. ImGui_ImplWin32_ViewportData* vd = IM_NEW(ImGui_ImplWin32_ViewportData)();
  654. viewport->PlatformUserData = vd;
  655. // Select style and parent window
  656. ImGui_ImplWin32_GetWin32StyleFromViewportFlags(viewport->Flags, &vd->DwStyle, &vd->DwExStyle);
  657. HWND parent_window = NULL;
  658. if (viewport->ParentViewportId != 0)
  659. if (ImGuiViewport* parent_viewport = ImGui::FindViewportByID(viewport->ParentViewportId))
  660. parent_window = (HWND)parent_viewport->PlatformHandle;
  661. // Create window
  662. RECT rect = { (LONG)viewport->Pos.x, (LONG)viewport->Pos.y, (LONG)(viewport->Pos.x + viewport->Size.x), (LONG)(viewport->Pos.y + viewport->Size.y) };
  663. ::AdjustWindowRectEx(&rect, vd->DwStyle, FALSE, vd->DwExStyle);
  664. vd->Hwnd = ::CreateWindowEx(
  665. vd->DwExStyle, _T("ImGui Platform"), _T("Untitled"), vd->DwStyle, // Style, class name, window name
  666. rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top, // Window area
  667. parent_window, NULL, ::GetModuleHandle(NULL), NULL); // Parent window, Menu, Instance, Param
  668. vd->HwndOwned = true;
  669. viewport->PlatformRequestResize = false;
  670. viewport->PlatformHandle = viewport->PlatformHandleRaw = vd->Hwnd;
  671. }
  672. static void ImGui_ImplWin32_DestroyWindow(ImGuiViewport* viewport)
  673. {
  674. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  675. if (ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData)
  676. {
  677. if (::GetCapture() == vd->Hwnd)
  678. {
  679. // Transfer capture so if we started dragging from a window that later disappears, we'll still receive the MOUSEUP event.
  680. ::ReleaseCapture();
  681. ::SetCapture(bd->hWnd);
  682. }
  683. if (vd->Hwnd && vd->HwndOwned)
  684. ::DestroyWindow(vd->Hwnd);
  685. vd->Hwnd = NULL;
  686. IM_DELETE(vd);
  687. }
  688. viewport->PlatformUserData = viewport->PlatformHandle = NULL;
  689. }
  690. static void ImGui_ImplWin32_ShowWindow(ImGuiViewport* viewport)
  691. {
  692. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  693. IM_ASSERT(vd->Hwnd != 0);
  694. if (viewport->Flags & ImGuiViewportFlags_NoFocusOnAppearing)
  695. ::ShowWindow(vd->Hwnd, SW_SHOWNA);
  696. else
  697. ::ShowWindow(vd->Hwnd, SW_SHOW);
  698. }
  699. static void ImGui_ImplWin32_UpdateWindow(ImGuiViewport* viewport)
  700. {
  701. // (Optional) Update Win32 style if it changed _after_ creation.
  702. // Generally they won't change unless configuration flags are changed, but advanced uses (such as manually rewriting viewport flags) make this useful.
  703. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  704. IM_ASSERT(vd->Hwnd != 0);
  705. DWORD new_style;
  706. DWORD new_ex_style;
  707. ImGui_ImplWin32_GetWin32StyleFromViewportFlags(viewport->Flags, &new_style, &new_ex_style);
  708. // Only reapply the flags that have been changed from our point of view (as other flags are being modified by Windows)
  709. if (vd->DwStyle != new_style || vd->DwExStyle != new_ex_style)
  710. {
  711. // (Optional) Update TopMost state if it changed _after_ creation
  712. bool top_most_changed = (vd->DwExStyle & WS_EX_TOPMOST) != (new_ex_style & WS_EX_TOPMOST);
  713. HWND insert_after = top_most_changed ? ((viewport->Flags & ImGuiViewportFlags_TopMost) ? HWND_TOPMOST : HWND_NOTOPMOST) : 0;
  714. UINT swp_flag = top_most_changed ? 0 : SWP_NOZORDER;
  715. // Apply flags and position (since it is affected by flags)
  716. vd->DwStyle = new_style;
  717. vd->DwExStyle = new_ex_style;
  718. ::SetWindowLong(vd->Hwnd, GWL_STYLE, vd->DwStyle);
  719. ::SetWindowLong(vd->Hwnd, GWL_EXSTYLE, vd->DwExStyle);
  720. RECT rect = { (LONG)viewport->Pos.x, (LONG)viewport->Pos.y, (LONG)(viewport->Pos.x + viewport->Size.x), (LONG)(viewport->Pos.y + viewport->Size.y) };
  721. ::AdjustWindowRectEx(&rect, vd->DwStyle, FALSE, vd->DwExStyle); // Client to Screen
  722. ::SetWindowPos(vd->Hwnd, insert_after, rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top, swp_flag | SWP_NOACTIVATE | SWP_FRAMECHANGED);
  723. ::ShowWindow(vd->Hwnd, SW_SHOWNA); // This is necessary when we alter the style
  724. viewport->PlatformRequestMove = viewport->PlatformRequestResize = true;
  725. }
  726. }
  727. static ImVec2 ImGui_ImplWin32_GetWindowPos(ImGuiViewport* viewport)
  728. {
  729. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  730. IM_ASSERT(vd->Hwnd != 0);
  731. POINT pos = { 0, 0 };
  732. ::ClientToScreen(vd->Hwnd, &pos);
  733. return ImVec2((float)pos.x, (float)pos.y);
  734. }
  735. static void ImGui_ImplWin32_SetWindowPos(ImGuiViewport* viewport, ImVec2 pos)
  736. {
  737. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  738. IM_ASSERT(vd->Hwnd != 0);
  739. RECT rect = { (LONG)pos.x, (LONG)pos.y, (LONG)pos.x, (LONG)pos.y };
  740. ::AdjustWindowRectEx(&rect, vd->DwStyle, FALSE, vd->DwExStyle);
  741. ::SetWindowPos(vd->Hwnd, NULL, rect.left, rect.top, 0, 0, SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE);
  742. }
  743. static ImVec2 ImGui_ImplWin32_GetWindowSize(ImGuiViewport* viewport)
  744. {
  745. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  746. IM_ASSERT(vd->Hwnd != 0);
  747. RECT rect;
  748. ::GetClientRect(vd->Hwnd, &rect);
  749. return ImVec2(float(rect.right - rect.left), float(rect.bottom - rect.top));
  750. }
  751. static void ImGui_ImplWin32_SetWindowSize(ImGuiViewport* viewport, ImVec2 size)
  752. {
  753. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  754. IM_ASSERT(vd->Hwnd != 0);
  755. RECT rect = { 0, 0, (LONG)size.x, (LONG)size.y };
  756. ::AdjustWindowRectEx(&rect, vd->DwStyle, FALSE, vd->DwExStyle); // Client to Screen
  757. ::SetWindowPos(vd->Hwnd, NULL, 0, 0, rect.right - rect.left, rect.bottom - rect.top, SWP_NOZORDER | SWP_NOMOVE | SWP_NOACTIVATE);
  758. }
  759. static void ImGui_ImplWin32_SetWindowFocus(ImGuiViewport* viewport)
  760. {
  761. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  762. IM_ASSERT(vd->Hwnd != 0);
  763. ::BringWindowToTop(vd->Hwnd);
  764. ::SetForegroundWindow(vd->Hwnd);
  765. ::SetFocus(vd->Hwnd);
  766. }
  767. static bool ImGui_ImplWin32_GetWindowFocus(ImGuiViewport* viewport)
  768. {
  769. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  770. IM_ASSERT(vd->Hwnd != 0);
  771. return ::GetForegroundWindow() == vd->Hwnd;
  772. }
  773. static bool ImGui_ImplWin32_GetWindowMinimized(ImGuiViewport* viewport)
  774. {
  775. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  776. IM_ASSERT(vd->Hwnd != 0);
  777. return ::IsIconic(vd->Hwnd) != 0;
  778. }
  779. static void ImGui_ImplWin32_SetWindowTitle(ImGuiViewport* viewport, const char* title)
  780. {
  781. // ::SetWindowTextA() doesn't properly handle UTF-8 so we explicitely convert our string.
  782. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  783. IM_ASSERT(vd->Hwnd != 0);
  784. int n = ::MultiByteToWideChar(CP_UTF8, 0, title, -1, NULL, 0);
  785. ImVector<wchar_t> title_w;
  786. title_w.resize(n);
  787. ::MultiByteToWideChar(CP_UTF8, 0, title, -1, title_w.Data, n);
  788. ::SetWindowTextW(vd->Hwnd, title_w.Data);
  789. }
  790. static void ImGui_ImplWin32_SetWindowAlpha(ImGuiViewport* viewport, float alpha)
  791. {
  792. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  793. IM_ASSERT(vd->Hwnd != 0);
  794. IM_ASSERT(alpha >= 0.0f && alpha <= 1.0f);
  795. if (alpha < 1.0f)
  796. {
  797. DWORD style = ::GetWindowLongW(vd->Hwnd, GWL_EXSTYLE) | WS_EX_LAYERED;
  798. ::SetWindowLongW(vd->Hwnd, GWL_EXSTYLE, style);
  799. ::SetLayeredWindowAttributes(vd->Hwnd, 0, (BYTE)(255 * alpha), LWA_ALPHA);
  800. }
  801. else
  802. {
  803. DWORD style = ::GetWindowLongW(vd->Hwnd, GWL_EXSTYLE) & ~WS_EX_LAYERED;
  804. ::SetWindowLongW(vd->Hwnd, GWL_EXSTYLE, style);
  805. }
  806. }
  807. static float ImGui_ImplWin32_GetWindowDpiScale(ImGuiViewport* viewport)
  808. {
  809. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  810. IM_ASSERT(vd->Hwnd != 0);
  811. return ImGui_ImplWin32_GetDpiScaleForHwnd(vd->Hwnd);
  812. }
  813. // FIXME-DPI: Testing DPI related ideas
  814. static void ImGui_ImplWin32_OnChangedViewport(ImGuiViewport* viewport)
  815. {
  816. (void)viewport;
  817. #if 0
  818. ImGuiStyle default_style;
  819. //default_style.WindowPadding = ImVec2(0, 0);
  820. //default_style.WindowBorderSize = 0.0f;
  821. //default_style.ItemSpacing.y = 3.0f;
  822. //default_style.FramePadding = ImVec2(0, 0);
  823. default_style.ScaleAllSizes(viewport->DpiScale);
  824. ImGuiStyle& style = ImGui::GetStyle();
  825. style = default_style;
  826. #endif
  827. }
  828. static LRESULT CALLBACK ImGui_ImplWin32_WndProcHandler_PlatformWindow(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)
  829. {
  830. if (ImGui_ImplWin32_WndProcHandler(hWnd, msg, wParam, lParam))
  831. return true;
  832. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle((void*)hWnd))
  833. {
  834. switch (msg)
  835. {
  836. case WM_CLOSE:
  837. viewport->PlatformRequestClose = true;
  838. return 0;
  839. case WM_MOVE:
  840. viewport->PlatformRequestMove = true;
  841. break;
  842. case WM_SIZE:
  843. viewport->PlatformRequestResize = true;
  844. break;
  845. case WM_MOUSEACTIVATE:
  846. if (viewport->Flags & ImGuiViewportFlags_NoFocusOnClick)
  847. return MA_NOACTIVATE;
  848. break;
  849. case WM_NCHITTEST:
  850. // Let mouse pass-through the window. This will allow the backend to set io.MouseHoveredViewport properly (which is OPTIONAL).
  851. // The ImGuiViewportFlags_NoInputs flag is set while dragging a viewport, as want to detect the window behind the one we are dragging.
  852. // If you cannot easily access those viewport flags from your windowing/event code: you may manually synchronize its state e.g. in
  853. // your main loop after calling UpdatePlatformWindows(). Iterate all viewports/platform windows and pass the flag to your windowing system.
  854. if (viewport->Flags & ImGuiViewportFlags_NoInputs)
  855. return HTTRANSPARENT;
  856. break;
  857. }
  858. }
  859. return DefWindowProc(hWnd, msg, wParam, lParam);
  860. }
  861. static void ImGui_ImplWin32_InitPlatformInterface()
  862. {
  863. WNDCLASSEX wcex;
  864. wcex.cbSize = sizeof(WNDCLASSEX);
  865. wcex.style = CS_HREDRAW | CS_VREDRAW;
  866. wcex.lpfnWndProc = ImGui_ImplWin32_WndProcHandler_PlatformWindow;
  867. wcex.cbClsExtra = 0;
  868. wcex.cbWndExtra = 0;
  869. wcex.hInstance = ::GetModuleHandle(NULL);
  870. wcex.hIcon = NULL;
  871. wcex.hCursor = NULL;
  872. wcex.hbrBackground = (HBRUSH)(COLOR_BACKGROUND + 1);
  873. wcex.lpszMenuName = NULL;
  874. wcex.lpszClassName = _T("ImGui Platform");
  875. wcex.hIconSm = NULL;
  876. ::RegisterClassEx(&wcex);
  877. ImGui_ImplWin32_UpdateMonitors();
  878. // Register platform interface (will be coupled with a renderer interface)
  879. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  880. platform_io.Platform_CreateWindow = ImGui_ImplWin32_CreateWindow;
  881. platform_io.Platform_DestroyWindow = ImGui_ImplWin32_DestroyWindow;
  882. platform_io.Platform_ShowWindow = ImGui_ImplWin32_ShowWindow;
  883. platform_io.Platform_SetWindowPos = ImGui_ImplWin32_SetWindowPos;
  884. platform_io.Platform_GetWindowPos = ImGui_ImplWin32_GetWindowPos;
  885. platform_io.Platform_SetWindowSize = ImGui_ImplWin32_SetWindowSize;
  886. platform_io.Platform_GetWindowSize = ImGui_ImplWin32_GetWindowSize;
  887. platform_io.Platform_SetWindowFocus = ImGui_ImplWin32_SetWindowFocus;
  888. platform_io.Platform_GetWindowFocus = ImGui_ImplWin32_GetWindowFocus;
  889. platform_io.Platform_GetWindowMinimized = ImGui_ImplWin32_GetWindowMinimized;
  890. platform_io.Platform_SetWindowTitle = ImGui_ImplWin32_SetWindowTitle;
  891. platform_io.Platform_SetWindowAlpha = ImGui_ImplWin32_SetWindowAlpha;
  892. platform_io.Platform_UpdateWindow = ImGui_ImplWin32_UpdateWindow;
  893. platform_io.Platform_GetWindowDpiScale = ImGui_ImplWin32_GetWindowDpiScale; // FIXME-DPI
  894. platform_io.Platform_OnChangedViewport = ImGui_ImplWin32_OnChangedViewport; // FIXME-DPI
  895. #if HAS_WIN32_IME
  896. platform_io.Platform_SetImeInputPos = ImGui_ImplWin32_SetImeInputPos;
  897. #endif
  898. // Register main window handle (which is owned by the main application, not by us)
  899. // 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.
  900. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  901. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  902. ImGui_ImplWin32_ViewportData* vd = IM_NEW(ImGui_ImplWin32_ViewportData)();
  903. vd->Hwnd = bd->hWnd;
  904. vd->HwndOwned = false;
  905. main_viewport->PlatformUserData = vd;
  906. main_viewport->PlatformHandle = (void*)bd->hWnd;
  907. }
  908. static void ImGui_ImplWin32_ShutdownPlatformInterface()
  909. {
  910. ::UnregisterClass(_T("ImGui Platform"), ::GetModuleHandle(NULL));
  911. }
  912. //---------------------------------------------------------------------------------------------------------
  913. // Transparency related helpers (optional)
  914. //--------------------------------------------------------------------------------------------------------
  915. #if defined(_MSC_VER)
  916. #pragma comment(lib, "dwmapi") // Link with dwmapi.lib. MinGW will require linking with '-ldwmapi'
  917. #endif
  918. // [experimental]
  919. // Borrowed from GLFW's function updateFramebufferTransparency() in src/win32_window.c
  920. // (the Dwm* functions are Vista era functions but we are borrowing logic from GLFW)
  921. void ImGui_ImplWin32_EnableAlphaCompositing(void* hwnd)
  922. {
  923. if (!_IsWindowsVistaOrGreater())
  924. return;
  925. BOOL composition;
  926. if (FAILED(::DwmIsCompositionEnabled(&composition)) || !composition)
  927. return;
  928. BOOL opaque;
  929. DWORD color;
  930. if (_IsWindows8OrGreater() || (SUCCEEDED(::DwmGetColorizationColor(&color, &opaque)) && !opaque))
  931. {
  932. HRGN region = ::CreateRectRgn(0, 0, -1, -1);
  933. DWM_BLURBEHIND bb = {};
  934. bb.dwFlags = DWM_BB_ENABLE | DWM_BB_BLURREGION;
  935. bb.hRgnBlur = region;
  936. bb.fEnable = TRUE;
  937. ::DwmEnableBlurBehindWindow((HWND)hwnd, &bb);
  938. ::DeleteObject(region);
  939. }
  940. else
  941. {
  942. DWM_BLURBEHIND bb = {};
  943. bb.dwFlags = DWM_BB_ENABLE;
  944. ::DwmEnableBlurBehindWindow((HWND)hwnd, &bb);
  945. }
  946. }
  947. //---------------------------------------------------------------------------------------------------------