imgui_impl_win32.cpp 49 KB

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