imgui_impl_win32.cpp 30 KB

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