imgui_impl_win32.cpp 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818
  1. // dear imgui: Platform Backend for Windows (standard windows API for 32-bits 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 support. Can discriminate Mouse/TouchScreen/Pen.
  6. // [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 VK_* values will also be supported unless IMGUI_DISABLE_OBSOLETE_KEYIO is set]
  7. // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
  8. // [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  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 <windowsx.h> // GET_X_LPARAM(), GET_Y_LPARAM()
  20. #include <tchar.h>
  21. #include <dwmapi.h>
  22. // Configuration flags to add in your imconfig.h file:
  23. //#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.
  24. // Using XInput for gamepad (will load DLL dynamically)
  25. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  26. #include <xinput.h>
  27. typedef DWORD (WINAPI *PFN_XInputGetCapabilities)(DWORD, DWORD, XINPUT_CAPABILITIES*);
  28. typedef DWORD (WINAPI *PFN_XInputGetState)(DWORD, XINPUT_STATE*);
  29. #endif
  30. // CHANGELOG
  31. // (minor and older changes stripped away, please see git history for details)
  32. // 2023-04-04: Inputs: Added support for io.AddMouseSourceEvent() to discriminate ImGuiMouseSource_Mouse/ImGuiMouseSource_TouchScreen/ImGuiMouseSource_Pen. (#2702)
  33. // 2023-02-15: Inputs: Use WM_NCMOUSEMOVE / WM_NCMOUSELEAVE to track mouse position over non-client area (e.g. OS decorations) when app is not focused. (#6045, #6162)
  34. // 2023-02-02: Inputs: Flipping WM_MOUSEHWHEEL (horizontal mouse-wheel) value to match other backends and offer consistent horizontal scrolling direction. (#4019, #6096, #1463)
  35. // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
  36. // 2022-09-28: Inputs: Convert WM_CHAR values with MultiByteToWideChar() when window class was registered as MBCS (not Unicode).
  37. // 2022-09-26: Inputs: Renamed ImGuiKey_ModXXX introduced in 1.87 to ImGuiMod_XXX (old names still supported).
  38. // 2022-01-26: Inputs: replaced short-lived io.AddKeyModsEvent() (added two weeks ago) with io.AddKeyEvent() using ImGuiKey_ModXXX flags. Sorry for the confusion.
  39. // 2021-01-20: Inputs: calling new io.AddKeyAnalogEvent() for gamepad support, instead of writing directly to io.NavInputs[].
  40. // 2022-01-17: Inputs: calling new io.AddMousePosEvent(), io.AddMouseButtonEvent(), io.AddMouseWheelEvent() API (1.87+).
  41. // 2022-01-17: Inputs: always update key mods next and before a key event (not in NewFrame) to fix input queue with very low framerates.
  42. // 2022-01-12: Inputs: Update mouse inputs using WM_MOUSEMOVE/WM_MOUSELEAVE + fallback to provide it when focused but not hovered/captured. More standard and will allow us to pass it to future input queue API.
  43. // 2022-01-12: Inputs: Maintain our own copy of MouseButtonsDown mask instead of using ImGui::IsAnyMouseDown() which will be obsoleted.
  44. // 2022-01-10: Inputs: calling new io.AddKeyEvent(), io.AddKeyModsEvent() + io.SetKeyEventNativeData() API (1.87+). Support for full ImGuiKey range.
  45. // 2021-12-16: Inputs: Fill VK_LCONTROL/VK_RCONTROL/VK_LSHIFT/VK_RSHIFT/VK_LMENU/VK_RMENU for completeness.
  46. // 2021-08-17: Calling io.AddFocusEvent() on WM_SETFOCUS/WM_KILLFOCUS messages.
  47. // 2021-08-02: Inputs: Fixed keyboard modifiers being reported when host window doesn't have focus.
  48. // 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).
  49. // 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).
  50. // 2021-06-08: Fixed 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).
  51. // 2021-03-23: Inputs: Clearing keyboard down array when losing focus (WM_KILLFOCUS).
  52. // 2021-02-18: Added ImGui_ImplWin32_EnableAlphaCompositing(). Non Visual Studio users will need to link with dwmapi.lib (MinGW/gcc: use -ldwmapi).
  53. // 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.
  54. // 2021-01-25: Inputs: Dynamically loading XInput DLL.
  55. // 2020-12-04: Misc: Fixed setting of io.DisplaySize to invalid/uninitialized data when after hwnd has been closed.
  56. // 2020-03-03: Inputs: Calling AddInputCharacterUTF16() to support surrogate pairs leading to codepoint >= 0x10000 (for more complete CJK inputs)
  57. // 2020-02-17: Added ImGui_ImplWin32_EnableDpiAwareness(), ImGui_ImplWin32_GetDpiScaleForHwnd(), ImGui_ImplWin32_GetDpiScaleForMonitor() helper functions.
  58. // 2020-01-14: Inputs: Added support for #define IMGUI_IMPL_WIN32_DISABLE_GAMEPAD/IMGUI_IMPL_WIN32_DISABLE_LINKING_XINPUT.
  59. // 2019-12-05: Inputs: Added support for ImGuiMouseCursor_NotAllowed mouse cursor.
  60. // 2019-05-11: Inputs: Don't filter value from WM_CHAR before calling AddInputCharacter().
  61. // 2019-01-17: Misc: Using GetForegroundWindow()+IsChild() instead of GetActiveWindow() to be compatible with windows created in a different thread or parent.
  62. // 2019-01-17: Inputs: Added support for mouse buttons 4 and 5 via WM_XBUTTON* messages.
  63. // 2019-01-15: Inputs: Added support for XInput gamepads (if ImGuiConfigFlags_NavEnableGamepad is set by user application).
  64. // 2018-11-30: Misc: Setting up io.BackendPlatformName so it can be displayed in the About Window.
  65. // 2018-06-29: Inputs: Added support for the ImGuiMouseCursor_Hand cursor.
  66. // 2018-06-10: Inputs: Fixed handling of mouse wheel messages to support fine position messages (typically sent by track-pads).
  67. // 2018-06-08: Misc: Extracted imgui_impl_win32.cpp/.h away from the old combined DX9/DX10/DX11/DX12 examples.
  68. // 2018-03-20: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors and ImGuiBackendFlags_HasSetMousePos flags + honor ImGuiConfigFlags_NoMouseCursorChange flag.
  69. // 2018-02-20: Inputs: Added support for mouse cursors (ImGui::GetMouseCursor() value and WM_SETCURSOR message handling).
  70. // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
  71. // 2018-02-06: Inputs: Honoring the io.WantSetMousePos by repositioning the mouse (when using navigation and ImGuiConfigFlags_NavMoveMouse is set).
  72. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  73. // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
  74. // 2018-01-08: Inputs: Added mapping for ImGuiKey_Insert.
  75. // 2018-01-05: Inputs: Added WM_LBUTTONDBLCLK double-click handlers for window classes with the CS_DBLCLKS flag.
  76. // 2017-10-23: Inputs: Added WM_SYSKEYDOWN / WM_SYSKEYUP handlers so e.g. the VK_MENU key can be read.
  77. // 2017-10-23: Inputs: Using Win32 ::SetCapture/::GetCapture() to retrieve mouse positions outside the client area when dragging.
  78. // 2016-11-12: Inputs: Only call Win32 ::SetCursor(nullptr) when io.MouseDrawCursor is set.
  79. struct ImGui_ImplWin32_Data
  80. {
  81. HWND hWnd;
  82. HWND MouseHwnd;
  83. int MouseTrackedArea; // 0: not tracked, 1: client are, 2: non-client area
  84. int MouseButtonsDown;
  85. INT64 Time;
  86. INT64 TicksPerSecond;
  87. ImGuiMouseCursor LastMouseCursor;
  88. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  89. bool HasGamepad;
  90. bool WantUpdateHasGamepad;
  91. HMODULE XInputDLL;
  92. PFN_XInputGetCapabilities XInputGetCapabilities;
  93. PFN_XInputGetState XInputGetState;
  94. #endif
  95. ImGui_ImplWin32_Data() { memset((void*)this, 0, sizeof(*this)); }
  96. };
  97. // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts
  98. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  99. // FIXME: multi-context support is not well tested and probably dysfunctional in this backend.
  100. // FIXME: some shared resources (mouse cursor shape, gamepad) are mishandled when using multi-context.
  101. static ImGui_ImplWin32_Data* ImGui_ImplWin32_GetBackendData()
  102. {
  103. return ImGui::GetCurrentContext() ? (ImGui_ImplWin32_Data*)ImGui::GetIO().BackendPlatformUserData : nullptr;
  104. }
  105. // Functions
  106. static bool ImGui_ImplWin32_Init(void* hwnd, bool platformHasOwnDC)
  107. {
  108. ImGuiIO& io = ImGui::GetIO();
  109. IM_ASSERT(io.BackendPlatformUserData == nullptr && "Already initialized a platform backend!");
  110. INT64 perf_frequency, perf_counter;
  111. if (!::QueryPerformanceFrequency((LARGE_INTEGER*)&perf_frequency))
  112. return false;
  113. if (!::QueryPerformanceCounter((LARGE_INTEGER*)&perf_counter))
  114. return false;
  115. // Setup backend capabilities flags
  116. ImGui_ImplWin32_Data* bd = IM_NEW(ImGui_ImplWin32_Data)();
  117. io.BackendPlatformUserData = (void*)bd;
  118. io.BackendPlatformName = "imgui_impl_win32";
  119. io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
  120. io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
  121. bd->hWnd = (HWND)hwnd;
  122. bd->TicksPerSecond = perf_frequency;
  123. bd->Time = perf_counter;
  124. bd->LastMouseCursor = ImGuiMouseCursor_COUNT;
  125. // Set platform dependent data in viewport
  126. ImGui::GetMainViewport()->PlatformHandleRaw = (void*)hwnd;
  127. IM_UNUSED(platformHasOwnDC); // Used in 'docking' branch
  128. // Dynamically load XInput library
  129. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  130. bd->WantUpdateHasGamepad = true;
  131. const char* xinput_dll_names[] =
  132. {
  133. "xinput1_4.dll", // Windows 8+
  134. "xinput1_3.dll", // DirectX SDK
  135. "xinput9_1_0.dll", // Windows Vista, Windows 7
  136. "xinput1_2.dll", // DirectX SDK
  137. "xinput1_1.dll" // DirectX SDK
  138. };
  139. for (int n = 0; n < IM_ARRAYSIZE(xinput_dll_names); n++)
  140. if (HMODULE dll = ::LoadLibraryA(xinput_dll_names[n]))
  141. {
  142. bd->XInputDLL = dll;
  143. bd->XInputGetCapabilities = (PFN_XInputGetCapabilities)::GetProcAddress(dll, "XInputGetCapabilities");
  144. bd->XInputGetState = (PFN_XInputGetState)::GetProcAddress(dll, "XInputGetState");
  145. break;
  146. }
  147. #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  148. return true;
  149. }
  150. IMGUI_IMPL_API bool ImGui_ImplWin32_Init(void* hwnd)
  151. {
  152. return ImGui_ImplWin32_Init(hwnd, false);
  153. }
  154. IMGUI_IMPL_API bool ImGui_ImplWin32_InitForOpenGL(void* hwnd)
  155. {
  156. // OpenGL needs CS_OWNDC
  157. return ImGui_ImplWin32_Init(hwnd, true);
  158. }
  159. void ImGui_ImplWin32_Shutdown()
  160. {
  161. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  162. IM_ASSERT(bd != nullptr && "No platform backend to shutdown, or already shutdown?");
  163. ImGuiIO& io = ImGui::GetIO();
  164. // Unload XInput library
  165. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  166. if (bd->XInputDLL)
  167. ::FreeLibrary(bd->XInputDLL);
  168. #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  169. io.BackendPlatformName = nullptr;
  170. io.BackendPlatformUserData = nullptr;
  171. io.BackendFlags &= ~(ImGuiBackendFlags_HasMouseCursors | ImGuiBackendFlags_HasSetMousePos | ImGuiBackendFlags_HasGamepad);
  172. IM_DELETE(bd);
  173. }
  174. static bool ImGui_ImplWin32_UpdateMouseCursor()
  175. {
  176. ImGuiIO& io = ImGui::GetIO();
  177. if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
  178. return false;
  179. ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
  180. if (imgui_cursor == ImGuiMouseCursor_None || io.MouseDrawCursor)
  181. {
  182. // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
  183. ::SetCursor(nullptr);
  184. }
  185. else
  186. {
  187. // Show OS mouse cursor
  188. LPTSTR win32_cursor = IDC_ARROW;
  189. switch (imgui_cursor)
  190. {
  191. case ImGuiMouseCursor_Arrow: win32_cursor = IDC_ARROW; break;
  192. case ImGuiMouseCursor_TextInput: win32_cursor = IDC_IBEAM; break;
  193. case ImGuiMouseCursor_ResizeAll: win32_cursor = IDC_SIZEALL; break;
  194. case ImGuiMouseCursor_ResizeEW: win32_cursor = IDC_SIZEWE; break;
  195. case ImGuiMouseCursor_ResizeNS: win32_cursor = IDC_SIZENS; break;
  196. case ImGuiMouseCursor_ResizeNESW: win32_cursor = IDC_SIZENESW; break;
  197. case ImGuiMouseCursor_ResizeNWSE: win32_cursor = IDC_SIZENWSE; break;
  198. case ImGuiMouseCursor_Hand: win32_cursor = IDC_HAND; break;
  199. case ImGuiMouseCursor_NotAllowed: win32_cursor = IDC_NO; break;
  200. }
  201. ::SetCursor(::LoadCursor(nullptr, win32_cursor));
  202. }
  203. return true;
  204. }
  205. static bool IsVkDown(int vk)
  206. {
  207. return (::GetKeyState(vk) & 0x8000) != 0;
  208. }
  209. static void ImGui_ImplWin32_AddKeyEvent(ImGuiKey key, bool down, int native_keycode, int native_scancode = -1)
  210. {
  211. ImGuiIO& io = ImGui::GetIO();
  212. io.AddKeyEvent(key, down);
  213. io.SetKeyEventNativeData(key, native_keycode, native_scancode); // To support legacy indexing (<1.87 user code)
  214. IM_UNUSED(native_scancode);
  215. }
  216. static void ImGui_ImplWin32_ProcessKeyEventsWorkarounds()
  217. {
  218. // Left & right Shift keys: when both are pressed together, Windows tend to not generate the WM_KEYUP event for the first released one.
  219. if (ImGui::IsKeyDown(ImGuiKey_LeftShift) && !IsVkDown(VK_LSHIFT))
  220. ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftShift, false, VK_LSHIFT);
  221. if (ImGui::IsKeyDown(ImGuiKey_RightShift) && !IsVkDown(VK_RSHIFT))
  222. ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightShift, false, VK_RSHIFT);
  223. // Sometimes WM_KEYUP for Win key is not passed down to the app (e.g. for Win+V on some setups, according to GLFW).
  224. if (ImGui::IsKeyDown(ImGuiKey_LeftSuper) && !IsVkDown(VK_LWIN))
  225. ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftSuper, false, VK_LWIN);
  226. if (ImGui::IsKeyDown(ImGuiKey_RightSuper) && !IsVkDown(VK_RWIN))
  227. ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightSuper, false, VK_RWIN);
  228. }
  229. static void ImGui_ImplWin32_UpdateKeyModifiers()
  230. {
  231. ImGuiIO& io = ImGui::GetIO();
  232. io.AddKeyEvent(ImGuiMod_Ctrl, IsVkDown(VK_CONTROL));
  233. io.AddKeyEvent(ImGuiMod_Shift, IsVkDown(VK_SHIFT));
  234. io.AddKeyEvent(ImGuiMod_Alt, IsVkDown(VK_MENU));
  235. io.AddKeyEvent(ImGuiMod_Super, IsVkDown(VK_APPS));
  236. }
  237. static void ImGui_ImplWin32_UpdateMouseData()
  238. {
  239. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  240. ImGuiIO& io = ImGui::GetIO();
  241. IM_ASSERT(bd->hWnd != 0);
  242. HWND focused_window = ::GetForegroundWindow();
  243. const bool is_app_focused = (focused_window == bd->hWnd);
  244. if (is_app_focused)
  245. {
  246. // (Optional) Set OS mouse position from Dear ImGui if requested (rarely used, only when ImGuiConfigFlags_NavEnableSetMousePos is enabled by user)
  247. if (io.WantSetMousePos)
  248. {
  249. POINT pos = { (int)io.MousePos.x, (int)io.MousePos.y };
  250. if (::ClientToScreen(bd->hWnd, &pos))
  251. ::SetCursorPos(pos.x, pos.y);
  252. }
  253. // (Optional) Fallback to provide mouse position when focused (WM_MOUSEMOVE already provides this when hovered or captured)
  254. // This also fills a short gap when clicking non-client area: WM_NCMOUSELEAVE -> modal OS move -> gap -> WM_NCMOUSEMOVE
  255. if (!io.WantSetMousePos && bd->MouseTrackedArea == 0)
  256. {
  257. POINT pos;
  258. if (::GetCursorPos(&pos) && ::ScreenToClient(bd->hWnd, &pos))
  259. io.AddMousePosEvent((float)pos.x, (float)pos.y);
  260. }
  261. }
  262. }
  263. // Gamepad navigation mapping
  264. static void ImGui_ImplWin32_UpdateGamepads()
  265. {
  266. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  267. ImGuiIO& io = ImGui::GetIO();
  268. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  269. //if ((io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) == 0) // FIXME: Technically feeding gamepad shouldn't depend on this now that they are regular inputs.
  270. // return;
  271. // Calling XInputGetState() every frame on disconnected gamepads is unfortunately too slow.
  272. // Instead we refresh gamepad availability by calling XInputGetCapabilities() _only_ after receiving WM_DEVICECHANGE.
  273. if (bd->WantUpdateHasGamepad)
  274. {
  275. XINPUT_CAPABILITIES caps = {};
  276. bd->HasGamepad = bd->XInputGetCapabilities ? (bd->XInputGetCapabilities(0, XINPUT_FLAG_GAMEPAD, &caps) == ERROR_SUCCESS) : false;
  277. bd->WantUpdateHasGamepad = false;
  278. }
  279. io.BackendFlags &= ~ImGuiBackendFlags_HasGamepad;
  280. XINPUT_STATE xinput_state;
  281. XINPUT_GAMEPAD& gamepad = xinput_state.Gamepad;
  282. if (!bd->HasGamepad || bd->XInputGetState == nullptr || bd->XInputGetState(0, &xinput_state) != ERROR_SUCCESS)
  283. return;
  284. io.BackendFlags |= ImGuiBackendFlags_HasGamepad;
  285. #define IM_SATURATE(V) (V < 0.0f ? 0.0f : V > 1.0f ? 1.0f : V)
  286. #define MAP_BUTTON(KEY_NO, BUTTON_ENUM) { io.AddKeyEvent(KEY_NO, (gamepad.wButtons & BUTTON_ENUM) != 0); }
  287. #define MAP_ANALOG(KEY_NO, VALUE, V0, V1) { float vn = (float)(VALUE - V0) / (float)(V1 - V0); io.AddKeyAnalogEvent(KEY_NO, vn > 0.10f, IM_SATURATE(vn)); }
  288. MAP_BUTTON(ImGuiKey_GamepadStart, XINPUT_GAMEPAD_START);
  289. MAP_BUTTON(ImGuiKey_GamepadBack, XINPUT_GAMEPAD_BACK);
  290. MAP_BUTTON(ImGuiKey_GamepadFaceLeft, XINPUT_GAMEPAD_X);
  291. MAP_BUTTON(ImGuiKey_GamepadFaceRight, XINPUT_GAMEPAD_B);
  292. MAP_BUTTON(ImGuiKey_GamepadFaceUp, XINPUT_GAMEPAD_Y);
  293. MAP_BUTTON(ImGuiKey_GamepadFaceDown, XINPUT_GAMEPAD_A);
  294. MAP_BUTTON(ImGuiKey_GamepadDpadLeft, XINPUT_GAMEPAD_DPAD_LEFT);
  295. MAP_BUTTON(ImGuiKey_GamepadDpadRight, XINPUT_GAMEPAD_DPAD_RIGHT);
  296. MAP_BUTTON(ImGuiKey_GamepadDpadUp, XINPUT_GAMEPAD_DPAD_UP);
  297. MAP_BUTTON(ImGuiKey_GamepadDpadDown, XINPUT_GAMEPAD_DPAD_DOWN);
  298. MAP_BUTTON(ImGuiKey_GamepadL1, XINPUT_GAMEPAD_LEFT_SHOULDER);
  299. MAP_BUTTON(ImGuiKey_GamepadR1, XINPUT_GAMEPAD_RIGHT_SHOULDER);
  300. MAP_ANALOG(ImGuiKey_GamepadL2, gamepad.bLeftTrigger, XINPUT_GAMEPAD_TRIGGER_THRESHOLD, 255);
  301. MAP_ANALOG(ImGuiKey_GamepadR2, gamepad.bRightTrigger, XINPUT_GAMEPAD_TRIGGER_THRESHOLD, 255);
  302. MAP_BUTTON(ImGuiKey_GamepadL3, XINPUT_GAMEPAD_LEFT_THUMB);
  303. MAP_BUTTON(ImGuiKey_GamepadR3, XINPUT_GAMEPAD_RIGHT_THUMB);
  304. MAP_ANALOG(ImGuiKey_GamepadLStickLeft, gamepad.sThumbLX, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
  305. MAP_ANALOG(ImGuiKey_GamepadLStickRight, gamepad.sThumbLX, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  306. MAP_ANALOG(ImGuiKey_GamepadLStickUp, gamepad.sThumbLY, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  307. MAP_ANALOG(ImGuiKey_GamepadLStickDown, gamepad.sThumbLY, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
  308. MAP_ANALOG(ImGuiKey_GamepadRStickLeft, gamepad.sThumbRX, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
  309. MAP_ANALOG(ImGuiKey_GamepadRStickRight, gamepad.sThumbRX, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  310. MAP_ANALOG(ImGuiKey_GamepadRStickUp, gamepad.sThumbRY, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  311. MAP_ANALOG(ImGuiKey_GamepadRStickDown, gamepad.sThumbRY, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
  312. #undef MAP_BUTTON
  313. #undef MAP_ANALOG
  314. #endif // #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  315. }
  316. void ImGui_ImplWin32_NewFrame()
  317. {
  318. ImGuiIO& io = ImGui::GetIO();
  319. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  320. IM_ASSERT(bd != nullptr && "Did you call ImGui_ImplWin32_Init()?");
  321. // Setup display size (every frame to accommodate for window resizing)
  322. RECT rect = { 0, 0, 0, 0 };
  323. ::GetClientRect(bd->hWnd, &rect);
  324. io.DisplaySize = ImVec2((float)(rect.right - rect.left), (float)(rect.bottom - rect.top));
  325. // Setup time step
  326. INT64 current_time = 0;
  327. ::QueryPerformanceCounter((LARGE_INTEGER*)&current_time);
  328. io.DeltaTime = (float)(current_time - bd->Time) / bd->TicksPerSecond;
  329. bd->Time = current_time;
  330. // Update OS mouse position
  331. ImGui_ImplWin32_UpdateMouseData();
  332. // Process workarounds for known Windows key handling issues
  333. ImGui_ImplWin32_ProcessKeyEventsWorkarounds();
  334. // Update OS mouse cursor with the cursor requested by imgui
  335. ImGuiMouseCursor mouse_cursor = io.MouseDrawCursor ? ImGuiMouseCursor_None : ImGui::GetMouseCursor();
  336. if (bd->LastMouseCursor != mouse_cursor)
  337. {
  338. bd->LastMouseCursor = mouse_cursor;
  339. ImGui_ImplWin32_UpdateMouseCursor();
  340. }
  341. // Update game controllers (if enabled and available)
  342. ImGui_ImplWin32_UpdateGamepads();
  343. }
  344. // There is no distinct VK_xxx for keypad enter, instead it is VK_RETURN + KF_EXTENDED, we assign it an arbitrary value to make code more readable (VK_ codes go up to 255)
  345. #define IM_VK_KEYPAD_ENTER (VK_RETURN + 256)
  346. // Map VK_xxx to ImGuiKey_xxx.
  347. static ImGuiKey ImGui_ImplWin32_VirtualKeyToImGuiKey(WPARAM wParam)
  348. {
  349. switch (wParam)
  350. {
  351. case VK_TAB: return ImGuiKey_Tab;
  352. case VK_LEFT: return ImGuiKey_LeftArrow;
  353. case VK_RIGHT: return ImGuiKey_RightArrow;
  354. case VK_UP: return ImGuiKey_UpArrow;
  355. case VK_DOWN: return ImGuiKey_DownArrow;
  356. case VK_PRIOR: return ImGuiKey_PageUp;
  357. case VK_NEXT: return ImGuiKey_PageDown;
  358. case VK_HOME: return ImGuiKey_Home;
  359. case VK_END: return ImGuiKey_End;
  360. case VK_INSERT: return ImGuiKey_Insert;
  361. case VK_DELETE: return ImGuiKey_Delete;
  362. case VK_BACK: return ImGuiKey_Backspace;
  363. case VK_SPACE: return ImGuiKey_Space;
  364. case VK_RETURN: return ImGuiKey_Enter;
  365. case VK_ESCAPE: return ImGuiKey_Escape;
  366. case VK_OEM_7: return ImGuiKey_Apostrophe;
  367. case VK_OEM_COMMA: return ImGuiKey_Comma;
  368. case VK_OEM_MINUS: return ImGuiKey_Minus;
  369. case VK_OEM_PERIOD: return ImGuiKey_Period;
  370. case VK_OEM_2: return ImGuiKey_Slash;
  371. case VK_OEM_1: return ImGuiKey_Semicolon;
  372. case VK_OEM_PLUS: return ImGuiKey_Equal;
  373. case VK_OEM_4: return ImGuiKey_LeftBracket;
  374. case VK_OEM_5: return ImGuiKey_Backslash;
  375. case VK_OEM_6: return ImGuiKey_RightBracket;
  376. case VK_OEM_3: return ImGuiKey_GraveAccent;
  377. case VK_CAPITAL: return ImGuiKey_CapsLock;
  378. case VK_SCROLL: return ImGuiKey_ScrollLock;
  379. case VK_NUMLOCK: return ImGuiKey_NumLock;
  380. case VK_SNAPSHOT: return ImGuiKey_PrintScreen;
  381. case VK_PAUSE: return ImGuiKey_Pause;
  382. case VK_NUMPAD0: return ImGuiKey_Keypad0;
  383. case VK_NUMPAD1: return ImGuiKey_Keypad1;
  384. case VK_NUMPAD2: return ImGuiKey_Keypad2;
  385. case VK_NUMPAD3: return ImGuiKey_Keypad3;
  386. case VK_NUMPAD4: return ImGuiKey_Keypad4;
  387. case VK_NUMPAD5: return ImGuiKey_Keypad5;
  388. case VK_NUMPAD6: return ImGuiKey_Keypad6;
  389. case VK_NUMPAD7: return ImGuiKey_Keypad7;
  390. case VK_NUMPAD8: return ImGuiKey_Keypad8;
  391. case VK_NUMPAD9: return ImGuiKey_Keypad9;
  392. case VK_DECIMAL: return ImGuiKey_KeypadDecimal;
  393. case VK_DIVIDE: return ImGuiKey_KeypadDivide;
  394. case VK_MULTIPLY: return ImGuiKey_KeypadMultiply;
  395. case VK_SUBTRACT: return ImGuiKey_KeypadSubtract;
  396. case VK_ADD: return ImGuiKey_KeypadAdd;
  397. case IM_VK_KEYPAD_ENTER: return ImGuiKey_KeypadEnter;
  398. case VK_LSHIFT: return ImGuiKey_LeftShift;
  399. case VK_LCONTROL: return ImGuiKey_LeftCtrl;
  400. case VK_LMENU: return ImGuiKey_LeftAlt;
  401. case VK_LWIN: return ImGuiKey_LeftSuper;
  402. case VK_RSHIFT: return ImGuiKey_RightShift;
  403. case VK_RCONTROL: return ImGuiKey_RightCtrl;
  404. case VK_RMENU: return ImGuiKey_RightAlt;
  405. case VK_RWIN: return ImGuiKey_RightSuper;
  406. case VK_APPS: return ImGuiKey_Menu;
  407. case '0': return ImGuiKey_0;
  408. case '1': return ImGuiKey_1;
  409. case '2': return ImGuiKey_2;
  410. case '3': return ImGuiKey_3;
  411. case '4': return ImGuiKey_4;
  412. case '5': return ImGuiKey_5;
  413. case '6': return ImGuiKey_6;
  414. case '7': return ImGuiKey_7;
  415. case '8': return ImGuiKey_8;
  416. case '9': return ImGuiKey_9;
  417. case 'A': return ImGuiKey_A;
  418. case 'B': return ImGuiKey_B;
  419. case 'C': return ImGuiKey_C;
  420. case 'D': return ImGuiKey_D;
  421. case 'E': return ImGuiKey_E;
  422. case 'F': return ImGuiKey_F;
  423. case 'G': return ImGuiKey_G;
  424. case 'H': return ImGuiKey_H;
  425. case 'I': return ImGuiKey_I;
  426. case 'J': return ImGuiKey_J;
  427. case 'K': return ImGuiKey_K;
  428. case 'L': return ImGuiKey_L;
  429. case 'M': return ImGuiKey_M;
  430. case 'N': return ImGuiKey_N;
  431. case 'O': return ImGuiKey_O;
  432. case 'P': return ImGuiKey_P;
  433. case 'Q': return ImGuiKey_Q;
  434. case 'R': return ImGuiKey_R;
  435. case 'S': return ImGuiKey_S;
  436. case 'T': return ImGuiKey_T;
  437. case 'U': return ImGuiKey_U;
  438. case 'V': return ImGuiKey_V;
  439. case 'W': return ImGuiKey_W;
  440. case 'X': return ImGuiKey_X;
  441. case 'Y': return ImGuiKey_Y;
  442. case 'Z': return ImGuiKey_Z;
  443. case VK_F1: return ImGuiKey_F1;
  444. case VK_F2: return ImGuiKey_F2;
  445. case VK_F3: return ImGuiKey_F3;
  446. case VK_F4: return ImGuiKey_F4;
  447. case VK_F5: return ImGuiKey_F5;
  448. case VK_F6: return ImGuiKey_F6;
  449. case VK_F7: return ImGuiKey_F7;
  450. case VK_F8: return ImGuiKey_F8;
  451. case VK_F9: return ImGuiKey_F9;
  452. case VK_F10: return ImGuiKey_F10;
  453. case VK_F11: return ImGuiKey_F11;
  454. case VK_F12: return ImGuiKey_F12;
  455. default: return ImGuiKey_None;
  456. }
  457. }
  458. // Allow compilation with old Windows SDK. MinGW doesn't have default _WIN32_WINNT/WINVER versions.
  459. #ifndef WM_MOUSEHWHEEL
  460. #define WM_MOUSEHWHEEL 0x020E
  461. #endif
  462. #ifndef DBT_DEVNODES_CHANGED
  463. #define DBT_DEVNODES_CHANGED 0x0007
  464. #endif
  465. // Win32 message handler (process Win32 mouse/keyboard inputs, etc.)
  466. // Call from your application's message handler. Keep calling your message handler unless this function returns TRUE.
  467. // When implementing your own backend, you can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if Dear ImGui wants to use your inputs.
  468. // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application, or clear/overwrite your copy of the mouse data.
  469. // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application, or clear/overwrite your copy of the keyboard data.
  470. // Generally you may always pass all inputs to Dear ImGui, and hide them from your application based on those two flags.
  471. // 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.
  472. // 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.
  473. #if 0
  474. // Copy this line into your .cpp file to forward declare the function.
  475. extern IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
  476. #endif
  477. // See https://learn.microsoft.com/en-us/windows/win32/tablet/system-events-and-mouse-messages
  478. // Prefer to call this at the top of the message handler to avoid the possibility of other Win32 calls interfering with this.
  479. static ImGuiMouseSource GetMouseSourceFromMessageExtraInfo()
  480. {
  481. LPARAM extra_info = ::GetMessageExtraInfo();
  482. if ((extra_info & 0xFFFFFF80) == 0xFF515700)
  483. return ImGuiMouseSource_Pen;
  484. if ((extra_info & 0xFFFFFF80) == 0xFF515780)
  485. return ImGuiMouseSource_TouchScreen;
  486. return ImGuiMouseSource_Mouse;
  487. }
  488. IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
  489. {
  490. if (ImGui::GetCurrentContext() == nullptr)
  491. return 0;
  492. ImGuiIO& io = ImGui::GetIO();
  493. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  494. switch (msg)
  495. {
  496. case WM_MOUSEMOVE:
  497. case WM_NCMOUSEMOVE:
  498. {
  499. // We need to call TrackMouseEvent in order to receive WM_MOUSELEAVE events
  500. ImGuiMouseSource mouse_source = GetMouseSourceFromMessageExtraInfo();
  501. const int area = (msg == WM_MOUSEMOVE) ? 1 : 2;
  502. bd->MouseHwnd = hwnd;
  503. if (bd->MouseTrackedArea != area)
  504. {
  505. TRACKMOUSEEVENT tme_cancel = { sizeof(tme_cancel), TME_CANCEL, hwnd, 0 };
  506. TRACKMOUSEEVENT tme_track = { sizeof(tme_track), (DWORD)((area == 2) ? (TME_LEAVE | TME_NONCLIENT) : TME_LEAVE), hwnd, 0 };
  507. if (bd->MouseTrackedArea != 0)
  508. ::TrackMouseEvent(&tme_cancel);
  509. ::TrackMouseEvent(&tme_track);
  510. bd->MouseTrackedArea = area;
  511. }
  512. POINT mouse_pos = { (LONG)GET_X_LPARAM(lParam), (LONG)GET_Y_LPARAM(lParam) };
  513. if (msg == WM_NCMOUSEMOVE && ::ScreenToClient(hwnd, &mouse_pos) == FALSE) // WM_NCMOUSEMOVE are provided in absolute coordinates.
  514. break;
  515. io.AddMouseSourceEvent(mouse_source);
  516. io.AddMousePosEvent((float)mouse_pos.x, (float)mouse_pos.y);
  517. break;
  518. }
  519. case WM_MOUSELEAVE:
  520. case WM_NCMOUSELEAVE:
  521. {
  522. const int area = (msg == WM_MOUSELEAVE) ? 1 : 2;
  523. if (bd->MouseTrackedArea == area)
  524. {
  525. if (bd->MouseHwnd == hwnd)
  526. bd->MouseHwnd = nullptr;
  527. bd->MouseTrackedArea = 0;
  528. io.AddMousePosEvent(-FLT_MAX, -FLT_MAX);
  529. }
  530. break;
  531. }
  532. case WM_LBUTTONDOWN: case WM_LBUTTONDBLCLK:
  533. case WM_RBUTTONDOWN: case WM_RBUTTONDBLCLK:
  534. case WM_MBUTTONDOWN: case WM_MBUTTONDBLCLK:
  535. case WM_XBUTTONDOWN: case WM_XBUTTONDBLCLK:
  536. {
  537. ImGuiMouseSource mouse_source = GetMouseSourceFromMessageExtraInfo();
  538. int button = 0;
  539. if (msg == WM_LBUTTONDOWN || msg == WM_LBUTTONDBLCLK) { button = 0; }
  540. if (msg == WM_RBUTTONDOWN || msg == WM_RBUTTONDBLCLK) { button = 1; }
  541. if (msg == WM_MBUTTONDOWN || msg == WM_MBUTTONDBLCLK) { button = 2; }
  542. if (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONDBLCLK) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; }
  543. if (bd->MouseButtonsDown == 0 && ::GetCapture() == nullptr)
  544. ::SetCapture(hwnd);
  545. bd->MouseButtonsDown |= 1 << button;
  546. io.AddMouseSourceEvent(mouse_source);
  547. io.AddMouseButtonEvent(button, true);
  548. return 0;
  549. }
  550. case WM_LBUTTONUP:
  551. case WM_RBUTTONUP:
  552. case WM_MBUTTONUP:
  553. case WM_XBUTTONUP:
  554. {
  555. ImGuiMouseSource mouse_source = GetMouseSourceFromMessageExtraInfo();
  556. int button = 0;
  557. if (msg == WM_LBUTTONUP) { button = 0; }
  558. if (msg == WM_RBUTTONUP) { button = 1; }
  559. if (msg == WM_MBUTTONUP) { button = 2; }
  560. if (msg == WM_XBUTTONUP) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; }
  561. bd->MouseButtonsDown &= ~(1 << button);
  562. if (bd->MouseButtonsDown == 0 && ::GetCapture() == hwnd)
  563. ::ReleaseCapture();
  564. io.AddMouseSourceEvent(mouse_source);
  565. io.AddMouseButtonEvent(button, false);
  566. return 0;
  567. }
  568. case WM_MOUSEWHEEL:
  569. io.AddMouseWheelEvent(0.0f, (float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA);
  570. return 0;
  571. case WM_MOUSEHWHEEL:
  572. io.AddMouseWheelEvent(-(float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA, 0.0f);
  573. return 0;
  574. case WM_KEYDOWN:
  575. case WM_KEYUP:
  576. case WM_SYSKEYDOWN:
  577. case WM_SYSKEYUP:
  578. {
  579. const bool is_key_down = (msg == WM_KEYDOWN || msg == WM_SYSKEYDOWN);
  580. if (wParam < 256)
  581. {
  582. // Submit modifiers
  583. ImGui_ImplWin32_UpdateKeyModifiers();
  584. // Obtain virtual key code
  585. // (keypad enter doesn't have its own... VK_RETURN with KF_EXTENDED flag means keypad enter, see IM_VK_KEYPAD_ENTER definition for details, it is mapped to ImGuiKey_KeyPadEnter.)
  586. int vk = (int)wParam;
  587. if ((wParam == VK_RETURN) && (HIWORD(lParam) & KF_EXTENDED))
  588. vk = IM_VK_KEYPAD_ENTER;
  589. // Submit key event
  590. const ImGuiKey key = ImGui_ImplWin32_VirtualKeyToImGuiKey(vk);
  591. const int scancode = (int)LOBYTE(HIWORD(lParam));
  592. if (key != ImGuiKey_None)
  593. ImGui_ImplWin32_AddKeyEvent(key, is_key_down, vk, scancode);
  594. // Submit individual left/right modifier events
  595. if (vk == VK_SHIFT)
  596. {
  597. // Important: Shift keys tend to get stuck when pressed together, missing key-up events are corrected in ImGui_ImplWin32_ProcessKeyEventsWorkarounds()
  598. if (IsVkDown(VK_LSHIFT) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftShift, is_key_down, VK_LSHIFT, scancode); }
  599. if (IsVkDown(VK_RSHIFT) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightShift, is_key_down, VK_RSHIFT, scancode); }
  600. }
  601. else if (vk == VK_CONTROL)
  602. {
  603. if (IsVkDown(VK_LCONTROL) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftCtrl, is_key_down, VK_LCONTROL, scancode); }
  604. if (IsVkDown(VK_RCONTROL) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightCtrl, is_key_down, VK_RCONTROL, scancode); }
  605. }
  606. else if (vk == VK_MENU)
  607. {
  608. if (IsVkDown(VK_LMENU) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftAlt, is_key_down, VK_LMENU, scancode); }
  609. if (IsVkDown(VK_RMENU) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightAlt, is_key_down, VK_RMENU, scancode); }
  610. }
  611. }
  612. return 0;
  613. }
  614. case WM_SETFOCUS:
  615. case WM_KILLFOCUS:
  616. io.AddFocusEvent(msg == WM_SETFOCUS);
  617. return 0;
  618. case WM_CHAR:
  619. if (::IsWindowUnicode(hwnd))
  620. {
  621. // You can also use ToAscii()+GetKeyboardState() to retrieve characters.
  622. if (wParam > 0 && wParam < 0x10000)
  623. io.AddInputCharacterUTF16((unsigned short)wParam);
  624. }
  625. else
  626. {
  627. wchar_t wch = 0;
  628. ::MultiByteToWideChar(CP_ACP, MB_PRECOMPOSED, (char*)&wParam, 1, &wch, 1);
  629. io.AddInputCharacter(wch);
  630. }
  631. return 0;
  632. case WM_SETCURSOR:
  633. // This is required to restore cursor when transitioning from e.g resize borders to client area.
  634. if (LOWORD(lParam) == HTCLIENT && ImGui_ImplWin32_UpdateMouseCursor())
  635. return 1;
  636. return 0;
  637. case WM_DEVICECHANGE:
  638. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  639. if ((UINT)wParam == DBT_DEVNODES_CHANGED)
  640. bd->WantUpdateHasGamepad = true;
  641. #endif
  642. return 0;
  643. }
  644. return 0;
  645. }
  646. //--------------------------------------------------------------------------------------------------------
  647. // DPI-related helpers (optional)
  648. //--------------------------------------------------------------------------------------------------------
  649. // - Use to enable DPI awareness without having to create an application manifest.
  650. // - Your own app may already do this via a manifest or explicit calls. This is mostly useful for our examples/ apps.
  651. // - In theory we could call simple functions from Windows SDK such as SetProcessDPIAware(), SetProcessDpiAwareness(), etc.
  652. // but most of the functions provided by Microsoft require Windows 8.1/10+ SDK at compile time and Windows 8/10+ at runtime,
  653. // neither we want to require the user to have. So we dynamically select and load those functions to avoid dependencies.
  654. //---------------------------------------------------------------------------------------------------------
  655. // This is the scheme successfully used by GLFW (from which we borrowed some of the code) and other apps aiming to be highly portable.
  656. // ImGui_ImplWin32_EnableDpiAwareness() is just a helper called by main.cpp, we don't call it automatically.
  657. // If you are trying to implement your own backend for your own engine, you may ignore that noise.
  658. //---------------------------------------------------------------------------------------------------------
  659. // Perform our own check with RtlVerifyVersionInfo() instead of using functions from <VersionHelpers.h> as they
  660. // require a manifest to be functional for checks above 8.1. See https://github.com/ocornut/imgui/issues/4200
  661. static BOOL _IsWindowsVersionOrGreater(WORD major, WORD minor, WORD)
  662. {
  663. typedef LONG(WINAPI* PFN_RtlVerifyVersionInfo)(OSVERSIONINFOEXW*, ULONG, ULONGLONG);
  664. static PFN_RtlVerifyVersionInfo RtlVerifyVersionInfoFn = nullptr;
  665. if (RtlVerifyVersionInfoFn == nullptr)
  666. if (HMODULE ntdllModule = ::GetModuleHandleA("ntdll.dll"))
  667. RtlVerifyVersionInfoFn = (PFN_RtlVerifyVersionInfo)GetProcAddress(ntdllModule, "RtlVerifyVersionInfo");
  668. if (RtlVerifyVersionInfoFn == nullptr)
  669. return FALSE;
  670. RTL_OSVERSIONINFOEXW versionInfo = { };
  671. ULONGLONG conditionMask = 0;
  672. versionInfo.dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW);
  673. versionInfo.dwMajorVersion = major;
  674. versionInfo.dwMinorVersion = minor;
  675. VER_SET_CONDITION(conditionMask, VER_MAJORVERSION, VER_GREATER_EQUAL);
  676. VER_SET_CONDITION(conditionMask, VER_MINORVERSION, VER_GREATER_EQUAL);
  677. return (RtlVerifyVersionInfoFn(&versionInfo, VER_MAJORVERSION | VER_MINORVERSION, conditionMask) == 0) ? TRUE : FALSE;
  678. }
  679. #define _IsWindowsVistaOrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0600), LOBYTE(0x0600), 0) // _WIN32_WINNT_VISTA
  680. #define _IsWindows8OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0602), LOBYTE(0x0602), 0) // _WIN32_WINNT_WIN8
  681. #define _IsWindows8Point1OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0603), LOBYTE(0x0603), 0) // _WIN32_WINNT_WINBLUE
  682. #define _IsWindows10OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0A00), LOBYTE(0x0A00), 0) // _WIN32_WINNT_WINTHRESHOLD / _WIN32_WINNT_WIN10
  683. #ifndef DPI_ENUMS_DECLARED
  684. typedef enum { PROCESS_DPI_UNAWARE = 0, PROCESS_SYSTEM_DPI_AWARE = 1, PROCESS_PER_MONITOR_DPI_AWARE = 2 } PROCESS_DPI_AWARENESS;
  685. typedef enum { MDT_EFFECTIVE_DPI = 0, MDT_ANGULAR_DPI = 1, MDT_RAW_DPI = 2, MDT_DEFAULT = MDT_EFFECTIVE_DPI } MONITOR_DPI_TYPE;
  686. #endif
  687. #ifndef _DPI_AWARENESS_CONTEXTS_
  688. DECLARE_HANDLE(DPI_AWARENESS_CONTEXT);
  689. #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE (DPI_AWARENESS_CONTEXT)-3
  690. #endif
  691. #ifndef DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2
  692. #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2 (DPI_AWARENESS_CONTEXT)-4
  693. #endif
  694. typedef HRESULT(WINAPI* PFN_SetProcessDpiAwareness)(PROCESS_DPI_AWARENESS); // Shcore.lib + dll, Windows 8.1+
  695. typedef HRESULT(WINAPI* PFN_GetDpiForMonitor)(HMONITOR, MONITOR_DPI_TYPE, UINT*, UINT*); // Shcore.lib + dll, Windows 8.1+
  696. typedef DPI_AWARENESS_CONTEXT(WINAPI* PFN_SetThreadDpiAwarenessContext)(DPI_AWARENESS_CONTEXT); // User32.lib + dll, Windows 10 v1607+ (Creators Update)
  697. // Helper function to enable DPI awareness without setting up a manifest
  698. void ImGui_ImplWin32_EnableDpiAwareness()
  699. {
  700. if (_IsWindows10OrGreater())
  701. {
  702. static HINSTANCE user32_dll = ::LoadLibraryA("user32.dll"); // Reference counted per-process
  703. if (PFN_SetThreadDpiAwarenessContext SetThreadDpiAwarenessContextFn = (PFN_SetThreadDpiAwarenessContext)::GetProcAddress(user32_dll, "SetThreadDpiAwarenessContext"))
  704. {
  705. SetThreadDpiAwarenessContextFn(DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2);
  706. return;
  707. }
  708. }
  709. if (_IsWindows8Point1OrGreater())
  710. {
  711. static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
  712. if (PFN_SetProcessDpiAwareness SetProcessDpiAwarenessFn = (PFN_SetProcessDpiAwareness)::GetProcAddress(shcore_dll, "SetProcessDpiAwareness"))
  713. {
  714. SetProcessDpiAwarenessFn(PROCESS_PER_MONITOR_DPI_AWARE);
  715. return;
  716. }
  717. }
  718. #if _WIN32_WINNT >= 0x0600
  719. ::SetProcessDPIAware();
  720. #endif
  721. }
  722. #if defined(_MSC_VER) && !defined(NOGDI)
  723. #pragma comment(lib, "gdi32") // Link with gdi32.lib for GetDeviceCaps(). MinGW will require linking with '-lgdi32'
  724. #endif
  725. float ImGui_ImplWin32_GetDpiScaleForMonitor(void* monitor)
  726. {
  727. UINT xdpi = 96, ydpi = 96;
  728. if (_IsWindows8Point1OrGreater())
  729. {
  730. static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
  731. static PFN_GetDpiForMonitor GetDpiForMonitorFn = nullptr;
  732. if (GetDpiForMonitorFn == nullptr && shcore_dll != nullptr)
  733. GetDpiForMonitorFn = (PFN_GetDpiForMonitor)::GetProcAddress(shcore_dll, "GetDpiForMonitor");
  734. if (GetDpiForMonitorFn != nullptr)
  735. {
  736. GetDpiForMonitorFn((HMONITOR)monitor, MDT_EFFECTIVE_DPI, &xdpi, &ydpi);
  737. IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert!
  738. return xdpi / 96.0f;
  739. }
  740. }
  741. #ifndef NOGDI
  742. const HDC dc = ::GetDC(nullptr);
  743. xdpi = ::GetDeviceCaps(dc, LOGPIXELSX);
  744. ydpi = ::GetDeviceCaps(dc, LOGPIXELSY);
  745. IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert!
  746. ::ReleaseDC(nullptr, dc);
  747. #endif
  748. return xdpi / 96.0f;
  749. }
  750. float ImGui_ImplWin32_GetDpiScaleForHwnd(void* hwnd)
  751. {
  752. HMONITOR monitor = ::MonitorFromWindow((HWND)hwnd, MONITOR_DEFAULTTONEAREST);
  753. return ImGui_ImplWin32_GetDpiScaleForMonitor(monitor);
  754. }