imgui_impl_win32.cpp 48 KB

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