imgui_impl_win32.cpp 67 KB

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