imgui_impl_win32.cpp 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197
  1. // dear imgui: Platform Backend for Windows (standard windows API for 32 and 64 bits applications)
  2. // This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..)
  3. // Implemented features:
  4. // [X] Platform: Clipboard support (for Win32 this is actually part of core dear imgui)
  5. // [X] Platform: Keyboard support. Since 1.87 we are using the io.AddKeyEvent() function. Pass ImGuiKey values to all key functions e.g. ImGui::IsKeyPressed(ImGuiKey_Space). [Legacy VK_* values will also be supported unless IMGUI_DISABLE_OBSOLETE_KEYIO is set]
  6. // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
  7. // [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  8. // [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  9. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  10. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  11. // If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.
  12. // Read online: https://github.com/ocornut/imgui/tree/master/docs
  13. #include "imgui.h"
  14. #include "imgui_impl_win32.h"
  15. #ifndef WIN32_LEAN_AND_MEAN
  16. #define WIN32_LEAN_AND_MEAN
  17. #endif
  18. #include <windows.h>
  19. #include <windowsx.h> // GET_X_LPARAM(), GET_Y_LPARAM()
  20. #include <tchar.h>
  21. #include <dwmapi.h>
  22. // Configuration flags to add in your imconfig.h file:
  23. //#define IMGUI_IMPL_WIN32_DISABLE_GAMEPAD // Disable gamepad support. This was meaningful before <1.81 but we now load XInput dynamically so the option is now less relevant.
  24. // Using XInput for gamepad (will load DLL dynamically)
  25. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  26. #include <xinput.h>
  27. typedef DWORD (WINAPI *PFN_XInputGetCapabilities)(DWORD, DWORD, XINPUT_CAPABILITIES*);
  28. typedef DWORD (WINAPI *PFN_XInputGetState)(DWORD, XINPUT_STATE*);
  29. #endif
  30. // CHANGELOG
  31. // (minor and older changes stripped away, please see git history for details)
  32. // 2022-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  33. // 2022-09-26: Inputs: Renamed ImGuiKey_ModXXX introduced in 1.87 to ImGuiMod_XXX (old names still supported).
  34. // 2022-01-26: Inputs: replaced short-lived io.AddKeyModsEvent() (added two weeks ago) with io.AddKeyEvent() using ImGuiKey_ModXXX flags. Sorry for the confusion.
  35. // 2021-01-20: Inputs: calling new io.AddKeyAnalogEvent() for gamepad support, instead of writing directly to io.NavInputs[].
  36. // 2022-01-17: Inputs: calling new io.AddMousePosEvent(), io.AddMouseButtonEvent(), io.AddMouseWheelEvent() API (1.87+).
  37. // 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.
  38. // 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.
  39. // 2022-01-12: Inputs: Maintain our own copy of MouseButtonsDown mask instead of using ImGui::IsAnyMouseDown() which will be obsoleted.
  40. // 2022-01-10: Inputs: calling new io.AddKeyEvent(), io.AddKeyModsEvent() + io.SetKeyEventNativeData() API (1.87+). Support for full ImGuiKey range.
  41. // 2021-12-16: Inputs: Fill VK_LCONTROL/VK_RCONTROL/VK_LSHIFT/VK_RSHIFT/VK_LMENU/VK_RMENU for completeness.
  42. // 2021-08-17: Calling io.AddFocusEvent() on WM_SETFOCUS/WM_KILLFOCUS messages.
  43. // 2021-08-02: Inputs: Fixed keyboard modifiers being reported when host window doesn't have focus.
  44. // 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).
  45. // 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).
  46. // 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).
  47. // 2021-03-23: Inputs: Clearing keyboard down array when losing focus (WM_KILLFOCUS).
  48. // 2021-02-18: Added ImGui_ImplWin32_EnableAlphaCompositing(). Non Visual Studio users will need to link with dwmapi.lib (MinGW/gcc: use -ldwmapi).
  49. // 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.
  50. // 2021-01-25: Inputs: Dynamically loading XInput DLL.
  51. // 2020-12-04: Misc: Fixed setting of io.DisplaySize to invalid/uninitialized data when after hwnd has been closed.
  52. // 2020-03-03: Inputs: Calling AddInputCharacterUTF16() to support surrogate pairs leading to codepoint >= 0x10000 (for more complete CJK inputs)
  53. // 2020-02-17: Added ImGui_ImplWin32_EnableDpiAwareness(), ImGui_ImplWin32_GetDpiScaleForHwnd(), ImGui_ImplWin32_GetDpiScaleForMonitor() helper functions.
  54. // 2020-01-14: Inputs: Added support for #define IMGUI_IMPL_WIN32_DISABLE_GAMEPAD/IMGUI_IMPL_WIN32_DISABLE_LINKING_XINPUT.
  55. // 2019-12-05: Inputs: Added support for ImGuiMouseCursor_NotAllowed mouse cursor.
  56. // 2019-05-11: Inputs: Don't filter value from WM_CHAR before calling AddInputCharacter().
  57. // 2019-01-17: Misc: Using GetForegroundWindow()+IsChild() instead of GetActiveWindow() to be compatible with windows created in a different thread or parent.
  58. // 2019-01-17: Inputs: Added support for mouse buttons 4 and 5 via WM_XBUTTON* messages.
  59. // 2019-01-15: Inputs: Added support for XInput gamepads (if ImGuiConfigFlags_NavEnableGamepad is set by user application).
  60. // 2018-11-30: Misc: Setting up io.BackendPlatformName so it can be displayed in the About Window.
  61. // 2018-06-29: Inputs: Added support for the ImGuiMouseCursor_Hand cursor.
  62. // 2018-06-10: Inputs: Fixed handling of mouse wheel messages to support fine position messages (typically sent by track-pads).
  63. // 2018-06-08: Misc: Extracted imgui_impl_win32.cpp/.h away from the old combined DX9/DX10/DX11/DX12 examples.
  64. // 2018-03-20: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors and ImGuiBackendFlags_HasSetMousePos flags + honor ImGuiConfigFlags_NoMouseCursorChange flag.
  65. // 2018-02-20: Inputs: Added support for mouse cursors (ImGui::GetMouseCursor() value and WM_SETCURSOR message handling).
  66. // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
  67. // 2018-02-06: Inputs: Honoring the io.WantSetMousePos by repositioning the mouse (when using navigation and ImGuiConfigFlags_NavMoveMouse is set).
  68. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  69. // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
  70. // 2018-01-08: Inputs: Added mapping for ImGuiKey_Insert.
  71. // 2018-01-05: Inputs: Added WM_LBUTTONDBLCLK double-click handlers for window classes with the CS_DBLCLKS flag.
  72. // 2017-10-23: Inputs: Added WM_SYSKEYDOWN / WM_SYSKEYUP handlers so e.g. the VK_MENU key can be read.
  73. // 2017-10-23: Inputs: Using Win32 ::SetCapture/::GetCapture() to retrieve mouse positions outside the client area when dragging.
  74. // 2016-11-12: Inputs: Only call Win32 ::SetCursor(NULL) when io.MouseDrawCursor is set.
  75. // Forward Declarations
  76. static void ImGui_ImplWin32_InitPlatformInterface();
  77. static void ImGui_ImplWin32_ShutdownPlatformInterface();
  78. static void ImGui_ImplWin32_UpdateMonitors();
  79. struct ImGui_ImplWin32_Data
  80. {
  81. HWND hWnd;
  82. HWND MouseHwnd;
  83. bool MouseTracked;
  84. int MouseButtonsDown;
  85. INT64 Time;
  86. INT64 TicksPerSecond;
  87. ImGuiMouseCursor LastMouseCursor;
  88. bool HasGamepad;
  89. bool WantUpdateHasGamepad;
  90. bool WantUpdateMonitors;
  91. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  92. HMODULE XInputDLL;
  93. PFN_XInputGetCapabilities XInputGetCapabilities;
  94. PFN_XInputGetState XInputGetState;
  95. #endif
  96. ImGui_ImplWin32_Data() { memset((void*)this, 0, sizeof(*this)); }
  97. };
  98. // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts
  99. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  100. // FIXME: multi-context support is not well tested and probably dysfunctional in this backend.
  101. // FIXME: some shared resources (mouse cursor shape, gamepad) are mishandled when using multi-context.
  102. static ImGui_ImplWin32_Data* ImGui_ImplWin32_GetBackendData()
  103. {
  104. return ImGui::GetCurrentContext() ? (ImGui_ImplWin32_Data*)ImGui::GetIO().BackendPlatformUserData : NULL;
  105. }
  106. // Functions
  107. bool ImGui_ImplWin32_Init(void* hwnd)
  108. {
  109. ImGuiIO& io = ImGui::GetIO();
  110. IM_ASSERT(io.BackendPlatformUserData == NULL && "Already initialized a platform backend!");
  111. INT64 perf_frequency, perf_counter;
  112. if (!::QueryPerformanceFrequency((LARGE_INTEGER*)&perf_frequency))
  113. return false;
  114. if (!::QueryPerformanceCounter((LARGE_INTEGER*)&perf_counter))
  115. return false;
  116. // Setup backend capabilities flags
  117. ImGui_ImplWin32_Data* bd = IM_NEW(ImGui_ImplWin32_Data)();
  118. io.BackendPlatformUserData = (void*)bd;
  119. io.BackendPlatformName = "imgui_impl_win32";
  120. io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
  121. io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
  122. io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports; // We can create multi-viewports on the Platform side (optional)
  123. io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport; // We can call io.AddMouseViewportEvent() with correct data (optional)
  124. bd->hWnd = (HWND)hwnd;
  125. bd->WantUpdateHasGamepad = true;
  126. bd->WantUpdateMonitors = true;
  127. bd->TicksPerSecond = perf_frequency;
  128. bd->Time = perf_counter;
  129. bd->LastMouseCursor = ImGuiMouseCursor_COUNT;
  130. // Our mouse update function expect PlatformHandle to be filled for the main viewport
  131. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  132. main_viewport->PlatformHandle = main_viewport->PlatformHandleRaw = (void*)bd->hWnd;
  133. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  134. ImGui_ImplWin32_InitPlatformInterface();
  135. // Dynamically load XInput library
  136. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  137. const char* xinput_dll_names[] =
  138. {
  139. "xinput1_4.dll", // Windows 8+
  140. "xinput1_3.dll", // DirectX SDK
  141. "xinput9_1_0.dll", // Windows Vista, Windows 7
  142. "xinput1_2.dll", // DirectX SDK
  143. "xinput1_1.dll" // DirectX SDK
  144. };
  145. for (int n = 0; n < IM_ARRAYSIZE(xinput_dll_names); n++)
  146. if (HMODULE dll = ::LoadLibraryA(xinput_dll_names[n]))
  147. {
  148. bd->XInputDLL = dll;
  149. bd->XInputGetCapabilities = (PFN_XInputGetCapabilities)::GetProcAddress(dll, "XInputGetCapabilities");
  150. bd->XInputGetState = (PFN_XInputGetState)::GetProcAddress(dll, "XInputGetState");
  151. break;
  152. }
  153. #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  154. return true;
  155. }
  156. void ImGui_ImplWin32_Shutdown()
  157. {
  158. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  159. IM_ASSERT(bd != NULL && "No platform backend to shutdown, or already shutdown?");
  160. ImGuiIO& io = ImGui::GetIO();
  161. ImGui_ImplWin32_ShutdownPlatformInterface();
  162. // Unload XInput library
  163. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  164. if (bd->XInputDLL)
  165. ::FreeLibrary(bd->XInputDLL);
  166. #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  167. io.BackendPlatformName = NULL;
  168. io.BackendPlatformUserData = NULL;
  169. IM_DELETE(bd);
  170. }
  171. static bool ImGui_ImplWin32_UpdateMouseCursor()
  172. {
  173. ImGuiIO& io = ImGui::GetIO();
  174. if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
  175. return false;
  176. ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
  177. if (imgui_cursor == ImGuiMouseCursor_None || io.MouseDrawCursor)
  178. {
  179. // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
  180. ::SetCursor(NULL);
  181. }
  182. else
  183. {
  184. // Show OS mouse cursor
  185. LPTSTR win32_cursor = IDC_ARROW;
  186. switch (imgui_cursor)
  187. {
  188. case ImGuiMouseCursor_Arrow: win32_cursor = IDC_ARROW; break;
  189. case ImGuiMouseCursor_TextInput: win32_cursor = IDC_IBEAM; break;
  190. case ImGuiMouseCursor_ResizeAll: win32_cursor = IDC_SIZEALL; break;
  191. case ImGuiMouseCursor_ResizeEW: win32_cursor = IDC_SIZEWE; break;
  192. case ImGuiMouseCursor_ResizeNS: win32_cursor = IDC_SIZENS; break;
  193. case ImGuiMouseCursor_ResizeNESW: win32_cursor = IDC_SIZENESW; break;
  194. case ImGuiMouseCursor_ResizeNWSE: win32_cursor = IDC_SIZENWSE; break;
  195. case ImGuiMouseCursor_Hand: win32_cursor = IDC_HAND; break;
  196. case ImGuiMouseCursor_NotAllowed: win32_cursor = IDC_NO; break;
  197. }
  198. ::SetCursor(::LoadCursor(NULL, win32_cursor));
  199. }
  200. return true;
  201. }
  202. static bool IsVkDown(int vk)
  203. {
  204. return (::GetKeyState(vk) & 0x8000) != 0;
  205. }
  206. static void ImGui_ImplWin32_AddKeyEvent(ImGuiKey key, bool down, int native_keycode, int native_scancode = -1)
  207. {
  208. ImGuiIO& io = ImGui::GetIO();
  209. io.AddKeyEvent(key, down);
  210. io.SetKeyEventNativeData(key, native_keycode, native_scancode); // To support legacy indexing (<1.87 user code)
  211. IM_UNUSED(native_scancode);
  212. }
  213. static void ImGui_ImplWin32_ProcessKeyEventsWorkarounds()
  214. {
  215. // Left & right Shift keys: when both are pressed together, Windows tend to not generate the WM_KEYUP event for the first released one.
  216. if (ImGui::IsKeyDown(ImGuiKey_LeftShift) && !IsVkDown(VK_LSHIFT))
  217. ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftShift, false, VK_LSHIFT);
  218. if (ImGui::IsKeyDown(ImGuiKey_RightShift) && !IsVkDown(VK_RSHIFT))
  219. ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightShift, false, VK_RSHIFT);
  220. // Sometimes WM_KEYUP for Win key is not passed down to the app (e.g. for Win+V on some setups, according to GLFW).
  221. if (ImGui::IsKeyDown(ImGuiKey_LeftSuper) && !IsVkDown(VK_LWIN))
  222. ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftSuper, false, VK_LWIN);
  223. if (ImGui::IsKeyDown(ImGuiKey_RightSuper) && !IsVkDown(VK_RWIN))
  224. ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightSuper, false, VK_RWIN);
  225. }
  226. static void ImGui_ImplWin32_UpdateKeyModifiers()
  227. {
  228. ImGuiIO& io = ImGui::GetIO();
  229. io.AddKeyEvent(ImGuiMod_Ctrl, IsVkDown(VK_CONTROL));
  230. io.AddKeyEvent(ImGuiMod_Shift, IsVkDown(VK_SHIFT));
  231. io.AddKeyEvent(ImGuiMod_Alt, IsVkDown(VK_MENU));
  232. io.AddKeyEvent(ImGuiMod_Super, IsVkDown(VK_APPS));
  233. }
  234. // This code supports multi-viewports (multiple OS Windows mapped into different Dear ImGui viewports)
  235. // Because of that, it is a little more complicated than your typical single-viewport binding code!
  236. static void ImGui_ImplWin32_UpdateMouseData()
  237. {
  238. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  239. ImGuiIO& io = ImGui::GetIO();
  240. IM_ASSERT(bd->hWnd != 0);
  241. POINT mouse_screen_pos;
  242. bool has_mouse_screen_pos = ::GetCursorPos(&mouse_screen_pos) != 0;
  243. HWND focused_window = ::GetForegroundWindow();
  244. const bool is_app_focused = (focused_window && (focused_window == bd->hWnd || ::IsChild(focused_window, bd->hWnd) || ImGui::FindViewportByPlatformHandle((void*)focused_window)));
  245. if (is_app_focused)
  246. {
  247. // (Optional) Set OS mouse position from Dear ImGui if requested (rarely used, only when ImGuiConfigFlags_NavEnableSetMousePos is enabled by user)
  248. // When multi-viewports are enabled, all Dear ImGui positions are same as OS positions.
  249. if (io.WantSetMousePos)
  250. {
  251. POINT pos = { (int)io.MousePos.x, (int)io.MousePos.y };
  252. if ((io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable) == 0)
  253. ::ClientToScreen(focused_window, &pos);
  254. ::SetCursorPos(pos.x, pos.y);
  255. }
  256. // (Optional) Fallback to provide mouse position when focused (WM_MOUSEMOVE already provides this when hovered or captured)
  257. if (!io.WantSetMousePos && !bd->MouseTracked && has_mouse_screen_pos)
  258. {
  259. // Single viewport mode: mouse position in client window coordinates (io.MousePos is (0,0) when the mouse is on the upper-left corner of the app window)
  260. // (This is the position you can get with ::GetCursorPos() + ::ScreenToClient() or WM_MOUSEMOVE.)
  261. // Multi-viewport mode: mouse position in OS absolute coordinates (io.MousePos is (0,0) when the mouse is on the upper-left of the primary monitor)
  262. // (This is the position you can get with ::GetCursorPos() or WM_MOUSEMOVE + ::ClientToScreen(). In theory adding viewport->Pos to a client position would also be the same.)
  263. POINT mouse_pos = mouse_screen_pos;
  264. if (!(io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable))
  265. ::ScreenToClient(bd->hWnd, &mouse_pos);
  266. io.AddMousePosEvent((float)mouse_pos.x, (float)mouse_pos.y);
  267. }
  268. }
  269. // (Optional) When using multiple viewports: call io.AddMouseViewportEvent() with the viewport the OS mouse cursor is hovering.
  270. // If ImGuiBackendFlags_HasMouseHoveredViewport is not set by the backend, Dear imGui will ignore this field and infer the information using its flawed heuristic.
  271. // - [X] Win32 backend correctly ignore viewports with the _NoInputs flag (here using ::WindowFromPoint with WM_NCHITTEST + HTTRANSPARENT in WndProc does that)
  272. // Some backend are not able to handle that correctly. If a backend report an hovered viewport that has the _NoInputs flag (e.g. when dragging a window
  273. // for docking, the viewport has the _NoInputs flag in order to allow us to find the viewport under), then Dear ImGui is forced to ignore the value reported
  274. // by the backend, and use its flawed heuristic to guess the viewport behind.
  275. // - [X] Win32 backend correctly reports this regardless of another viewport behind focused and dragged from (we need this to find a useful drag and drop target).
  276. ImGuiID mouse_viewport_id = 0;
  277. if (has_mouse_screen_pos)
  278. if (HWND hovered_hwnd = ::WindowFromPoint(mouse_screen_pos))
  279. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle((void*)hovered_hwnd))
  280. mouse_viewport_id = viewport->ID;
  281. io.AddMouseViewportEvent(mouse_viewport_id);
  282. }
  283. // Gamepad navigation mapping
  284. static void ImGui_ImplWin32_UpdateGamepads()
  285. {
  286. #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  287. ImGuiIO& io = ImGui::GetIO();
  288. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  289. //if ((io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) == 0) // FIXME: Technically feeding gamepad shouldn't depend on this now that they are regular inputs.
  290. // return;
  291. // Calling XInputGetState() every frame on disconnected gamepads is unfortunately too slow.
  292. // Instead we refresh gamepad availability by calling XInputGetCapabilities() _only_ after receiving WM_DEVICECHANGE.
  293. if (bd->WantUpdateHasGamepad)
  294. {
  295. XINPUT_CAPABILITIES caps = {};
  296. bd->HasGamepad = bd->XInputGetCapabilities ? (bd->XInputGetCapabilities(0, XINPUT_FLAG_GAMEPAD, &caps) == ERROR_SUCCESS) : false;
  297. bd->WantUpdateHasGamepad = false;
  298. }
  299. io.BackendFlags &= ~ImGuiBackendFlags_HasGamepad;
  300. XINPUT_STATE xinput_state;
  301. XINPUT_GAMEPAD& gamepad = xinput_state.Gamepad;
  302. if (!bd->HasGamepad || bd->XInputGetState == NULL || bd->XInputGetState(0, &xinput_state) != ERROR_SUCCESS)
  303. return;
  304. io.BackendFlags |= ImGuiBackendFlags_HasGamepad;
  305. #define IM_SATURATE(V) (V < 0.0f ? 0.0f : V > 1.0f ? 1.0f : V)
  306. #define MAP_BUTTON(KEY_NO, BUTTON_ENUM) { io.AddKeyEvent(KEY_NO, (gamepad.wButtons & BUTTON_ENUM) != 0); }
  307. #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)); }
  308. MAP_BUTTON(ImGuiKey_GamepadStart, XINPUT_GAMEPAD_START);
  309. MAP_BUTTON(ImGuiKey_GamepadBack, XINPUT_GAMEPAD_BACK);
  310. MAP_BUTTON(ImGuiKey_GamepadFaceLeft, XINPUT_GAMEPAD_X);
  311. MAP_BUTTON(ImGuiKey_GamepadFaceRight, XINPUT_GAMEPAD_B);
  312. MAP_BUTTON(ImGuiKey_GamepadFaceUp, XINPUT_GAMEPAD_Y);
  313. MAP_BUTTON(ImGuiKey_GamepadFaceDown, XINPUT_GAMEPAD_A);
  314. MAP_BUTTON(ImGuiKey_GamepadDpadLeft, XINPUT_GAMEPAD_DPAD_LEFT);
  315. MAP_BUTTON(ImGuiKey_GamepadDpadRight, XINPUT_GAMEPAD_DPAD_RIGHT);
  316. MAP_BUTTON(ImGuiKey_GamepadDpadUp, XINPUT_GAMEPAD_DPAD_UP);
  317. MAP_BUTTON(ImGuiKey_GamepadDpadDown, XINPUT_GAMEPAD_DPAD_DOWN);
  318. MAP_BUTTON(ImGuiKey_GamepadL1, XINPUT_GAMEPAD_LEFT_SHOULDER);
  319. MAP_BUTTON(ImGuiKey_GamepadR1, XINPUT_GAMEPAD_RIGHT_SHOULDER);
  320. MAP_ANALOG(ImGuiKey_GamepadL2, gamepad.bLeftTrigger, XINPUT_GAMEPAD_TRIGGER_THRESHOLD, 255);
  321. MAP_ANALOG(ImGuiKey_GamepadR2, gamepad.bRightTrigger, XINPUT_GAMEPAD_TRIGGER_THRESHOLD, 255);
  322. MAP_BUTTON(ImGuiKey_GamepadL3, XINPUT_GAMEPAD_LEFT_THUMB);
  323. MAP_BUTTON(ImGuiKey_GamepadR3, XINPUT_GAMEPAD_RIGHT_THUMB);
  324. MAP_ANALOG(ImGuiKey_GamepadLStickLeft, gamepad.sThumbLX, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
  325. MAP_ANALOG(ImGuiKey_GamepadLStickRight, gamepad.sThumbLX, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  326. MAP_ANALOG(ImGuiKey_GamepadLStickUp, gamepad.sThumbLY, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  327. MAP_ANALOG(ImGuiKey_GamepadLStickDown, gamepad.sThumbLY, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
  328. MAP_ANALOG(ImGuiKey_GamepadRStickLeft, gamepad.sThumbRX, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
  329. MAP_ANALOG(ImGuiKey_GamepadRStickRight, gamepad.sThumbRX, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  330. MAP_ANALOG(ImGuiKey_GamepadRStickUp, gamepad.sThumbRY, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
  331. MAP_ANALOG(ImGuiKey_GamepadRStickDown, gamepad.sThumbRY, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
  332. #undef MAP_BUTTON
  333. #undef MAP_ANALOG
  334. #endif // #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
  335. }
  336. static BOOL CALLBACK ImGui_ImplWin32_UpdateMonitors_EnumFunc(HMONITOR monitor, HDC, LPRECT, LPARAM)
  337. {
  338. MONITORINFO info = {};
  339. info.cbSize = sizeof(MONITORINFO);
  340. if (!::GetMonitorInfo(monitor, &info))
  341. return TRUE;
  342. ImGuiPlatformMonitor imgui_monitor;
  343. imgui_monitor.MainPos = ImVec2((float)info.rcMonitor.left, (float)info.rcMonitor.top);
  344. imgui_monitor.MainSize = ImVec2((float)(info.rcMonitor.right - info.rcMonitor.left), (float)(info.rcMonitor.bottom - info.rcMonitor.top));
  345. imgui_monitor.WorkPos = ImVec2((float)info.rcWork.left, (float)info.rcWork.top);
  346. imgui_monitor.WorkSize = ImVec2((float)(info.rcWork.right - info.rcWork.left), (float)(info.rcWork.bottom - info.rcWork.top));
  347. imgui_monitor.DpiScale = ImGui_ImplWin32_GetDpiScaleForMonitor(monitor);
  348. ImGuiPlatformIO& io = ImGui::GetPlatformIO();
  349. if (info.dwFlags & MONITORINFOF_PRIMARY)
  350. io.Monitors.push_front(imgui_monitor);
  351. else
  352. io.Monitors.push_back(imgui_monitor);
  353. return TRUE;
  354. }
  355. static void ImGui_ImplWin32_UpdateMonitors()
  356. {
  357. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  358. ImGui::GetPlatformIO().Monitors.resize(0);
  359. ::EnumDisplayMonitors(NULL, NULL, ImGui_ImplWin32_UpdateMonitors_EnumFunc, 0);
  360. bd->WantUpdateMonitors = false;
  361. }
  362. void ImGui_ImplWin32_NewFrame()
  363. {
  364. ImGuiIO& io = ImGui::GetIO();
  365. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  366. IM_ASSERT(bd != NULL && "Did you call ImGui_ImplWin32_Init()?");
  367. // Setup display size (every frame to accommodate for window resizing)
  368. RECT rect = { 0, 0, 0, 0 };
  369. ::GetClientRect(bd->hWnd, &rect);
  370. io.DisplaySize = ImVec2((float)(rect.right - rect.left), (float)(rect.bottom - rect.top));
  371. if (bd->WantUpdateMonitors)
  372. ImGui_ImplWin32_UpdateMonitors();
  373. // Setup time step
  374. INT64 current_time = 0;
  375. ::QueryPerformanceCounter((LARGE_INTEGER*)&current_time);
  376. io.DeltaTime = (float)(current_time - bd->Time) / bd->TicksPerSecond;
  377. bd->Time = current_time;
  378. // Update OS mouse position
  379. ImGui_ImplWin32_UpdateMouseData();
  380. // Process workarounds for known Windows key handling issues
  381. ImGui_ImplWin32_ProcessKeyEventsWorkarounds();
  382. // Update OS mouse cursor with the cursor requested by imgui
  383. ImGuiMouseCursor mouse_cursor = io.MouseDrawCursor ? ImGuiMouseCursor_None : ImGui::GetMouseCursor();
  384. if (bd->LastMouseCursor != mouse_cursor)
  385. {
  386. bd->LastMouseCursor = mouse_cursor;
  387. ImGui_ImplWin32_UpdateMouseCursor();
  388. }
  389. // Update game controllers (if enabled and available)
  390. ImGui_ImplWin32_UpdateGamepads();
  391. }
  392. // There is no distinct VK_xxx for keypad enter, instead it is VK_RETURN + KF_EXTENDED, we assign it an arbitrary value to make code more readable (VK_ codes go up to 255)
  393. #define IM_VK_KEYPAD_ENTER (VK_RETURN + 256)
  394. // Map VK_xxx to ImGuiKey_xxx.
  395. static ImGuiKey ImGui_ImplWin32_VirtualKeyToImGuiKey(WPARAM wParam)
  396. {
  397. switch (wParam)
  398. {
  399. case VK_TAB: return ImGuiKey_Tab;
  400. case VK_LEFT: return ImGuiKey_LeftArrow;
  401. case VK_RIGHT: return ImGuiKey_RightArrow;
  402. case VK_UP: return ImGuiKey_UpArrow;
  403. case VK_DOWN: return ImGuiKey_DownArrow;
  404. case VK_PRIOR: return ImGuiKey_PageUp;
  405. case VK_NEXT: return ImGuiKey_PageDown;
  406. case VK_HOME: return ImGuiKey_Home;
  407. case VK_END: return ImGuiKey_End;
  408. case VK_INSERT: return ImGuiKey_Insert;
  409. case VK_DELETE: return ImGuiKey_Delete;
  410. case VK_BACK: return ImGuiKey_Backspace;
  411. case VK_SPACE: return ImGuiKey_Space;
  412. case VK_RETURN: return ImGuiKey_Enter;
  413. case VK_ESCAPE: return ImGuiKey_Escape;
  414. case VK_OEM_7: return ImGuiKey_Apostrophe;
  415. case VK_OEM_COMMA: return ImGuiKey_Comma;
  416. case VK_OEM_MINUS: return ImGuiKey_Minus;
  417. case VK_OEM_PERIOD: return ImGuiKey_Period;
  418. case VK_OEM_2: return ImGuiKey_Slash;
  419. case VK_OEM_1: return ImGuiKey_Semicolon;
  420. case VK_OEM_PLUS: return ImGuiKey_Equal;
  421. case VK_OEM_4: return ImGuiKey_LeftBracket;
  422. case VK_OEM_5: return ImGuiKey_Backslash;
  423. case VK_OEM_6: return ImGuiKey_RightBracket;
  424. case VK_OEM_3: return ImGuiKey_GraveAccent;
  425. case VK_CAPITAL: return ImGuiKey_CapsLock;
  426. case VK_SCROLL: return ImGuiKey_ScrollLock;
  427. case VK_NUMLOCK: return ImGuiKey_NumLock;
  428. case VK_SNAPSHOT: return ImGuiKey_PrintScreen;
  429. case VK_PAUSE: return ImGuiKey_Pause;
  430. case VK_NUMPAD0: return ImGuiKey_Keypad0;
  431. case VK_NUMPAD1: return ImGuiKey_Keypad1;
  432. case VK_NUMPAD2: return ImGuiKey_Keypad2;
  433. case VK_NUMPAD3: return ImGuiKey_Keypad3;
  434. case VK_NUMPAD4: return ImGuiKey_Keypad4;
  435. case VK_NUMPAD5: return ImGuiKey_Keypad5;
  436. case VK_NUMPAD6: return ImGuiKey_Keypad6;
  437. case VK_NUMPAD7: return ImGuiKey_Keypad7;
  438. case VK_NUMPAD8: return ImGuiKey_Keypad8;
  439. case VK_NUMPAD9: return ImGuiKey_Keypad9;
  440. case VK_DECIMAL: return ImGuiKey_KeypadDecimal;
  441. case VK_DIVIDE: return ImGuiKey_KeypadDivide;
  442. case VK_MULTIPLY: return ImGuiKey_KeypadMultiply;
  443. case VK_SUBTRACT: return ImGuiKey_KeypadSubtract;
  444. case VK_ADD: return ImGuiKey_KeypadAdd;
  445. case IM_VK_KEYPAD_ENTER: return ImGuiKey_KeypadEnter;
  446. case VK_LSHIFT: return ImGuiKey_LeftShift;
  447. case VK_LCONTROL: return ImGuiKey_LeftCtrl;
  448. case VK_LMENU: return ImGuiKey_LeftAlt;
  449. case VK_LWIN: return ImGuiKey_LeftSuper;
  450. case VK_RSHIFT: return ImGuiKey_RightShift;
  451. case VK_RCONTROL: return ImGuiKey_RightCtrl;
  452. case VK_RMENU: return ImGuiKey_RightAlt;
  453. case VK_RWIN: return ImGuiKey_RightSuper;
  454. case VK_APPS: return ImGuiKey_Menu;
  455. case '0': return ImGuiKey_0;
  456. case '1': return ImGuiKey_1;
  457. case '2': return ImGuiKey_2;
  458. case '3': return ImGuiKey_3;
  459. case '4': return ImGuiKey_4;
  460. case '5': return ImGuiKey_5;
  461. case '6': return ImGuiKey_6;
  462. case '7': return ImGuiKey_7;
  463. case '8': return ImGuiKey_8;
  464. case '9': return ImGuiKey_9;
  465. case 'A': return ImGuiKey_A;
  466. case 'B': return ImGuiKey_B;
  467. case 'C': return ImGuiKey_C;
  468. case 'D': return ImGuiKey_D;
  469. case 'E': return ImGuiKey_E;
  470. case 'F': return ImGuiKey_F;
  471. case 'G': return ImGuiKey_G;
  472. case 'H': return ImGuiKey_H;
  473. case 'I': return ImGuiKey_I;
  474. case 'J': return ImGuiKey_J;
  475. case 'K': return ImGuiKey_K;
  476. case 'L': return ImGuiKey_L;
  477. case 'M': return ImGuiKey_M;
  478. case 'N': return ImGuiKey_N;
  479. case 'O': return ImGuiKey_O;
  480. case 'P': return ImGuiKey_P;
  481. case 'Q': return ImGuiKey_Q;
  482. case 'R': return ImGuiKey_R;
  483. case 'S': return ImGuiKey_S;
  484. case 'T': return ImGuiKey_T;
  485. case 'U': return ImGuiKey_U;
  486. case 'V': return ImGuiKey_V;
  487. case 'W': return ImGuiKey_W;
  488. case 'X': return ImGuiKey_X;
  489. case 'Y': return ImGuiKey_Y;
  490. case 'Z': return ImGuiKey_Z;
  491. case VK_F1: return ImGuiKey_F1;
  492. case VK_F2: return ImGuiKey_F2;
  493. case VK_F3: return ImGuiKey_F3;
  494. case VK_F4: return ImGuiKey_F4;
  495. case VK_F5: return ImGuiKey_F5;
  496. case VK_F6: return ImGuiKey_F6;
  497. case VK_F7: return ImGuiKey_F7;
  498. case VK_F8: return ImGuiKey_F8;
  499. case VK_F9: return ImGuiKey_F9;
  500. case VK_F10: return ImGuiKey_F10;
  501. case VK_F11: return ImGuiKey_F11;
  502. case VK_F12: return ImGuiKey_F12;
  503. default: return ImGuiKey_None;
  504. }
  505. }
  506. // Allow compilation with old Windows SDK. MinGW doesn't have default _WIN32_WINNT/WINVER versions.
  507. #ifndef WM_MOUSEHWHEEL
  508. #define WM_MOUSEHWHEEL 0x020E
  509. #endif
  510. #ifndef DBT_DEVNODES_CHANGED
  511. #define DBT_DEVNODES_CHANGED 0x0007
  512. #endif
  513. // Win32 message handler (process Win32 mouse/keyboard inputs, etc.)
  514. // Call from your application's message handler. Keep calling your message handler unless this function returns TRUE.
  515. // When implementing your own backend, you can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if Dear ImGui wants to use your inputs.
  516. // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application, or clear/overwrite your copy of the mouse data.
  517. // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application, or clear/overwrite your copy of the keyboard data.
  518. // Generally you may always pass all inputs to Dear ImGui, and hide them from your application based on those two flags.
  519. // PS: In this Win32 handler, we use the capture API (GetCapture/SetCapture/ReleaseCapture) to be able to read mouse coordinates when dragging mouse outside of our window bounds.
  520. // 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.
  521. #if 0
  522. // Copy this line into your .cpp file to forward declare the function.
  523. extern IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
  524. #endif
  525. IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
  526. {
  527. if (ImGui::GetCurrentContext() == NULL)
  528. return 0;
  529. ImGuiIO& io = ImGui::GetIO();
  530. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  531. switch (msg)
  532. {
  533. case WM_MOUSEMOVE:
  534. {
  535. // We need to call TrackMouseEvent in order to receive WM_MOUSELEAVE events
  536. bd->MouseHwnd = hwnd;
  537. if (!bd->MouseTracked)
  538. {
  539. TRACKMOUSEEVENT tme = { sizeof(tme), TME_LEAVE, hwnd, 0 };
  540. ::TrackMouseEvent(&tme);
  541. bd->MouseTracked = true;
  542. }
  543. POINT mouse_pos = { (LONG)GET_X_LPARAM(lParam), (LONG)GET_Y_LPARAM(lParam) };
  544. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  545. ::ClientToScreen(hwnd, &mouse_pos);
  546. io.AddMousePosEvent((float)mouse_pos.x, (float)mouse_pos.y);
  547. break;
  548. }
  549. case WM_MOUSELEAVE:
  550. if (bd->MouseHwnd == hwnd)
  551. bd->MouseHwnd = NULL;
  552. bd->MouseTracked = false;
  553. io.AddMousePosEvent(-FLT_MAX, -FLT_MAX);
  554. break;
  555. case WM_LBUTTONDOWN: case WM_LBUTTONDBLCLK:
  556. case WM_RBUTTONDOWN: case WM_RBUTTONDBLCLK:
  557. case WM_MBUTTONDOWN: case WM_MBUTTONDBLCLK:
  558. case WM_XBUTTONDOWN: case WM_XBUTTONDBLCLK:
  559. {
  560. int button = 0;
  561. if (msg == WM_LBUTTONDOWN || msg == WM_LBUTTONDBLCLK) { button = 0; }
  562. if (msg == WM_RBUTTONDOWN || msg == WM_RBUTTONDBLCLK) { button = 1; }
  563. if (msg == WM_MBUTTONDOWN || msg == WM_MBUTTONDBLCLK) { button = 2; }
  564. if (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONDBLCLK) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; }
  565. if (bd->MouseButtonsDown == 0 && ::GetCapture() == NULL)
  566. ::SetCapture(hwnd);
  567. bd->MouseButtonsDown |= 1 << button;
  568. io.AddMouseButtonEvent(button, true);
  569. return 0;
  570. }
  571. case WM_LBUTTONUP:
  572. case WM_RBUTTONUP:
  573. case WM_MBUTTONUP:
  574. case WM_XBUTTONUP:
  575. {
  576. int button = 0;
  577. if (msg == WM_LBUTTONUP) { button = 0; }
  578. if (msg == WM_RBUTTONUP) { button = 1; }
  579. if (msg == WM_MBUTTONUP) { button = 2; }
  580. if (msg == WM_XBUTTONUP) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; }
  581. bd->MouseButtonsDown &= ~(1 << button);
  582. if (bd->MouseButtonsDown == 0 && ::GetCapture() == hwnd)
  583. ::ReleaseCapture();
  584. io.AddMouseButtonEvent(button, false);
  585. return 0;
  586. }
  587. case WM_MOUSEWHEEL:
  588. io.AddMouseWheelEvent(0.0f, (float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA);
  589. return 0;
  590. case WM_MOUSEHWHEEL:
  591. io.AddMouseWheelEvent((float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA, 0.0f);
  592. return 0;
  593. case WM_KEYDOWN:
  594. case WM_KEYUP:
  595. case WM_SYSKEYDOWN:
  596. case WM_SYSKEYUP:
  597. {
  598. const bool is_key_down = (msg == WM_KEYDOWN || msg == WM_SYSKEYDOWN);
  599. if (wParam < 256)
  600. {
  601. // Submit modifiers
  602. ImGui_ImplWin32_UpdateKeyModifiers();
  603. // Obtain virtual key code
  604. // (keypad enter doesn't have its own... VK_RETURN with KF_EXTENDED flag means keypad enter, see IM_VK_KEYPAD_ENTER definition for details, it is mapped to ImGuiKey_KeyPadEnter.)
  605. int vk = (int)wParam;
  606. if ((wParam == VK_RETURN) && (HIWORD(lParam) & KF_EXTENDED))
  607. vk = IM_VK_KEYPAD_ENTER;
  608. // Submit key event
  609. const ImGuiKey key = ImGui_ImplWin32_VirtualKeyToImGuiKey(vk);
  610. const int scancode = (int)LOBYTE(HIWORD(lParam));
  611. if (key != ImGuiKey_None)
  612. ImGui_ImplWin32_AddKeyEvent(key, is_key_down, vk, scancode);
  613. // Submit individual left/right modifier events
  614. if (vk == VK_SHIFT)
  615. {
  616. // Important: Shift keys tend to get stuck when pressed together, missing key-up events are corrected in ImGui_ImplWin32_ProcessKeyEventsWorkarounds()
  617. if (IsVkDown(VK_LSHIFT) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftShift, is_key_down, VK_LSHIFT, scancode); }
  618. if (IsVkDown(VK_RSHIFT) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightShift, is_key_down, VK_RSHIFT, scancode); }
  619. }
  620. else if (vk == VK_CONTROL)
  621. {
  622. if (IsVkDown(VK_LCONTROL) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftCtrl, is_key_down, VK_LCONTROL, scancode); }
  623. if (IsVkDown(VK_RCONTROL) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightCtrl, is_key_down, VK_RCONTROL, scancode); }
  624. }
  625. else if (vk == VK_MENU)
  626. {
  627. if (IsVkDown(VK_LMENU) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_LeftAlt, is_key_down, VK_LMENU, scancode); }
  628. if (IsVkDown(VK_RMENU) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(ImGuiKey_RightAlt, is_key_down, VK_RMENU, scancode); }
  629. }
  630. }
  631. return 0;
  632. }
  633. case WM_SETFOCUS:
  634. case WM_KILLFOCUS:
  635. io.AddFocusEvent(msg == WM_SETFOCUS);
  636. return 0;
  637. case WM_CHAR:
  638. // You can also use ToAscii()+GetKeyboardState() to retrieve characters.
  639. if (wParam > 0 && wParam < 0x10000)
  640. io.AddInputCharacterUTF16((unsigned short)wParam);
  641. return 0;
  642. case WM_SETCURSOR:
  643. // This is required to restore cursor when transitioning from e.g resize borders to client area.
  644. if (LOWORD(lParam) == HTCLIENT && ImGui_ImplWin32_UpdateMouseCursor())
  645. return 1;
  646. return 0;
  647. case WM_DEVICECHANGE:
  648. if ((UINT)wParam == DBT_DEVNODES_CHANGED)
  649. bd->WantUpdateHasGamepad = true;
  650. return 0;
  651. case WM_DISPLAYCHANGE:
  652. bd->WantUpdateMonitors = true;
  653. return 0;
  654. }
  655. return 0;
  656. }
  657. //--------------------------------------------------------------------------------------------------------
  658. // DPI-related helpers (optional)
  659. //--------------------------------------------------------------------------------------------------------
  660. // - Use to enable DPI awareness without having to create an application manifest.
  661. // - Your own app may already do this via a manifest or explicit calls. This is mostly useful for our examples/ apps.
  662. // - In theory we could call simple functions from Windows SDK such as SetProcessDPIAware(), SetProcessDpiAwareness(), etc.
  663. // but most of the functions provided by Microsoft require Windows 8.1/10+ SDK at compile time and Windows 8/10+ at runtime,
  664. // neither we want to require the user to have. So we dynamically select and load those functions to avoid dependencies.
  665. //---------------------------------------------------------------------------------------------------------
  666. // This is the scheme successfully used by GLFW (from which we borrowed some of the code) and other apps aiming to be highly portable.
  667. // ImGui_ImplWin32_EnableDpiAwareness() is just a helper called by main.cpp, we don't call it automatically.
  668. // If you are trying to implement your own backend for your own engine, you may ignore that noise.
  669. //---------------------------------------------------------------------------------------------------------
  670. // Perform our own check with RtlVerifyVersionInfo() instead of using functions from <VersionHelpers.h> as they
  671. // require a manifest to be functional for checks above 8.1. See https://github.com/ocornut/imgui/issues/4200
  672. static BOOL _IsWindowsVersionOrGreater(WORD major, WORD minor, WORD)
  673. {
  674. typedef LONG(WINAPI* PFN_RtlVerifyVersionInfo)(OSVERSIONINFOEXW*, ULONG, ULONGLONG);
  675. static PFN_RtlVerifyVersionInfo RtlVerifyVersionInfoFn = NULL;
  676. if (RtlVerifyVersionInfoFn == NULL)
  677. if (HMODULE ntdllModule = ::GetModuleHandleA("ntdll.dll"))
  678. RtlVerifyVersionInfoFn = (PFN_RtlVerifyVersionInfo)GetProcAddress(ntdllModule, "RtlVerifyVersionInfo");
  679. if (RtlVerifyVersionInfoFn == NULL)
  680. return FALSE;
  681. RTL_OSVERSIONINFOEXW versionInfo = { };
  682. ULONGLONG conditionMask = 0;
  683. versionInfo.dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW);
  684. versionInfo.dwMajorVersion = major;
  685. versionInfo.dwMinorVersion = minor;
  686. VER_SET_CONDITION(conditionMask, VER_MAJORVERSION, VER_GREATER_EQUAL);
  687. VER_SET_CONDITION(conditionMask, VER_MINORVERSION, VER_GREATER_EQUAL);
  688. return (RtlVerifyVersionInfoFn(&versionInfo, VER_MAJORVERSION | VER_MINORVERSION, conditionMask) == 0) ? TRUE : FALSE;
  689. }
  690. #define _IsWindowsVistaOrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0600), LOBYTE(0x0600), 0) // _WIN32_WINNT_VISTA
  691. #define _IsWindows8OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0602), LOBYTE(0x0602), 0) // _WIN32_WINNT_WIN8
  692. #define _IsWindows8Point1OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0603), LOBYTE(0x0603), 0) // _WIN32_WINNT_WINBLUE
  693. #define _IsWindows10OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0A00), LOBYTE(0x0A00), 0) // _WIN32_WINNT_WINTHRESHOLD / _WIN32_WINNT_WIN10
  694. #ifndef DPI_ENUMS_DECLARED
  695. typedef enum { PROCESS_DPI_UNAWARE = 0, PROCESS_SYSTEM_DPI_AWARE = 1, PROCESS_PER_MONITOR_DPI_AWARE = 2 } PROCESS_DPI_AWARENESS;
  696. typedef enum { MDT_EFFECTIVE_DPI = 0, MDT_ANGULAR_DPI = 1, MDT_RAW_DPI = 2, MDT_DEFAULT = MDT_EFFECTIVE_DPI } MONITOR_DPI_TYPE;
  697. #endif
  698. #ifndef _DPI_AWARENESS_CONTEXTS_
  699. DECLARE_HANDLE(DPI_AWARENESS_CONTEXT);
  700. #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE (DPI_AWARENESS_CONTEXT)-3
  701. #endif
  702. #ifndef DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2
  703. #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2 (DPI_AWARENESS_CONTEXT)-4
  704. #endif
  705. typedef HRESULT(WINAPI* PFN_SetProcessDpiAwareness)(PROCESS_DPI_AWARENESS); // Shcore.lib + dll, Windows 8.1+
  706. typedef HRESULT(WINAPI* PFN_GetDpiForMonitor)(HMONITOR, MONITOR_DPI_TYPE, UINT*, UINT*); // Shcore.lib + dll, Windows 8.1+
  707. typedef DPI_AWARENESS_CONTEXT(WINAPI* PFN_SetThreadDpiAwarenessContext)(DPI_AWARENESS_CONTEXT); // User32.lib + dll, Windows 10 v1607+ (Creators Update)
  708. // Helper function to enable DPI awareness without setting up a manifest
  709. void ImGui_ImplWin32_EnableDpiAwareness()
  710. {
  711. // Make sure monitors will be updated with latest correct scaling
  712. if (ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData())
  713. bd->WantUpdateMonitors = true;
  714. if (_IsWindows10OrGreater())
  715. {
  716. static HINSTANCE user32_dll = ::LoadLibraryA("user32.dll"); // Reference counted per-process
  717. if (PFN_SetThreadDpiAwarenessContext SetThreadDpiAwarenessContextFn = (PFN_SetThreadDpiAwarenessContext)::GetProcAddress(user32_dll, "SetThreadDpiAwarenessContext"))
  718. {
  719. SetThreadDpiAwarenessContextFn(DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2);
  720. return;
  721. }
  722. }
  723. if (_IsWindows8Point1OrGreater())
  724. {
  725. static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
  726. if (PFN_SetProcessDpiAwareness SetProcessDpiAwarenessFn = (PFN_SetProcessDpiAwareness)::GetProcAddress(shcore_dll, "SetProcessDpiAwareness"))
  727. {
  728. SetProcessDpiAwarenessFn(PROCESS_PER_MONITOR_DPI_AWARE);
  729. return;
  730. }
  731. }
  732. #if _WIN32_WINNT >= 0x0600
  733. ::SetProcessDPIAware();
  734. #endif
  735. }
  736. #if defined(_MSC_VER) && !defined(NOGDI)
  737. #pragma comment(lib, "gdi32") // Link with gdi32.lib for GetDeviceCaps(). MinGW will require linking with '-lgdi32'
  738. #endif
  739. float ImGui_ImplWin32_GetDpiScaleForMonitor(void* monitor)
  740. {
  741. UINT xdpi = 96, ydpi = 96;
  742. if (_IsWindows8Point1OrGreater())
  743. {
  744. static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
  745. static PFN_GetDpiForMonitor GetDpiForMonitorFn = NULL;
  746. if (GetDpiForMonitorFn == NULL && shcore_dll != NULL)
  747. GetDpiForMonitorFn = (PFN_GetDpiForMonitor)::GetProcAddress(shcore_dll, "GetDpiForMonitor");
  748. if (GetDpiForMonitorFn != NULL)
  749. {
  750. GetDpiForMonitorFn((HMONITOR)monitor, MDT_EFFECTIVE_DPI, &xdpi, &ydpi);
  751. IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert!
  752. return xdpi / 96.0f;
  753. }
  754. }
  755. #ifndef NOGDI
  756. const HDC dc = ::GetDC(NULL);
  757. xdpi = ::GetDeviceCaps(dc, LOGPIXELSX);
  758. ydpi = ::GetDeviceCaps(dc, LOGPIXELSY);
  759. IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert!
  760. ::ReleaseDC(NULL, dc);
  761. #endif
  762. return xdpi / 96.0f;
  763. }
  764. float ImGui_ImplWin32_GetDpiScaleForHwnd(void* hwnd)
  765. {
  766. HMONITOR monitor = ::MonitorFromWindow((HWND)hwnd, MONITOR_DEFAULTTONEAREST);
  767. return ImGui_ImplWin32_GetDpiScaleForMonitor(monitor);
  768. }
  769. //--------------------------------------------------------------------------------------------------------
  770. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  771. // This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports simultaneously.
  772. // If you are new to dear imgui or creating a new binding for dear imgui, it is recommended that you completely ignore this section first..
  773. //--------------------------------------------------------------------------------------------------------
  774. // Helper structure we store in the void* RenderUserData field of each ImGuiViewport to easily retrieve our backend data.
  775. struct ImGui_ImplWin32_ViewportData
  776. {
  777. HWND Hwnd;
  778. bool HwndOwned;
  779. DWORD DwStyle;
  780. DWORD DwExStyle;
  781. ImGui_ImplWin32_ViewportData() { Hwnd = NULL; HwndOwned = false; DwStyle = DwExStyle = 0; }
  782. ~ImGui_ImplWin32_ViewportData() { IM_ASSERT(Hwnd == NULL); }
  783. };
  784. static void ImGui_ImplWin32_GetWin32StyleFromViewportFlags(ImGuiViewportFlags flags, DWORD* out_style, DWORD* out_ex_style)
  785. {
  786. if (flags & ImGuiViewportFlags_NoDecoration)
  787. *out_style = WS_POPUP;
  788. else
  789. *out_style = WS_OVERLAPPEDWINDOW;
  790. if (flags & ImGuiViewportFlags_NoTaskBarIcon)
  791. *out_ex_style = WS_EX_TOOLWINDOW;
  792. else
  793. *out_ex_style = WS_EX_APPWINDOW;
  794. if (flags & ImGuiViewportFlags_TopMost)
  795. *out_ex_style |= WS_EX_TOPMOST;
  796. }
  797. static void ImGui_ImplWin32_CreateWindow(ImGuiViewport* viewport)
  798. {
  799. ImGui_ImplWin32_ViewportData* vd = IM_NEW(ImGui_ImplWin32_ViewportData)();
  800. viewport->PlatformUserData = vd;
  801. // Select style and parent window
  802. ImGui_ImplWin32_GetWin32StyleFromViewportFlags(viewport->Flags, &vd->DwStyle, &vd->DwExStyle);
  803. HWND parent_window = NULL;
  804. if (viewport->ParentViewportId != 0)
  805. if (ImGuiViewport* parent_viewport = ImGui::FindViewportByID(viewport->ParentViewportId))
  806. parent_window = (HWND)parent_viewport->PlatformHandle;
  807. // Create window
  808. RECT rect = { (LONG)viewport->Pos.x, (LONG)viewport->Pos.y, (LONG)(viewport->Pos.x + viewport->Size.x), (LONG)(viewport->Pos.y + viewport->Size.y) };
  809. ::AdjustWindowRectEx(&rect, vd->DwStyle, FALSE, vd->DwExStyle);
  810. vd->Hwnd = ::CreateWindowEx(
  811. vd->DwExStyle, _T("ImGui Platform"), _T("Untitled"), vd->DwStyle, // Style, class name, window name
  812. rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top, // Window area
  813. parent_window, NULL, ::GetModuleHandle(NULL), NULL); // Parent window, Menu, Instance, Param
  814. vd->HwndOwned = true;
  815. viewport->PlatformRequestResize = false;
  816. viewport->PlatformHandle = viewport->PlatformHandleRaw = vd->Hwnd;
  817. }
  818. static void ImGui_ImplWin32_DestroyWindow(ImGuiViewport* viewport)
  819. {
  820. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  821. if (ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData)
  822. {
  823. if (::GetCapture() == vd->Hwnd)
  824. {
  825. // Transfer capture so if we started dragging from a window that later disappears, we'll still receive the MOUSEUP event.
  826. ::ReleaseCapture();
  827. ::SetCapture(bd->hWnd);
  828. }
  829. if (vd->Hwnd && vd->HwndOwned)
  830. ::DestroyWindow(vd->Hwnd);
  831. vd->Hwnd = NULL;
  832. IM_DELETE(vd);
  833. }
  834. viewport->PlatformUserData = viewport->PlatformHandle = NULL;
  835. }
  836. static void ImGui_ImplWin32_ShowWindow(ImGuiViewport* viewport)
  837. {
  838. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  839. IM_ASSERT(vd->Hwnd != 0);
  840. if (viewport->Flags & ImGuiViewportFlags_NoFocusOnAppearing)
  841. ::ShowWindow(vd->Hwnd, SW_SHOWNA);
  842. else
  843. ::ShowWindow(vd->Hwnd, SW_SHOW);
  844. }
  845. static void ImGui_ImplWin32_UpdateWindow(ImGuiViewport* viewport)
  846. {
  847. // (Optional) Update Win32 style if it changed _after_ creation.
  848. // Generally they won't change unless configuration flags are changed, but advanced uses (such as manually rewriting viewport flags) make this useful.
  849. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  850. IM_ASSERT(vd->Hwnd != 0);
  851. DWORD new_style;
  852. DWORD new_ex_style;
  853. ImGui_ImplWin32_GetWin32StyleFromViewportFlags(viewport->Flags, &new_style, &new_ex_style);
  854. // Only reapply the flags that have been changed from our point of view (as other flags are being modified by Windows)
  855. if (vd->DwStyle != new_style || vd->DwExStyle != new_ex_style)
  856. {
  857. // (Optional) Update TopMost state if it changed _after_ creation
  858. bool top_most_changed = (vd->DwExStyle & WS_EX_TOPMOST) != (new_ex_style & WS_EX_TOPMOST);
  859. HWND insert_after = top_most_changed ? ((viewport->Flags & ImGuiViewportFlags_TopMost) ? HWND_TOPMOST : HWND_NOTOPMOST) : 0;
  860. UINT swp_flag = top_most_changed ? 0 : SWP_NOZORDER;
  861. // Apply flags and position (since it is affected by flags)
  862. vd->DwStyle = new_style;
  863. vd->DwExStyle = new_ex_style;
  864. ::SetWindowLong(vd->Hwnd, GWL_STYLE, vd->DwStyle);
  865. ::SetWindowLong(vd->Hwnd, GWL_EXSTYLE, vd->DwExStyle);
  866. RECT rect = { (LONG)viewport->Pos.x, (LONG)viewport->Pos.y, (LONG)(viewport->Pos.x + viewport->Size.x), (LONG)(viewport->Pos.y + viewport->Size.y) };
  867. ::AdjustWindowRectEx(&rect, vd->DwStyle, FALSE, vd->DwExStyle); // Client to Screen
  868. ::SetWindowPos(vd->Hwnd, insert_after, rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top, swp_flag | SWP_NOACTIVATE | SWP_FRAMECHANGED);
  869. ::ShowWindow(vd->Hwnd, SW_SHOWNA); // This is necessary when we alter the style
  870. viewport->PlatformRequestMove = viewport->PlatformRequestResize = true;
  871. }
  872. }
  873. static ImVec2 ImGui_ImplWin32_GetWindowPos(ImGuiViewport* viewport)
  874. {
  875. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  876. IM_ASSERT(vd->Hwnd != 0);
  877. POINT pos = { 0, 0 };
  878. ::ClientToScreen(vd->Hwnd, &pos);
  879. return ImVec2((float)pos.x, (float)pos.y);
  880. }
  881. static void ImGui_ImplWin32_SetWindowPos(ImGuiViewport* viewport, ImVec2 pos)
  882. {
  883. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  884. IM_ASSERT(vd->Hwnd != 0);
  885. RECT rect = { (LONG)pos.x, (LONG)pos.y, (LONG)pos.x, (LONG)pos.y };
  886. ::AdjustWindowRectEx(&rect, vd->DwStyle, FALSE, vd->DwExStyle);
  887. ::SetWindowPos(vd->Hwnd, NULL, rect.left, rect.top, 0, 0, SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE);
  888. }
  889. static ImVec2 ImGui_ImplWin32_GetWindowSize(ImGuiViewport* viewport)
  890. {
  891. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  892. IM_ASSERT(vd->Hwnd != 0);
  893. RECT rect;
  894. ::GetClientRect(vd->Hwnd, &rect);
  895. return ImVec2(float(rect.right - rect.left), float(rect.bottom - rect.top));
  896. }
  897. static void ImGui_ImplWin32_SetWindowSize(ImGuiViewport* viewport, ImVec2 size)
  898. {
  899. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  900. IM_ASSERT(vd->Hwnd != 0);
  901. RECT rect = { 0, 0, (LONG)size.x, (LONG)size.y };
  902. ::AdjustWindowRectEx(&rect, vd->DwStyle, FALSE, vd->DwExStyle); // Client to Screen
  903. ::SetWindowPos(vd->Hwnd, NULL, 0, 0, rect.right - rect.left, rect.bottom - rect.top, SWP_NOZORDER | SWP_NOMOVE | SWP_NOACTIVATE);
  904. }
  905. static void ImGui_ImplWin32_SetWindowFocus(ImGuiViewport* viewport)
  906. {
  907. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  908. IM_ASSERT(vd->Hwnd != 0);
  909. ::BringWindowToTop(vd->Hwnd);
  910. ::SetForegroundWindow(vd->Hwnd);
  911. ::SetFocus(vd->Hwnd);
  912. }
  913. static bool ImGui_ImplWin32_GetWindowFocus(ImGuiViewport* viewport)
  914. {
  915. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  916. IM_ASSERT(vd->Hwnd != 0);
  917. return ::GetForegroundWindow() == vd->Hwnd;
  918. }
  919. static bool ImGui_ImplWin32_GetWindowMinimized(ImGuiViewport* viewport)
  920. {
  921. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  922. IM_ASSERT(vd->Hwnd != 0);
  923. return ::IsIconic(vd->Hwnd) != 0;
  924. }
  925. static void ImGui_ImplWin32_SetWindowTitle(ImGuiViewport* viewport, const char* title)
  926. {
  927. // ::SetWindowTextA() doesn't properly handle UTF-8 so we explicitely convert our string.
  928. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  929. IM_ASSERT(vd->Hwnd != 0);
  930. int n = ::MultiByteToWideChar(CP_UTF8, 0, title, -1, NULL, 0);
  931. ImVector<wchar_t> title_w;
  932. title_w.resize(n);
  933. ::MultiByteToWideChar(CP_UTF8, 0, title, -1, title_w.Data, n);
  934. ::SetWindowTextW(vd->Hwnd, title_w.Data);
  935. }
  936. static void ImGui_ImplWin32_SetWindowAlpha(ImGuiViewport* viewport, float alpha)
  937. {
  938. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  939. IM_ASSERT(vd->Hwnd != 0);
  940. IM_ASSERT(alpha >= 0.0f && alpha <= 1.0f);
  941. if (alpha < 1.0f)
  942. {
  943. DWORD style = ::GetWindowLongW(vd->Hwnd, GWL_EXSTYLE) | WS_EX_LAYERED;
  944. ::SetWindowLongW(vd->Hwnd, GWL_EXSTYLE, style);
  945. ::SetLayeredWindowAttributes(vd->Hwnd, 0, (BYTE)(255 * alpha), LWA_ALPHA);
  946. }
  947. else
  948. {
  949. DWORD style = ::GetWindowLongW(vd->Hwnd, GWL_EXSTYLE) & ~WS_EX_LAYERED;
  950. ::SetWindowLongW(vd->Hwnd, GWL_EXSTYLE, style);
  951. }
  952. }
  953. static float ImGui_ImplWin32_GetWindowDpiScale(ImGuiViewport* viewport)
  954. {
  955. ImGui_ImplWin32_ViewportData* vd = (ImGui_ImplWin32_ViewportData*)viewport->PlatformUserData;
  956. IM_ASSERT(vd->Hwnd != 0);
  957. return ImGui_ImplWin32_GetDpiScaleForHwnd(vd->Hwnd);
  958. }
  959. // FIXME-DPI: Testing DPI related ideas
  960. static void ImGui_ImplWin32_OnChangedViewport(ImGuiViewport* viewport)
  961. {
  962. (void)viewport;
  963. #if 0
  964. ImGuiStyle default_style;
  965. //default_style.WindowPadding = ImVec2(0, 0);
  966. //default_style.WindowBorderSize = 0.0f;
  967. //default_style.ItemSpacing.y = 3.0f;
  968. //default_style.FramePadding = ImVec2(0, 0);
  969. default_style.ScaleAllSizes(viewport->DpiScale);
  970. ImGuiStyle& style = ImGui::GetStyle();
  971. style = default_style;
  972. #endif
  973. }
  974. static LRESULT CALLBACK ImGui_ImplWin32_WndProcHandler_PlatformWindow(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)
  975. {
  976. if (ImGui_ImplWin32_WndProcHandler(hWnd, msg, wParam, lParam))
  977. return true;
  978. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle((void*)hWnd))
  979. {
  980. switch (msg)
  981. {
  982. case WM_CLOSE:
  983. viewport->PlatformRequestClose = true;
  984. return 0;
  985. case WM_MOVE:
  986. viewport->PlatformRequestMove = true;
  987. break;
  988. case WM_SIZE:
  989. viewport->PlatformRequestResize = true;
  990. break;
  991. case WM_MOUSEACTIVATE:
  992. if (viewport->Flags & ImGuiViewportFlags_NoFocusOnClick)
  993. return MA_NOACTIVATE;
  994. break;
  995. case WM_NCHITTEST:
  996. // Let mouse pass-through the window. This will allow the backend to call io.AddMouseViewportEvent() correctly. (which is optional).
  997. // The ImGuiViewportFlags_NoInputs flag is set while dragging a viewport, as want to detect the window behind the one we are dragging.
  998. // If you cannot easily access those viewport flags from your windowing/event code: you may manually synchronize its state e.g. in
  999. // your main loop after calling UpdatePlatformWindows(). Iterate all viewports/platform windows and pass the flag to your windowing system.
  1000. if (viewport->Flags & ImGuiViewportFlags_NoInputs)
  1001. return HTTRANSPARENT;
  1002. break;
  1003. }
  1004. }
  1005. return DefWindowProc(hWnd, msg, wParam, lParam);
  1006. }
  1007. static void ImGui_ImplWin32_InitPlatformInterface()
  1008. {
  1009. WNDCLASSEX wcex;
  1010. wcex.cbSize = sizeof(WNDCLASSEX);
  1011. wcex.style = CS_HREDRAW | CS_VREDRAW;
  1012. wcex.lpfnWndProc = ImGui_ImplWin32_WndProcHandler_PlatformWindow;
  1013. wcex.cbClsExtra = 0;
  1014. wcex.cbWndExtra = 0;
  1015. wcex.hInstance = ::GetModuleHandle(NULL);
  1016. wcex.hIcon = NULL;
  1017. wcex.hCursor = NULL;
  1018. wcex.hbrBackground = (HBRUSH)(COLOR_BACKGROUND + 1);
  1019. wcex.lpszMenuName = NULL;
  1020. wcex.lpszClassName = _T("ImGui Platform");
  1021. wcex.hIconSm = NULL;
  1022. ::RegisterClassEx(&wcex);
  1023. ImGui_ImplWin32_UpdateMonitors();
  1024. // Register platform interface (will be coupled with a renderer interface)
  1025. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  1026. platform_io.Platform_CreateWindow = ImGui_ImplWin32_CreateWindow;
  1027. platform_io.Platform_DestroyWindow = ImGui_ImplWin32_DestroyWindow;
  1028. platform_io.Platform_ShowWindow = ImGui_ImplWin32_ShowWindow;
  1029. platform_io.Platform_SetWindowPos = ImGui_ImplWin32_SetWindowPos;
  1030. platform_io.Platform_GetWindowPos = ImGui_ImplWin32_GetWindowPos;
  1031. platform_io.Platform_SetWindowSize = ImGui_ImplWin32_SetWindowSize;
  1032. platform_io.Platform_GetWindowSize = ImGui_ImplWin32_GetWindowSize;
  1033. platform_io.Platform_SetWindowFocus = ImGui_ImplWin32_SetWindowFocus;
  1034. platform_io.Platform_GetWindowFocus = ImGui_ImplWin32_GetWindowFocus;
  1035. platform_io.Platform_GetWindowMinimized = ImGui_ImplWin32_GetWindowMinimized;
  1036. platform_io.Platform_SetWindowTitle = ImGui_ImplWin32_SetWindowTitle;
  1037. platform_io.Platform_SetWindowAlpha = ImGui_ImplWin32_SetWindowAlpha;
  1038. platform_io.Platform_UpdateWindow = ImGui_ImplWin32_UpdateWindow;
  1039. platform_io.Platform_GetWindowDpiScale = ImGui_ImplWin32_GetWindowDpiScale; // FIXME-DPI
  1040. platform_io.Platform_OnChangedViewport = ImGui_ImplWin32_OnChangedViewport; // FIXME-DPI
  1041. // Register main window handle (which is owned by the main application, not by us)
  1042. // This is mostly for simplicity and consistency, so that our code (e.g. mouse handling etc.) can use same logic for main and secondary viewports.
  1043. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  1044. ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
  1045. ImGui_ImplWin32_ViewportData* vd = IM_NEW(ImGui_ImplWin32_ViewportData)();
  1046. vd->Hwnd = bd->hWnd;
  1047. vd->HwndOwned = false;
  1048. main_viewport->PlatformUserData = vd;
  1049. main_viewport->PlatformHandle = (void*)bd->hWnd;
  1050. }
  1051. static void ImGui_ImplWin32_ShutdownPlatformInterface()
  1052. {
  1053. ::UnregisterClass(_T("ImGui Platform"), ::GetModuleHandle(NULL));
  1054. ImGui::DestroyPlatformWindows();
  1055. }
  1056. //---------------------------------------------------------------------------------------------------------
  1057. // Transparency related helpers (optional)
  1058. //--------------------------------------------------------------------------------------------------------
  1059. #if defined(_MSC_VER)
  1060. #pragma comment(lib, "dwmapi") // Link with dwmapi.lib. MinGW will require linking with '-ldwmapi'
  1061. #endif
  1062. // [experimental]
  1063. // Borrowed from GLFW's function updateFramebufferTransparency() in src/win32_window.c
  1064. // (the Dwm* functions are Vista era functions but we are borrowing logic from GLFW)
  1065. void ImGui_ImplWin32_EnableAlphaCompositing(void* hwnd)
  1066. {
  1067. if (!_IsWindowsVistaOrGreater())
  1068. return;
  1069. BOOL composition;
  1070. if (FAILED(::DwmIsCompositionEnabled(&composition)) || !composition)
  1071. return;
  1072. BOOL opaque;
  1073. DWORD color;
  1074. if (_IsWindows8OrGreater() || (SUCCEEDED(::DwmGetColorizationColor(&color, &opaque)) && !opaque))
  1075. {
  1076. HRGN region = ::CreateRectRgn(0, 0, -1, -1);
  1077. DWM_BLURBEHIND bb = {};
  1078. bb.dwFlags = DWM_BB_ENABLE | DWM_BB_BLURREGION;
  1079. bb.hRgnBlur = region;
  1080. bb.fEnable = TRUE;
  1081. ::DwmEnableBlurBehindWindow((HWND)hwnd, &bb);
  1082. ::DeleteObject(region);
  1083. }
  1084. else
  1085. {
  1086. DWM_BLURBEHIND bb = {};
  1087. bb.dwFlags = DWM_BB_ENABLE;
  1088. ::DwmEnableBlurBehindWindow((HWND)hwnd, &bb);
  1089. }
  1090. }
  1091. //---------------------------------------------------------------------------------------------------------