imgui_impl_win32.cpp 68 KB

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