imgui_impl_win32.cpp 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714
  1. // dear imgui: Platform Binding for Windows (standard windows API for 32 and 64 bits applications)
  2. // This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..)
  3. // Implemented features:
  4. // [X] Platform: Clipboard support (for Win32 this is actually part of core imgui)
  5. // [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  6. // [X] Platform: Keyboard arrays indexed using VK_* Virtual Key Codes, e.g. ImGui::IsKeyPressed(VK_SPACE).
  7. // [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  8. // Missing features:
  9. // [ ] Platform: Gamepad support (best leaving it to user application to fill io.NavInputs[] with gamepad inputs from their source of choice).
  10. #include "imgui.h"
  11. #include "imgui_impl_win32.h"
  12. #ifndef WIN32_LEAN_AND_MEAN
  13. #define WIN32_LEAN_AND_MEAN
  14. #endif
  15. #include <windows.h>
  16. #include <tchar.h>
  17. // CHANGELOG
  18. // (minor and older changes stripped away, please see git history for details)
  19. // 2018-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  20. // 2018-06-29: Inputs: Added support for the ImGuiMouseCursor_Hand cursor.
  21. // 2018-06-10: Inputs: Fixed handling of mouse wheel messages to support fine position messages (typically sent by track-pads).
  22. // 2018-06-08: Misc: Extracted imgui_impl_win32.cpp/.h away from the old combined DX9/DX10/DX11/DX12 examples.
  23. // 2018-03-20: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors and ImGuiBackendFlags_HasSetMousePos flags + honor ImGuiConfigFlags_NoMouseCursorChange flag.
  24. // 2018-02-20: Inputs: Added support for mouse cursors (ImGui::GetMouseCursor() value and WM_SETCURSOR message handling).
  25. // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
  26. // 2018-02-06: Inputs: Honoring the io.WantSetMousePos by repositioning the mouse (when using navigation and ImGuiConfigFlags_NavMoveMouse is set).
  27. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  28. // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
  29. // 2018-01-08: Inputs: Added mapping for ImGuiKey_Insert.
  30. // 2018-01-05: Inputs: Added WM_LBUTTONDBLCLK double-click handlers for window classes with the CS_DBLCLKS flag.
  31. // 2017-10-23: Inputs: Added WM_SYSKEYDOWN / WM_SYSKEYUP handlers so e.g. the VK_MENU key can be read.
  32. // 2017-10-23: Inputs: Using Win32 ::SetCapture/::GetCapture() to retrieve mouse positions outside the client area when dragging.
  33. // 2016-11-12: Inputs: Only call Win32 ::SetCursor(NULL) when io.MouseDrawCursor is set.
  34. // Win32 Data
  35. static HWND g_hWnd = 0;
  36. static INT64 g_Time = 0;
  37. static INT64 g_TicksPerSecond = 0;
  38. static ImGuiMouseCursor g_LastMouseCursor = ImGuiMouseCursor_COUNT;
  39. static bool g_WantUpdateMonitors = true;
  40. // Forward Declarations
  41. static void ImGui_ImplWin32_InitPlatformInterface();
  42. static void ImGui_ImplWin32_ShutdownPlatformInterface();
  43. static void ImGui_ImplWin32_UpdateMonitors();
  44. // Functions
  45. bool ImGui_ImplWin32_Init(void* hwnd)
  46. {
  47. if (!::QueryPerformanceFrequency((LARGE_INTEGER *)&g_TicksPerSecond))
  48. return false;
  49. if (!::QueryPerformanceCounter((LARGE_INTEGER *)&g_Time))
  50. return false;
  51. // Setup back-end capabilities flags
  52. ImGuiIO& io = ImGui::GetIO();
  53. io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
  54. io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
  55. io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports; // We can create multi-viewports on the Platform side (optional)
  56. io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport; // We can set io.MouseHoveredViewport correctly (optional, not easy)
  57. // Our mouse update function expect PlatformHandle to be filled for the main viewport
  58. g_hWnd = (HWND)hwnd;
  59. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  60. main_viewport->PlatformHandle = (void*)g_hWnd;
  61. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  62. ImGui_ImplWin32_InitPlatformInterface();
  63. // Keyboard mapping. ImGui will use those indices to peek into the io.KeysDown[] array that we will update during the application lifetime.
  64. io.KeyMap[ImGuiKey_Tab] = VK_TAB;
  65. io.KeyMap[ImGuiKey_LeftArrow] = VK_LEFT;
  66. io.KeyMap[ImGuiKey_RightArrow] = VK_RIGHT;
  67. io.KeyMap[ImGuiKey_UpArrow] = VK_UP;
  68. io.KeyMap[ImGuiKey_DownArrow] = VK_DOWN;
  69. io.KeyMap[ImGuiKey_PageUp] = VK_PRIOR;
  70. io.KeyMap[ImGuiKey_PageDown] = VK_NEXT;
  71. io.KeyMap[ImGuiKey_Home] = VK_HOME;
  72. io.KeyMap[ImGuiKey_End] = VK_END;
  73. io.KeyMap[ImGuiKey_Insert] = VK_INSERT;
  74. io.KeyMap[ImGuiKey_Delete] = VK_DELETE;
  75. io.KeyMap[ImGuiKey_Backspace] = VK_BACK;
  76. io.KeyMap[ImGuiKey_Space] = VK_SPACE;
  77. io.KeyMap[ImGuiKey_Enter] = VK_RETURN;
  78. io.KeyMap[ImGuiKey_Escape] = VK_ESCAPE;
  79. io.KeyMap[ImGuiKey_A] = 'A';
  80. io.KeyMap[ImGuiKey_C] = 'C';
  81. io.KeyMap[ImGuiKey_V] = 'V';
  82. io.KeyMap[ImGuiKey_X] = 'X';
  83. io.KeyMap[ImGuiKey_Y] = 'Y';
  84. io.KeyMap[ImGuiKey_Z] = 'Z';
  85. return true;
  86. }
  87. void ImGui_ImplWin32_Shutdown()
  88. {
  89. ImGui_ImplWin32_ShutdownPlatformInterface();
  90. g_hWnd = (HWND)0;
  91. }
  92. static bool ImGui_ImplWin32_UpdateMouseCursor()
  93. {
  94. ImGuiIO& io = ImGui::GetIO();
  95. if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
  96. return false;
  97. ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
  98. if (imgui_cursor == ImGuiMouseCursor_None || io.MouseDrawCursor)
  99. {
  100. // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
  101. ::SetCursor(NULL);
  102. }
  103. else
  104. {
  105. // Show OS mouse cursor
  106. LPTSTR win32_cursor = IDC_ARROW;
  107. switch (imgui_cursor)
  108. {
  109. case ImGuiMouseCursor_Arrow: win32_cursor = IDC_ARROW; break;
  110. case ImGuiMouseCursor_TextInput: win32_cursor = IDC_IBEAM; break;
  111. case ImGuiMouseCursor_ResizeAll: win32_cursor = IDC_SIZEALL; break;
  112. case ImGuiMouseCursor_ResizeEW: win32_cursor = IDC_SIZEWE; break;
  113. case ImGuiMouseCursor_ResizeNS: win32_cursor = IDC_SIZENS; break;
  114. case ImGuiMouseCursor_ResizeNESW: win32_cursor = IDC_SIZENESW; break;
  115. case ImGuiMouseCursor_ResizeNWSE: win32_cursor = IDC_SIZENWSE; break;
  116. case ImGuiMouseCursor_Hand: win32_cursor = IDC_HAND; break;
  117. }
  118. ::SetCursor(::LoadCursor(NULL, win32_cursor));
  119. }
  120. return true;
  121. }
  122. // This code supports multiple OS Windows mapped into different ImGui viewports,
  123. // Because of that, it is a little more complicated than your typical single-viewport binding code.
  124. // A) In Single-viewport mode imgui needs:
  125. // - io.MousePos ............... mouse position, in client window coordinates (what you'd get from GetCursorPos+ScreenToClient() or from WM_MOUSEMOVE)
  126. // io.MousePos is (0,0) when the mouse is on the upper-left corner of the application window.
  127. // B) In Multi-viewport mode imgui needs: (when ImGuiConfigFlags_ViewportsEnable is set)
  128. // - io.MousePos ............... mouse position, in OS absolute coordinates (what you'd get from GetCursorPos(), or from WM_MOUSEMOVE+viewport->Pos).
  129. // io.MousePos is (0,0) when the mouse is on the upper-left of the primary monitor.
  130. // - io.MouseHoveredViewport ... [optional] viewport which mouse is hovering, with _VERY_ specific and strict conditions (Read comments next to io.MouseHoveredViewport. This is _NOT_ easy to provide in many high-level engine because of how we use the ImGuiViewportFlags_NoInputs flag)
  131. static void ImGui_ImplWin32_UpdateMousePos()
  132. {
  133. ImGuiIO& io = ImGui::GetIO();
  134. // Set OS mouse position if requested (rarely used, only when ImGuiConfigFlags_NavEnableSetMousePos is enabled by user)
  135. // (When multi-viewports are enabled, all imgui positions are same as OS positions.)
  136. if (io.WantSetMousePos)
  137. {
  138. POINT pos = { (int)io.MousePos.x, (int)io.MousePos.y };
  139. if ((io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable) == 0)
  140. ::ClientToScreen(g_hWnd, &pos);
  141. ::SetCursorPos(pos.x, pos.y);
  142. }
  143. io.MousePos = ImVec2(-FLT_MAX, -FLT_MAX);
  144. io.MouseHoveredViewport = 0;
  145. // Set mouse position and viewport
  146. // (Note that ScreenToClient() and adding +viewport->Pos are mutually cancelling each others when we have multi-viewport enabled. In single-viewport mode, viewport->Pos will be zero)
  147. POINT pos;
  148. if (!::GetCursorPos(&pos))
  149. return;
  150. if (HWND focused_hwnd = ::GetActiveWindow())
  151. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle((void*)focused_hwnd))
  152. {
  153. POINT client_pos = pos;
  154. ::ScreenToClient(focused_hwnd, &client_pos);
  155. io.MousePos = ImVec2(viewport->Pos.x + (float)client_pos.x, viewport->Pos.y + (float)client_pos.y);
  156. }
  157. // Our back-end can tell which window is under the mouse cursor (not every back-end can), so pass that info to imgui
  158. if (HWND hovered_hwnd = ::WindowFromPoint(pos))
  159. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle((void*)hovered_hwnd))
  160. io.MouseHoveredViewport = viewport->ID;
  161. }
  162. void ImGui_ImplWin32_NewFrame()
  163. {
  164. ImGuiIO& io = ImGui::GetIO();
  165. // Setup display size (every frame to accommodate for window resizing)
  166. RECT rect;
  167. ::GetClientRect(g_hWnd, &rect);
  168. io.DisplaySize = ImVec2((float)(rect.right - rect.left), (float)(rect.bottom - rect.top));
  169. if (g_WantUpdateMonitors)
  170. ImGui_ImplWin32_UpdateMonitors();
  171. // Setup time step
  172. INT64 current_time;
  173. ::QueryPerformanceCounter((LARGE_INTEGER *)&current_time);
  174. io.DeltaTime = (float)(current_time - g_Time) / g_TicksPerSecond;
  175. g_Time = current_time;
  176. // Read keyboard modifiers inputs
  177. io.KeyCtrl = (::GetKeyState(VK_CONTROL) & 0x8000) != 0;
  178. io.KeyShift = (::GetKeyState(VK_SHIFT) & 0x8000) != 0;
  179. io.KeyAlt = (::GetKeyState(VK_MENU) & 0x8000) != 0;
  180. io.KeySuper = false;
  181. // io.KeysDown[], io.MousePos, io.MouseDown[], io.MouseWheel: filled by the WndProc handler below.
  182. // Update OS mouse position
  183. ImGui_ImplWin32_UpdateMousePos();
  184. // Update OS mouse cursor with the cursor requested by imgui
  185. ImGuiMouseCursor mouse_cursor = io.MouseDrawCursor ? ImGuiMouseCursor_None : ImGui::GetMouseCursor();
  186. if (g_LastMouseCursor != mouse_cursor)
  187. {
  188. g_LastMouseCursor = mouse_cursor;
  189. ImGui_ImplWin32_UpdateMouseCursor();
  190. }
  191. }
  192. // Allow compilation with old Windows SDK. MinGW doesn't have default _WIN32_WINNT/WINVER versions.
  193. #ifndef WM_MOUSEHWHEEL
  194. #define WM_MOUSEHWHEEL 0x020E
  195. #endif
  196. // Process Win32 mouse/keyboard inputs.
  197. // You can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if dear imgui wants to use your inputs.
  198. // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application.
  199. // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application.
  200. // Generally you may always pass all inputs to dear imgui, and hide them from your application based on those two flags.
  201. // PS: In this Win32 handler, we use the capture API (GetCapture/SetCapture/ReleaseCapture) to be able to read mouse coordinations when dragging mouse outside of our window bounds.
  202. // 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.
  203. IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
  204. {
  205. if (ImGui::GetCurrentContext() == NULL)
  206. return 0;
  207. ImGuiIO& io = ImGui::GetIO();
  208. switch (msg)
  209. {
  210. case WM_LBUTTONDOWN: case WM_LBUTTONDBLCLK:
  211. case WM_RBUTTONDOWN: case WM_RBUTTONDBLCLK:
  212. case WM_MBUTTONDOWN: case WM_MBUTTONDBLCLK:
  213. {
  214. int button = 0;
  215. if (msg == WM_LBUTTONDOWN || msg == WM_LBUTTONDBLCLK) button = 0;
  216. if (msg == WM_RBUTTONDOWN || msg == WM_RBUTTONDBLCLK) button = 1;
  217. if (msg == WM_MBUTTONDOWN || msg == WM_MBUTTONDBLCLK) button = 2;
  218. if (!ImGui::IsAnyMouseDown() && ::GetCapture() == NULL)
  219. ::SetCapture(hwnd);
  220. io.MouseDown[button] = true;
  221. return 0;
  222. }
  223. case WM_LBUTTONUP:
  224. case WM_RBUTTONUP:
  225. case WM_MBUTTONUP:
  226. {
  227. int button = 0;
  228. if (msg == WM_LBUTTONUP) button = 0;
  229. if (msg == WM_RBUTTONUP) button = 1;
  230. if (msg == WM_MBUTTONUP) button = 2;
  231. io.MouseDown[button] = false;
  232. if (!ImGui::IsAnyMouseDown() && ::GetCapture() == hwnd)
  233. ::ReleaseCapture();
  234. return 0;
  235. }
  236. case WM_MOUSEWHEEL:
  237. io.MouseWheel += (float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA;
  238. return 0;
  239. case WM_MOUSEHWHEEL:
  240. io.MouseWheelH += (float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA;
  241. return 0;
  242. case WM_KEYDOWN:
  243. case WM_SYSKEYDOWN:
  244. if (wParam < 256)
  245. io.KeysDown[wParam] = 1;
  246. return 0;
  247. case WM_KEYUP:
  248. case WM_SYSKEYUP:
  249. if (wParam < 256)
  250. io.KeysDown[wParam] = 0;
  251. return 0;
  252. case WM_CHAR:
  253. // You can also use ToAscii()+GetKeyboardState() to retrieve characters.
  254. if (wParam > 0 && wParam < 0x10000)
  255. io.AddInputCharacter((unsigned short)wParam);
  256. return 0;
  257. case WM_SETCURSOR:
  258. if (LOWORD(lParam) == HTCLIENT && ImGui_ImplWin32_UpdateMouseCursor())
  259. return 1;
  260. return 0;
  261. case WM_DISPLAYCHANGE:
  262. g_WantUpdateMonitors = true;
  263. return 0;
  264. }
  265. return 0;
  266. }
  267. //--------------------------------------------------------------------------------------------------------
  268. // DPI handling
  269. // Those in theory should be simple calls but Windows has multiple ways to handle DPI, and most of them
  270. // require recent Windows versions at runtime or recent Windows SDK at compile-time. Neither we want to depend on.
  271. // So we dynamically select and load those functions to avoid dependencies. This is the scheme successfully
  272. // used by GLFW (from which we borrowed some of the code here) and other applications aiming to be portable.
  273. //---------------------------------------------------------------------------------------------------------
  274. // At this point ImGui_ImplWin32_EnableDpiAwareness() is just a helper called by main.cpp, we don't call it automatically.
  275. //---------------------------------------------------------------------------------------------------------
  276. static BOOL IsWindowsVersionOrGreater(WORD major, WORD minor, WORD sp)
  277. {
  278. OSVERSIONINFOEXW osvi = { sizeof(osvi), major, minor, 0, 0,{ 0 }, sp };
  279. DWORD mask = VER_MAJORVERSION | VER_MINORVERSION | VER_SERVICEPACKMAJOR;
  280. ULONGLONG cond = VerSetConditionMask(0, VER_MAJORVERSION, VER_GREATER_EQUAL);
  281. cond = VerSetConditionMask(cond, VER_MINORVERSION, VER_GREATER_EQUAL);
  282. cond = VerSetConditionMask(cond, VER_SERVICEPACKMAJOR, VER_GREATER_EQUAL);
  283. return VerifyVersionInfoW(&osvi, mask, cond);
  284. }
  285. #define IsWindows8Point1OrGreater() IsWindowsVersionOrGreater(HIBYTE(0x0602), LOBYTE(0x0602), 0) // _WIN32_WINNT_WINBLUE
  286. #define IsWindows10OrGreater() IsWindowsVersionOrGreater(HIBYTE(0x0A00), LOBYTE(0x0A00), 0) // _WIN32_WINNT_WIN10
  287. #ifndef DPI_ENUMS_DECLARED
  288. typedef enum { PROCESS_DPI_UNAWARE = 0, PROCESS_SYSTEM_DPI_AWARE = 1, PROCESS_PER_MONITOR_DPI_AWARE = 2 } PROCESS_DPI_AWARENESS;
  289. typedef enum { MDT_EFFECTIVE_DPI = 0, MDT_ANGULAR_DPI = 1, MDT_RAW_DPI = 2, MDT_DEFAULT = MDT_EFFECTIVE_DPI } MONITOR_DPI_TYPE;
  290. #endif
  291. #ifndef _DPI_AWARENESS_CONTEXTS_
  292. DECLARE_HANDLE(DPI_AWARENESS_CONTEXT);
  293. #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE (DPI_AWARENESS_CONTEXT)-3
  294. #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2 (DPI_AWARENESS_CONTEXT)-4
  295. #endif
  296. typedef HRESULT(WINAPI * PFN_SetProcessDpiAwareness)(PROCESS_DPI_AWARENESS); // Shcore.lib+dll, Windows 8.1
  297. typedef HRESULT(WINAPI * PFN_GetDpiForMonitor)(HMONITOR, MONITOR_DPI_TYPE, UINT*, UINT*); // Shcore.lib+dll, Windows 8.1
  298. typedef DPI_AWARENESS_CONTEXT(WINAPI * PFN_SetThreadDpiAwarenessContext)(DPI_AWARENESS_CONTEXT); // User32.lib+dll, Windows 10 v1607 (Creators Update)
  299. void ImGui_ImplWin32_EnableDpiAwareness()
  300. {
  301. // if (IsWindows10OrGreater()) // FIXME-DPI: This needs a manifest to succeed. Instead we try to grab the function pointer.
  302. {
  303. static HINSTANCE user32_dll = ::LoadLibraryA("user32.dll"); // Reference counted per-process
  304. if (PFN_SetThreadDpiAwarenessContext SetThreadDpiAwarenessContextFn = (PFN_SetThreadDpiAwarenessContext)::GetProcAddress(user32_dll, "SetThreadDpiAwarenessContext"))
  305. {
  306. SetThreadDpiAwarenessContextFn(DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2);
  307. return;
  308. }
  309. }
  310. if (IsWindows8Point1OrGreater())
  311. {
  312. static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
  313. if (PFN_SetProcessDpiAwareness SetProcessDpiAwarenessFn = (PFN_SetProcessDpiAwareness)::GetProcAddress(shcore_dll, "SetProcessDpiAwareness"))
  314. SetProcessDpiAwarenessFn(PROCESS_PER_MONITOR_DPI_AWARE);
  315. }
  316. else
  317. {
  318. SetProcessDPIAware();
  319. }
  320. }
  321. float ImGui_ImplWin32_GetDpiScaleForMonitor(void* monitor)
  322. {
  323. UINT xdpi = 96, ydpi = 96;
  324. if (IsWindows8Point1OrGreater())
  325. {
  326. static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
  327. if (PFN_GetDpiForMonitor GetDpiForMonitorFn = (PFN_GetDpiForMonitor)::GetProcAddress(shcore_dll, "GetDpiForMonitor"))
  328. GetDpiForMonitorFn((HMONITOR)monitor, MDT_EFFECTIVE_DPI, &xdpi, &ydpi);
  329. }
  330. else
  331. {
  332. const HDC dc = ::GetDC(NULL);
  333. xdpi = ::GetDeviceCaps(dc, LOGPIXELSX);
  334. ydpi = ::GetDeviceCaps(dc, LOGPIXELSY);
  335. ::ReleaseDC(NULL, dc);
  336. }
  337. IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert!
  338. return xdpi / 96.0f;
  339. }
  340. float ImGui_ImplWin32_GetDpiScaleForHwnd(void* hwnd)
  341. {
  342. HMONITOR monitor = ::MonitorFromWindow((HWND)hwnd, MONITOR_DEFAULTTONEAREST);
  343. return ImGui_ImplWin32_GetDpiScaleForMonitor(monitor);
  344. }
  345. float ImGui_ImplWin32_GetDpiScaleForRect(int x1, int y1, int x2, int y2)
  346. {
  347. RECT viewport_rect = { (LONG)x1, (LONG)y1, (LONG)x2, (LONG)y2 };
  348. HMONITOR monitor = ::MonitorFromRect(&viewport_rect, MONITOR_DEFAULTTONEAREST);
  349. return ImGui_ImplWin32_GetDpiScaleForMonitor(monitor);
  350. }
  351. //--------------------------------------------------------------------------------------------------------
  352. // IME (Input Method Editor) basic support for e.g. Asian language users
  353. //--------------------------------------------------------------------------------------------------------
  354. #if defined(_WIN32) && !defined(IMGUI_DISABLE_WIN32_FUNCTIONS) && !defined(IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCTIONS) && !defined(__GNUC__)
  355. #define HAS_WIN32_IME 1
  356. #include <imm.h>
  357. #ifdef _MSC_VER
  358. #pragma comment(lib, "imm32")
  359. #endif
  360. static void ImGui_ImplWin32_SetImeInputPos(ImGuiViewport* viewport, ImVec2 pos)
  361. {
  362. COMPOSITIONFORM cf = { CFS_FORCE_POSITION,{ (LONG)(pos.x - viewport->Pos.x), (LONG)(pos.y - viewport->Pos.y) },{ 0, 0, 0, 0 } };
  363. if (HWND hwnd = (HWND)viewport->PlatformHandle)
  364. if (HIMC himc = ::ImmGetContext(hwnd))
  365. {
  366. ::ImmSetCompositionWindow(himc, &cf);
  367. ::ImmReleaseContext(hwnd, himc);
  368. }
  369. }
  370. #else
  371. #define HAS_WIN32_IME 0
  372. #endif
  373. //--------------------------------------------------------------------------------------------------------
  374. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  375. // This is an _advanced_ and _optional_ feature, allowing the back-end to create and handle multiple viewports simultaneously.
  376. // 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..
  377. //--------------------------------------------------------------------------------------------------------
  378. struct ImGuiViewportDataWin32
  379. {
  380. HWND Hwnd;
  381. bool HwndOwned;
  382. DWORD DwStyle;
  383. DWORD DwExStyle;
  384. ImGuiViewportDataWin32() { Hwnd = NULL; HwndOwned = false; DwStyle = DwExStyle = 0; }
  385. ~ImGuiViewportDataWin32() { IM_ASSERT(Hwnd == NULL); }
  386. };
  387. static void ImGui_ImplWin32_CreateWindow(ImGuiViewport* viewport)
  388. {
  389. ImGuiViewportDataWin32* data = IM_NEW(ImGuiViewportDataWin32)();
  390. viewport->PlatformUserData = data;
  391. bool no_decoration = (viewport->Flags & ImGuiViewportFlags_NoDecoration) != 0;
  392. bool no_task_bar_icon = (viewport->Flags & ImGuiViewportFlags_NoTaskBarIcon) != 0;
  393. if (no_decoration)
  394. {
  395. data->DwStyle = WS_POPUP;
  396. data->DwExStyle = no_task_bar_icon ? WS_EX_TOOLWINDOW : WS_EX_APPWINDOW;
  397. }
  398. else
  399. {
  400. data->DwStyle = WS_OVERLAPPEDWINDOW;
  401. data->DwExStyle = no_task_bar_icon ? WS_EX_TOOLWINDOW : WS_EX_APPWINDOW;
  402. }
  403. if (viewport->Flags & ImGuiViewportFlags_TopMost)
  404. data->DwExStyle |= WS_EX_TOPMOST;
  405. // Create window
  406. RECT rect = { (LONG)viewport->Pos.x, (LONG)viewport->Pos.y, (LONG)(viewport->Pos.x + viewport->Size.x), (LONG)(viewport->Pos.y + viewport->Size.y) };
  407. ::AdjustWindowRectEx(&rect, data->DwStyle, FALSE, data->DwExStyle);
  408. data->Hwnd = ::CreateWindowEx(
  409. data->DwExStyle, _T("ImGui Platform"), _T("No Title Yet"), data->DwStyle, // Style, class name, window name
  410. rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top, // Window area
  411. g_hWnd, NULL, ::GetModuleHandle(NULL), NULL); // Parent window, Menu, Instance, Param
  412. data->HwndOwned = true;
  413. viewport->PlatformRequestResize = false;
  414. viewport->PlatformHandle = data->Hwnd;
  415. }
  416. static void ImGui_ImplWin32_DestroyWindow(ImGuiViewport* viewport)
  417. {
  418. if (ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData)
  419. {
  420. if (::GetCapture() == data->Hwnd)
  421. {
  422. // Transfer capture so if we started dragging from a window that later disappears, we'll still receive the MOUSEUP event.
  423. ::ReleaseCapture();
  424. ::SetCapture(g_hWnd);
  425. }
  426. if (data->Hwnd && data->HwndOwned)
  427. ::DestroyWindow(data->Hwnd);
  428. data->Hwnd = NULL;
  429. IM_DELETE(data);
  430. }
  431. viewport->PlatformUserData = viewport->PlatformHandle = NULL;
  432. }
  433. static void ImGui_ImplWin32_ShowWindow(ImGuiViewport* viewport)
  434. {
  435. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  436. IM_ASSERT(data->Hwnd != 0);
  437. if (viewport->Flags & ImGuiViewportFlags_NoFocusOnAppearing)
  438. ::ShowWindow(data->Hwnd, SW_SHOWNA);
  439. else
  440. ::ShowWindow(data->Hwnd, SW_SHOW);
  441. }
  442. static ImVec2 ImGui_ImplWin32_GetWindowPos(ImGuiViewport* viewport)
  443. {
  444. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  445. IM_ASSERT(data->Hwnd != 0);
  446. POINT pos = { 0, 0 };
  447. ::ClientToScreen(data->Hwnd, &pos);
  448. return ImVec2((float)pos.x, (float)pos.y);
  449. }
  450. static void ImGui_ImplWin32_SetWindowPos(ImGuiViewport* viewport, ImVec2 pos)
  451. {
  452. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  453. IM_ASSERT(data->Hwnd != 0);
  454. RECT rect = { (LONG)pos.x, (LONG)pos.y, (LONG)pos.x, (LONG)pos.y };
  455. ::AdjustWindowRectEx(&rect, data->DwStyle, FALSE, data->DwExStyle);
  456. ::SetWindowPos(data->Hwnd, NULL, rect.left, rect.top, 0, 0, SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE);
  457. }
  458. static ImVec2 ImGui_ImplWin32_GetWindowSize(ImGuiViewport* viewport)
  459. {
  460. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  461. IM_ASSERT(data->Hwnd != 0);
  462. RECT rect;
  463. ::GetClientRect(data->Hwnd, &rect);
  464. return ImVec2(float(rect.right - rect.left), float(rect.bottom - rect.top));
  465. }
  466. static void ImGui_ImplWin32_SetWindowSize(ImGuiViewport* viewport, ImVec2 size)
  467. {
  468. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  469. IM_ASSERT(data->Hwnd != 0);
  470. RECT rect = { 0, 0, (LONG)size.x, (LONG)size.y };
  471. ::AdjustWindowRectEx(&rect, data->DwStyle, FALSE, data->DwExStyle); // Client to Screen
  472. ::SetWindowPos(data->Hwnd, NULL, 0, 0, rect.right - rect.left, rect.bottom - rect.top, SWP_NOZORDER | SWP_NOMOVE | SWP_NOACTIVATE);
  473. }
  474. static void ImGui_ImplWin32_SetWindowFocus(ImGuiViewport* viewport)
  475. {
  476. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  477. IM_ASSERT(data->Hwnd != 0);
  478. ::BringWindowToTop(data->Hwnd);
  479. ::SetForegroundWindow(data->Hwnd);
  480. ::SetFocus(data->Hwnd);
  481. }
  482. static bool ImGui_ImplWin32_GetWindowFocus(ImGuiViewport* viewport)
  483. {
  484. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  485. IM_ASSERT(data->Hwnd != 0);
  486. return ::GetActiveWindow() == data->Hwnd;
  487. }
  488. static bool ImGui_ImplWin32_GetWindowMinimized(ImGuiViewport* viewport)
  489. {
  490. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  491. IM_ASSERT(data->Hwnd != 0);
  492. return ::IsIconic(data->Hwnd) != 0;
  493. }
  494. static void ImGui_ImplWin32_SetWindowTitle(ImGuiViewport* viewport, const char* title)
  495. {
  496. // ::SetWindowTextA() doesn't properly handle UTF-8 so we explicitely convert our string.
  497. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  498. IM_ASSERT(data->Hwnd != 0);
  499. int n = ::MultiByteToWideChar(CP_UTF8, 0, title, -1, NULL, 0);
  500. ImVector<wchar_t> title_w;
  501. title_w.resize(n);
  502. ::MultiByteToWideChar(CP_UTF8, 0, title, -1, title_w.Data, n);
  503. ::SetWindowTextW(data->Hwnd, title_w.Data);
  504. }
  505. static void ImGui_ImplWin32_SetWindowAlpha(ImGuiViewport* viewport, float alpha)
  506. {
  507. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  508. IM_ASSERT(data->Hwnd != 0);
  509. IM_ASSERT(alpha >= 0.0f && alpha <= 1.0f);
  510. if (alpha < 1.0f)
  511. {
  512. DWORD style = ::GetWindowLongW(data->Hwnd, GWL_EXSTYLE) | WS_EX_LAYERED;
  513. ::SetWindowLongW(data->Hwnd, GWL_EXSTYLE, style);
  514. ::SetLayeredWindowAttributes(data->Hwnd, 0, (BYTE)(255 * alpha), LWA_ALPHA);
  515. }
  516. else
  517. {
  518. DWORD style = ::GetWindowLongW(data->Hwnd, GWL_EXSTYLE) & ~WS_EX_LAYERED;
  519. ::SetWindowLongW(data->Hwnd, GWL_EXSTYLE, style);
  520. }
  521. }
  522. static float ImGui_ImplWin32_GetWindowDpiScale(ImGuiViewport* viewport)
  523. {
  524. ImGuiViewportDataWin32* data = (ImGuiViewportDataWin32*)viewport->PlatformUserData;
  525. if (data && data->Hwnd)
  526. return ImGui_ImplWin32_GetDpiScaleForHwnd(data->Hwnd);
  527. // The first frame a viewport is created we don't have a window yet
  528. return ImGui_ImplWin32_GetDpiScaleForRect(
  529. (int)(viewport->Pos.x), (int)(viewport->Pos.y),
  530. (int)(viewport->Pos.x + viewport->Size.x), (int)(viewport->Pos.y + viewport->Size.y));
  531. }
  532. // FIXME-DPI: Testing DPI related ideas
  533. static void ImGui_ImplWin32_OnChangedViewport(ImGuiViewport* viewport)
  534. {
  535. (void)viewport;
  536. #if 0
  537. ImGuiStyle default_style;
  538. //default_style.WindowPadding = ImVec2(0, 0);
  539. //default_style.WindowBorderSize = 0.0f;
  540. //default_style.ItemSpacing.y = 3.0f;
  541. //default_style.FramePadding = ImVec2(0, 0);
  542. default_style.ScaleAllSizes(viewport->DpiScale);
  543. ImGuiStyle& style = ImGui::GetStyle();
  544. style = default_style;
  545. #endif
  546. }
  547. static LRESULT CALLBACK ImGui_ImplWin32_WndProcHandler_PlatformWindow(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)
  548. {
  549. if (ImGui_ImplWin32_WndProcHandler(hWnd, msg, wParam, lParam))
  550. return true;
  551. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle((void*)hWnd))
  552. {
  553. switch (msg)
  554. {
  555. case WM_CLOSE:
  556. viewport->PlatformRequestClose = true;
  557. return 0;
  558. case WM_MOVE:
  559. viewport->PlatformRequestMove = true;
  560. break;
  561. case WM_SIZE:
  562. viewport->PlatformRequestResize = true;
  563. break;
  564. case WM_NCHITTEST:
  565. // Let mouse pass-through the window. This will allow the back-end to set io.MouseHoveredViewport properly (which is OPTIONAL).
  566. // The ImGuiViewportFlags_NoInputs flag is set while dragging a viewport, as want to detect the window behind the one we are dragging.
  567. // If you cannot easily access those viewport flags from your windowing/event code: you may manually synchronize its state e.g. in
  568. // your main loop after calling UpdatePlatformWindows(). Iterate all viewports/platform windows and pass the flag to your windowing system.
  569. if (viewport->Flags & ImGuiViewportFlags_NoInputs)
  570. return HTTRANSPARENT;
  571. break;
  572. }
  573. }
  574. return DefWindowProc(hWnd, msg, wParam, lParam);
  575. }
  576. static BOOL CALLBACK ImGui_ImplWin32_UpdateMonitors_EnumFunc(HMONITOR monitor, HDC, LPRECT, LPARAM)
  577. {
  578. MONITORINFO info = { 0 };
  579. info.cbSize = sizeof(MONITORINFO);
  580. if (!::GetMonitorInfo(monitor, &info))
  581. return TRUE;
  582. ImGuiPlatformMonitor imgui_monitor;
  583. imgui_monitor.MainPos = ImVec2((float)info.rcMonitor.left, (float)info.rcMonitor.top);
  584. imgui_monitor.MainSize = ImVec2((float)(info.rcMonitor.right - info.rcMonitor.left), (float)(info.rcMonitor.bottom - info.rcMonitor.top));
  585. imgui_monitor.WorkPos = ImVec2((float)info.rcWork.left, (float)info.rcWork.top);
  586. imgui_monitor.WorkSize = ImVec2((float)(info.rcWork.right - info.rcWork.left), (float)(info.rcWork.bottom - info.rcWork.top));
  587. imgui_monitor.DpiScale = ImGui_ImplWin32_GetDpiScaleForMonitor(monitor);
  588. ImGuiPlatformIO& io = ImGui::GetPlatformIO();
  589. if (info.dwFlags & MONITORINFOF_PRIMARY)
  590. io.Monitors.push_front(imgui_monitor);
  591. else
  592. io.Monitors.push_back(imgui_monitor);
  593. return TRUE;
  594. }
  595. static void ImGui_ImplWin32_UpdateMonitors()
  596. {
  597. ImGui::GetPlatformIO().Monitors.resize(0);
  598. ::EnumDisplayMonitors(NULL, NULL, ImGui_ImplWin32_UpdateMonitors_EnumFunc, NULL);
  599. g_WantUpdateMonitors = false;
  600. }
  601. static void ImGui_ImplWin32_InitPlatformInterface()
  602. {
  603. WNDCLASSEX wcex;
  604. wcex.cbSize = sizeof(WNDCLASSEX);
  605. wcex.style = CS_HREDRAW | CS_VREDRAW;
  606. wcex.lpfnWndProc = ImGui_ImplWin32_WndProcHandler_PlatformWindow;
  607. wcex.cbClsExtra = 0;
  608. wcex.cbWndExtra = 0;
  609. wcex.hInstance = ::GetModuleHandle(NULL);
  610. wcex.hIcon = NULL;
  611. wcex.hCursor = NULL;
  612. wcex.hbrBackground = (HBRUSH)(COLOR_BACKGROUND + 1);
  613. wcex.lpszMenuName = NULL;
  614. wcex.lpszClassName = _T("ImGui Platform");
  615. wcex.hIconSm = NULL;
  616. ::RegisterClassEx(&wcex);
  617. ImGui_ImplWin32_UpdateMonitors();
  618. // Register platform interface (will be coupled with a renderer interface)
  619. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  620. platform_io.Platform_CreateWindow = ImGui_ImplWin32_CreateWindow;
  621. platform_io.Platform_DestroyWindow = ImGui_ImplWin32_DestroyWindow;
  622. platform_io.Platform_ShowWindow = ImGui_ImplWin32_ShowWindow;
  623. platform_io.Platform_SetWindowPos = ImGui_ImplWin32_SetWindowPos;
  624. platform_io.Platform_GetWindowPos = ImGui_ImplWin32_GetWindowPos;
  625. platform_io.Platform_SetWindowSize = ImGui_ImplWin32_SetWindowSize;
  626. platform_io.Platform_GetWindowSize = ImGui_ImplWin32_GetWindowSize;
  627. platform_io.Platform_SetWindowFocus = ImGui_ImplWin32_SetWindowFocus;
  628. platform_io.Platform_GetWindowFocus = ImGui_ImplWin32_GetWindowFocus;
  629. platform_io.Platform_GetWindowMinimized = ImGui_ImplWin32_GetWindowMinimized;
  630. platform_io.Platform_SetWindowTitle = ImGui_ImplWin32_SetWindowTitle;
  631. platform_io.Platform_SetWindowAlpha = ImGui_ImplWin32_SetWindowAlpha;
  632. platform_io.Platform_GetWindowDpiScale = ImGui_ImplWin32_GetWindowDpiScale;
  633. platform_io.Platform_OnChangedViewport = ImGui_ImplWin32_OnChangedViewport; // FIXME-DPI
  634. #if HAS_WIN32_IME
  635. platform_io.Platform_SetImeInputPos = ImGui_ImplWin32_SetImeInputPos;
  636. #endif
  637. // Register main window handle (which is owned by the main application, not by us)
  638. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  639. ImGuiViewportDataWin32* data = IM_NEW(ImGuiViewportDataWin32)();
  640. data->Hwnd = g_hWnd;
  641. data->HwndOwned = false;
  642. main_viewport->PlatformUserData = data;
  643. main_viewport->PlatformHandle = (void*)g_hWnd;
  644. }
  645. static void ImGui_ImplWin32_ShutdownPlatformInterface()
  646. {
  647. ::UnregisterClass(_T("ImGui Platform"), ::GetModuleHandle(NULL));
  648. }