Debian Codegraph @

subprojects/imgui-1.91.6/backends/imgui_impl_win32.cpp

raw
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
4 // Implemented features:
5 // [X] Platform: Clipboard support (for Win32 this is actually part of core dear imgui)
6 // [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen/Pen.
7 // [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 are obsolete since 1.87 and not supported since 1.91.5]
8 // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
9 // [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
10
11 // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
12 // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
13 // Learn about Dear ImGui:
14 // - FAQ https://dearimgui.com/faq
15 // - Getting Started https://dearimgui.com/getting-started
16 // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
17 // - Introduction, links and more at the top of imgui.cpp
18
19 // Configuration flags to add in your imconfig file:
20 //#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.
21
22 // CHANGELOG
23 // (minor and older changes stripped away, please see git history for details)
24 // 2024-07-08: Inputs: Fixed ImGuiMod_Super being mapped to VK_APPS instead of VK_LWIN||VK_RWIN. (#7768)
25 // 2023-10-05: Inputs: Added support for extra ImGuiKey values: F13 to F24 function keys, app back/forward keys.
26 // 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).
27 // 2023-09-07: Inputs: Added support for keyboard codepage conversion for when application is compiled in MBCS mode and using a non-Unicode window.
28 // 2023-04-19: Added ImGui_ImplWin32_InitForOpenGL() to facilitate combining raw Win32/Winapi with OpenGL. (#3218)
29 // 2023-04-04: Inputs: Added support for io.AddMouseSourceEvent() to discriminate ImGuiMouseSource_Mouse/ImGuiMouseSource_TouchScreen/ImGuiMouseSource_Pen. (#2702)
30 // 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)
31 // 2023-02-02: Inputs: Flipping WM_MOUSEHWHEEL (horizontal mouse-wheel) value to match other backends and offer consistent horizontal scrolling direction. (#4019, #6096, #1463)
32 // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
33 // 2022-09-28: Inputs: Convert WM_CHAR values with MultiByteToWideChar() when window class was registered as MBCS (not Unicode).
34 // 2022-09-26: Inputs: Renamed ImGuiKey_ModXXX introduced in 1.87 to ImGuiMod_XXX (old names still supported).
35 // 2022-01-26: Inputs: replaced short-lived io.AddKeyModsEvent() (added two weeks ago) with io.AddKeyEvent() using ImGuiKey_ModXXX flags. Sorry for the confusion.
36 // 2021-01-20: Inputs: calling new io.AddKeyAnalogEvent() for gamepad support, instead of writing directly to io.NavInputs[].
37 // 2022-01-17: Inputs: calling new io.AddMousePosEvent(), io.AddMouseButtonEvent(), io.AddMouseWheelEvent() API (1.87+).
38 // 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.
39 // 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.
40 // 2022-01-12: Inputs: Maintain our own copy of MouseButtonsDown mask instead of using ImGui::IsAnyMouseDown() which will be obsoleted.
41 // 2022-01-10: Inputs: calling new io.AddKeyEvent(), io.AddKeyModsEvent() + io.SetKeyEventNativeData() API (1.87+). Support for full ImGuiKey range.
42 // 2021-12-16: Inputs: Fill VK_LCONTROL/VK_RCONTROL/VK_LSHIFT/VK_RSHIFT/VK_LMENU/VK_RMENU for completeness.
43 // 2021-08-17: Calling io.AddFocusEvent() on WM_SETFOCUS/WM_KILLFOCUS messages.
44 // 2021-08-02: Inputs: Fixed keyboard modifiers being reported when host window doesn't have focus.
45 // 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).
46 // 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).
47 // 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).
48 // 2021-03-23: Inputs: Clearing keyboard down array when losing focus (WM_KILLFOCUS).
49 // 2021-02-18: Added ImGui_ImplWin32_EnableAlphaCompositing(). Non Visual Studio users will need to link with dwmapi.lib (MinGW/gcc: use -ldwmapi).
50 // 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.
51 // 2021-01-25: Inputs: Dynamically loading XInput DLL.
52 // 2020-12-04: Misc: Fixed setting of io.DisplaySize to invalid/uninitialized data when after hwnd has been closed.
53 // 2020-03-03: Inputs: Calling AddInputCharacterUTF16() to support surrogate pairs leading to codepoint >= 0x10000 (for more complete CJK inputs)
54 // 2020-02-17: Added ImGui_ImplWin32_EnableDpiAwareness(), ImGui_ImplWin32_GetDpiScaleForHwnd(), ImGui_ImplWin32_GetDpiScaleForMonitor() helper functions.
55 // 2020-01-14: Inputs: Added support for #define IMGUI_IMPL_WIN32_DISABLE_GAMEPAD/IMGUI_IMPL_WIN32_DISABLE_LINKING_XINPUT.
56 // 2019-12-05: Inputs: Added support for ImGuiMouseCursor_NotAllowed mouse cursor.
57 // 2019-05-11: Inputs: Don't filter value from WM_CHAR before calling AddInputCharacter().
58 // 2019-01-17: Misc: Using GetForegroundWindow()+IsChild() instead of GetActiveWindow() to be compatible with windows created in a different thread or parent.
59 // 2019-01-17: Inputs: Added support for mouse buttons 4 and 5 via WM_XBUTTON* messages.
60 // 2019-01-15: Inputs: Added support for XInput gamepads (if ImGuiConfigFlags_NavEnableGamepad is set by user application).
61 // 2018-11-30: Misc: Setting up io.BackendPlatformName so it can be displayed in the About Window.
62 // 2018-06-29: Inputs: Added support for the ImGuiMouseCursor_Hand cursor.
63 // 2018-06-10: Inputs: Fixed handling of mouse wheel messages to support fine position messages (typically sent by track-pads).
64 // 2018-06-08: Misc: Extracted imgui_impl_win32.cpp/.h away from the old combined DX9/DX10/DX11/DX12 examples.
65 // 2018-03-20: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors and ImGuiBackendFlags_HasSetMousePos flags + honor ImGuiConfigFlags_NoMouseCursorChange flag.
66 // 2018-02-20: Inputs: Added support for mouse cursors (ImGui::GetMouseCursor() value and WM_SETCURSOR message handling).
67 // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
68 // 2018-02-06: Inputs: Honoring the io.WantSetMousePos by repositioning the mouse (when using navigation and ImGuiConfigFlags_NavMoveMouse is set).
69 // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
70 // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
71 // 2018-01-08: Inputs: Added mapping for ImGuiKey_Insert.
72 // 2018-01-05: Inputs: Added WM_LBUTTONDBLCLK double-click handlers for window classes with the CS_DBLCLKS flag.
73 // 2017-10-23: Inputs: Added WM_SYSKEYDOWN / WM_SYSKEYUP handlers so e.g. the VK_MENU key can be read.
74 // 2017-10-23: Inputs: Using Win32 ::SetCapture/::GetCapture() to retrieve mouse positions outside the client area when dragging.
75 // 2016-11-12: Inputs: Only call Win32 ::SetCursor(nullptr) when io.MouseDrawCursor is set.
76
77 #include "imgui.h"
78 #ifndef IMGUI_DISABLE
79 #include "imgui_impl_win32.h"
80 #ifndef WIN32_LEAN_AND_MEAN
81 #define WIN32_LEAN_AND_MEAN
82 #endif
83 #include <windows.h>
84 #include <windowsx.h> // GET_X_LPARAM(), GET_Y_LPARAM()
85 #include <tchar.h>
86 #include <dwmapi.h>
87
88 // Using XInput for gamepad (will load DLL dynamically)
89 #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
90 #include <xinput.h>
91 typedef DWORD(WINAPI* PFN_XInputGetCapabilities)(DWORD, DWORD, XINPUT_CAPABILITIES*);
92 typedef DWORD(WINAPI* PFN_XInputGetState)(DWORD, XINPUT_STATE*);
93 #endif
94
95 // Clang/GCC warnings with -Weverything
96 #if defined(__clang__)
97 #pragma clang diagnostic push
98 #pragma clang diagnostic ignored "-Wcast-function-type" // warning: cast between incompatible function types (for loader)
99 #endif
100 #if defined(__GNUC__)
101 #pragma GCC diagnostic push
102 #pragma GCC diagnostic ignored "-Wpragmas" // warning: unknown option after '#pragma GCC diagnostic' kind
103 #pragma GCC diagnostic ignored "-Wcast-function-type" // warning: cast between incompatible function types (for loader)
104 #endif
105
106 struct ImGui_ImplWin32_Data
107 {
108 HWND hWnd;
109 HWND MouseHwnd;
110 int MouseTrackedArea; // 0: not tracked, 1: client area, 2: non-client area
111 int MouseButtonsDown;
112 INT64 Time;
113 INT64 TicksPerSecond;
114 ImGuiMouseCursor LastMouseCursor;
115 UINT32 KeyboardCodePage;
116
117 #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
118 bool HasGamepad;
119 bool WantUpdateHasGamepad;
120 HMODULE XInputDLL;
121 PFN_XInputGetCapabilities XInputGetCapabilities;
122 PFN_XInputGetState XInputGetState;
123 #endif
124
125 ImGui_ImplWin32_Data() { memset((void*)this, 0, sizeof(*this)); }
126 };
127
128 // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts
129 // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
130 // FIXME: multi-context support is not well tested and probably dysfunctional in this backend.
131 // FIXME: some shared resources (mouse cursor shape, gamepad) are mishandled when using multi-context.
132 static ImGui_ImplWin32_Data* ImGui_ImplWin32_GetBackendData()
133 {
134 return ImGui::GetCurrentContext() ? (ImGui_ImplWin32_Data*)ImGui::GetIO().BackendPlatformUserData : nullptr;
135 }
136 static ImGui_ImplWin32_Data* ImGui_ImplWin32_GetBackendData(ImGuiIO& io)
137 {
138 return (ImGui_ImplWin32_Data*)io.BackendPlatformUserData;
139 }
140
141 // Functions
142 static void ImGui_ImplWin32_UpdateKeyboardCodePage(ImGuiIO& io)
143 {
144 // Retrieve keyboard code page, required for handling of non-Unicode Windows.
145 ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(io);
146 HKL keyboard_layout = ::GetKeyboardLayout(0);
147 LCID keyboard_lcid = MAKELCID(HIWORD(keyboard_layout), SORT_DEFAULT);
148 if (::GetLocaleInfoA(keyboard_lcid, (LOCALE_RETURN_NUMBER | LOCALE_IDEFAULTANSICODEPAGE), (LPSTR)&bd->KeyboardCodePage, sizeof(bd->KeyboardCodePage)) == 0)
149 bd->KeyboardCodePage = CP_ACP; // Fallback to default ANSI code page when fails.
150 }
151
152 static bool ImGui_ImplWin32_InitEx(void* hwnd, bool platform_has_own_dc)
153 {
154 ImGuiIO& io = ImGui::GetIO();
155 IMGUI_CHECKVERSION();
156 IM_ASSERT(io.BackendPlatformUserData == nullptr && "Already initialized a platform backend!");
157
158 INT64 perf_frequency, perf_counter;
159 if (!::QueryPerformanceFrequency((LARGE_INTEGER*)&perf_frequency))
160 return false;
161 if (!::QueryPerformanceCounter((LARGE_INTEGER*)&perf_counter))
162 return false;
163
164 // Setup backend capabilities flags
165 ImGui_ImplWin32_Data* bd = IM_NEW(ImGui_ImplWin32_Data)();
166 io.BackendPlatformUserData = (void*)bd;
167 io.BackendPlatformName = "imgui_impl_win32";
168 io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
169 io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
170
171 bd->hWnd = (HWND)hwnd;
172 bd->TicksPerSecond = perf_frequency;
173 bd->Time = perf_counter;
174 bd->LastMouseCursor = ImGuiMouseCursor_COUNT;
175 ImGui_ImplWin32_UpdateKeyboardCodePage(io);
176
177 // Set platform dependent data in viewport
178 ImGuiViewport* main_viewport = ImGui::GetMainViewport();
179 main_viewport->PlatformHandle = main_viewport->PlatformHandleRaw = (void*)bd->hWnd;
180 IM_UNUSED(platform_has_own_dc); // Used in 'docking' branch
181
182 // Dynamically load XInput library
183 #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
184 bd->WantUpdateHasGamepad = true;
185 const char* xinput_dll_names[] =
186 {
187 "xinput1_4.dll", // Windows 8+
188 "xinput1_3.dll", // DirectX SDK
189 "xinput9_1_0.dll", // Windows Vista, Windows 7
190 "xinput1_2.dll", // DirectX SDK
191 "xinput1_1.dll" // DirectX SDK
192 };
193 for (int n = 0; n < IM_ARRAYSIZE(xinput_dll_names); n++)
194 if (HMODULE dll = ::LoadLibraryA(xinput_dll_names[n]))
195 {
196 bd->XInputDLL = dll;
197 bd->XInputGetCapabilities = (PFN_XInputGetCapabilities)::GetProcAddress(dll, "XInputGetCapabilities");
198 bd->XInputGetState = (PFN_XInputGetState)::GetProcAddress(dll, "XInputGetState");
199 break;
200 }
201 #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
202
203 return true;
204 }
205
206 IMGUI_IMPL_API bool ImGui_ImplWin32_Init(void* hwnd)
207 {
208 return ImGui_ImplWin32_InitEx(hwnd, false);
209 }
210
211 IMGUI_IMPL_API bool ImGui_ImplWin32_InitForOpenGL(void* hwnd)
212 {
213 // OpenGL needs CS_OWNDC
214 return ImGui_ImplWin32_InitEx(hwnd, true);
215 }
216
217 void ImGui_ImplWin32_Shutdown()
218 {
219 ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
220 IM_ASSERT(bd != nullptr && "No platform backend to shutdown, or already shutdown?");
221 ImGuiIO& io = ImGui::GetIO();
222
223 // Unload XInput library
224 #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
225 if (bd->XInputDLL)
226 ::FreeLibrary(bd->XInputDLL);
227 #endif // IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
228
229 io.BackendPlatformName = nullptr;
230 io.BackendPlatformUserData = nullptr;
231 io.BackendFlags &= ~(ImGuiBackendFlags_HasMouseCursors | ImGuiBackendFlags_HasSetMousePos | ImGuiBackendFlags_HasGamepad);
232 IM_DELETE(bd);
233 }
234
235 static bool ImGui_ImplWin32_UpdateMouseCursor(ImGuiIO& io, ImGuiMouseCursor imgui_cursor)
236 {
237 if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
238 return false;
239
240 if (imgui_cursor == ImGuiMouseCursor_None || io.MouseDrawCursor)
241 {
242 // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
243 ::SetCursor(nullptr);
244 }
245 else
246 {
247 // Show OS mouse cursor
248 LPTSTR win32_cursor = IDC_ARROW;
249 switch (imgui_cursor)
250 {
251 case ImGuiMouseCursor_Arrow: win32_cursor = IDC_ARROW; break;
252 case ImGuiMouseCursor_TextInput: win32_cursor = IDC_IBEAM; break;
253 case ImGuiMouseCursor_ResizeAll: win32_cursor = IDC_SIZEALL; break;
254 case ImGuiMouseCursor_ResizeEW: win32_cursor = IDC_SIZEWE; break;
255 case ImGuiMouseCursor_ResizeNS: win32_cursor = IDC_SIZENS; break;
256 case ImGuiMouseCursor_ResizeNESW: win32_cursor = IDC_SIZENESW; break;
257 case ImGuiMouseCursor_ResizeNWSE: win32_cursor = IDC_SIZENWSE; break;
258 case ImGuiMouseCursor_Hand: win32_cursor = IDC_HAND; break;
259 case ImGuiMouseCursor_NotAllowed: win32_cursor = IDC_NO; break;
260 }
261 ::SetCursor(::LoadCursor(nullptr, win32_cursor));
262 }
263 return true;
264 }
265
266 static bool IsVkDown(int vk)
267 {
268 return (::GetKeyState(vk) & 0x8000) != 0;
269 }
270
271 static void ImGui_ImplWin32_AddKeyEvent(ImGuiIO& io, ImGuiKey key, bool down, int native_keycode, int native_scancode = -1)
272 {
273 io.AddKeyEvent(key, down);
274 io.SetKeyEventNativeData(key, native_keycode, native_scancode); // To support legacy indexing (<1.87 user code)
275 IM_UNUSED(native_scancode);
276 }
277
278 static void ImGui_ImplWin32_ProcessKeyEventsWorkarounds(ImGuiIO& io)
279 {
280 // Left & right Shift keys: when both are pressed together, Windows tend to not generate the WM_KEYUP event for the first released one.
281 if (ImGui::IsKeyDown(ImGuiKey_LeftShift) && !IsVkDown(VK_LSHIFT))
282 ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftShift, false, VK_LSHIFT);
283 if (ImGui::IsKeyDown(ImGuiKey_RightShift) && !IsVkDown(VK_RSHIFT))
284 ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightShift, false, VK_RSHIFT);
285
286 // Sometimes WM_KEYUP for Win key is not passed down to the app (e.g. for Win+V on some setups, according to GLFW).
287 if (ImGui::IsKeyDown(ImGuiKey_LeftSuper) && !IsVkDown(VK_LWIN))
288 ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftSuper, false, VK_LWIN);
289 if (ImGui::IsKeyDown(ImGuiKey_RightSuper) && !IsVkDown(VK_RWIN))
290 ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightSuper, false, VK_RWIN);
291 }
292
293 static void ImGui_ImplWin32_UpdateKeyModifiers(ImGuiIO& io)
294 {
295 io.AddKeyEvent(ImGuiMod_Ctrl, IsVkDown(VK_CONTROL));
296 io.AddKeyEvent(ImGuiMod_Shift, IsVkDown(VK_SHIFT));
297 io.AddKeyEvent(ImGuiMod_Alt, IsVkDown(VK_MENU));
298 io.AddKeyEvent(ImGuiMod_Super, IsVkDown(VK_LWIN) || IsVkDown(VK_RWIN));
299 }
300
301 static void ImGui_ImplWin32_UpdateMouseData(ImGuiIO& io)
302 {
303 ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(io);
304 IM_ASSERT(bd->hWnd != 0);
305
306 HWND focused_window = ::GetForegroundWindow();
307 const bool is_app_focused = (focused_window == bd->hWnd);
308 if (is_app_focused)
309 {
310 // (Optional) Set OS mouse position from Dear ImGui if requested (rarely used, only when io.ConfigNavMoveSetMousePos is enabled by user)
311 if (io.WantSetMousePos)
312 {
313 POINT pos = { (int)io.MousePos.x, (int)io.MousePos.y };
314 if (::ClientToScreen(bd->hWnd, &pos))
315 ::SetCursorPos(pos.x, pos.y);
316 }
317
318 // (Optional) Fallback to provide mouse position when focused (WM_MOUSEMOVE already provides this when hovered or captured)
319 // This also fills a short gap when clicking non-client area: WM_NCMOUSELEAVE -> modal OS move -> gap -> WM_NCMOUSEMOVE
320 if (!io.WantSetMousePos && bd->MouseTrackedArea == 0)
321 {
322 POINT pos;
323 if (::GetCursorPos(&pos) && ::ScreenToClient(bd->hWnd, &pos))
324 io.AddMousePosEvent((float)pos.x, (float)pos.y);
325 }
326 }
327 }
328
329 // Gamepad navigation mapping
330 static void ImGui_ImplWin32_UpdateGamepads(ImGuiIO& io)
331 {
332 #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
333 ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(io);
334 //if ((io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) == 0) // FIXME: Technically feeding gamepad shouldn't depend on this now that they are regular inputs.
335 // return;
336
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
346 io.BackendFlags &= ~ImGuiBackendFlags_HasGamepad;
347 XINPUT_STATE xinput_state;
348 XINPUT_GAMEPAD& gamepad = xinput_state.Gamepad;
349 if (!bd->HasGamepad || bd->XInputGetState == nullptr || bd->XInputGetState(0, &xinput_state) != ERROR_SUCCESS)
350 return;
351 io.BackendFlags |= ImGuiBackendFlags_HasGamepad;
352
353 #define IM_SATURATE(V) (V < 0.0f ? 0.0f : V > 1.0f ? 1.0f : V)
354 #define MAP_BUTTON(KEY_NO, BUTTON_ENUM) { io.AddKeyEvent(KEY_NO, (gamepad.wButtons & BUTTON_ENUM) != 0); }
355 #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)); }
356 MAP_BUTTON(ImGuiKey_GamepadStart, XINPUT_GAMEPAD_START);
357 MAP_BUTTON(ImGuiKey_GamepadBack, XINPUT_GAMEPAD_BACK);
358 MAP_BUTTON(ImGuiKey_GamepadFaceLeft, XINPUT_GAMEPAD_X);
359 MAP_BUTTON(ImGuiKey_GamepadFaceRight, XINPUT_GAMEPAD_B);
360 MAP_BUTTON(ImGuiKey_GamepadFaceUp, XINPUT_GAMEPAD_Y);
361 MAP_BUTTON(ImGuiKey_GamepadFaceDown, XINPUT_GAMEPAD_A);
362 MAP_BUTTON(ImGuiKey_GamepadDpadLeft, XINPUT_GAMEPAD_DPAD_LEFT);
363 MAP_BUTTON(ImGuiKey_GamepadDpadRight, XINPUT_GAMEPAD_DPAD_RIGHT);
364 MAP_BUTTON(ImGuiKey_GamepadDpadUp, XINPUT_GAMEPAD_DPAD_UP);
365 MAP_BUTTON(ImGuiKey_GamepadDpadDown, XINPUT_GAMEPAD_DPAD_DOWN);
366 MAP_BUTTON(ImGuiKey_GamepadL1, XINPUT_GAMEPAD_LEFT_SHOULDER);
367 MAP_BUTTON(ImGuiKey_GamepadR1, XINPUT_GAMEPAD_RIGHT_SHOULDER);
368 MAP_ANALOG(ImGuiKey_GamepadL2, gamepad.bLeftTrigger, XINPUT_GAMEPAD_TRIGGER_THRESHOLD, 255);
369 MAP_ANALOG(ImGuiKey_GamepadR2, gamepad.bRightTrigger, XINPUT_GAMEPAD_TRIGGER_THRESHOLD, 255);
370 MAP_BUTTON(ImGuiKey_GamepadL3, XINPUT_GAMEPAD_LEFT_THUMB);
371 MAP_BUTTON(ImGuiKey_GamepadR3, XINPUT_GAMEPAD_RIGHT_THUMB);
372 MAP_ANALOG(ImGuiKey_GamepadLStickLeft, gamepad.sThumbLX, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
373 MAP_ANALOG(ImGuiKey_GamepadLStickRight, gamepad.sThumbLX, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
374 MAP_ANALOG(ImGuiKey_GamepadLStickUp, gamepad.sThumbLY, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
375 MAP_ANALOG(ImGuiKey_GamepadLStickDown, gamepad.sThumbLY, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
376 MAP_ANALOG(ImGuiKey_GamepadRStickLeft, gamepad.sThumbRX, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
377 MAP_ANALOG(ImGuiKey_GamepadRStickRight, gamepad.sThumbRX, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
378 MAP_ANALOG(ImGuiKey_GamepadRStickUp, gamepad.sThumbRY, +XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, +32767);
379 MAP_ANALOG(ImGuiKey_GamepadRStickDown, gamepad.sThumbRY, -XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE, -32768);
380 #undef MAP_BUTTON
381 #undef MAP_ANALOG
382 #else // #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
383 IM_UNUSED(io);
384 #endif
385 }
386
387 void ImGui_ImplWin32_NewFrame()
388 {
389 ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData();
390 IM_ASSERT(bd != nullptr && "Context or backend not initialized? Did you call ImGui_ImplWin32_Init()?");
391 ImGuiIO& io = ImGui::GetIO();
392
393 // Setup display size (every frame to accommodate for window resizing)
394 RECT rect = { 0, 0, 0, 0 };
395 ::GetClientRect(bd->hWnd, &rect);
396 io.DisplaySize = ImVec2((float)(rect.right - rect.left), (float)(rect.bottom - rect.top));
397
398 // Setup time step
399 INT64 current_time = 0;
400 ::QueryPerformanceCounter((LARGE_INTEGER*)&current_time);
401 io.DeltaTime = (float)(current_time - bd->Time) / bd->TicksPerSecond;
402 bd->Time = current_time;
403
404 // Update OS mouse position
405 ImGui_ImplWin32_UpdateMouseData(io);
406
407 // Process workarounds for known Windows key handling issues
408 ImGui_ImplWin32_ProcessKeyEventsWorkarounds(io);
409
410 // Update OS mouse cursor with the cursor requested by imgui
411 ImGuiMouseCursor mouse_cursor = io.MouseDrawCursor ? ImGuiMouseCursor_None : ImGui::GetMouseCursor();
412 if (bd->LastMouseCursor != mouse_cursor)
413 {
414 bd->LastMouseCursor = mouse_cursor;
415 ImGui_ImplWin32_UpdateMouseCursor(io, mouse_cursor);
416 }
417
418 // Update game controllers (if enabled and available)
419 ImGui_ImplWin32_UpdateGamepads(io);
420 }
421
422 // Map VK_xxx to ImGuiKey_xxx.
423 // Not static to allow third-party code to use that if they want to (but undocumented)
424 ImGuiKey ImGui_ImplWin32_KeyEventToImGuiKey(WPARAM wParam, LPARAM lParam);
425 ImGuiKey ImGui_ImplWin32_KeyEventToImGuiKey(WPARAM wParam, LPARAM lParam)
426 {
427 // There is no distinct VK_xxx for keypad enter, instead it is VK_RETURN + KF_EXTENDED.
428 if ((wParam == VK_RETURN) && (HIWORD(lParam) & KF_EXTENDED))
429 return ImGuiKey_KeypadEnter;
430
431 switch (wParam)
432 {
433 case VK_TAB: return ImGuiKey_Tab;
434 case VK_LEFT: return ImGuiKey_LeftArrow;
435 case VK_RIGHT: return ImGuiKey_RightArrow;
436 case VK_UP: return ImGuiKey_UpArrow;
437 case VK_DOWN: return ImGuiKey_DownArrow;
438 case VK_PRIOR: return ImGuiKey_PageUp;
439 case VK_NEXT: return ImGuiKey_PageDown;
440 case VK_HOME: return ImGuiKey_Home;
441 case VK_END: return ImGuiKey_End;
442 case VK_INSERT: return ImGuiKey_Insert;
443 case VK_DELETE: return ImGuiKey_Delete;
444 case VK_BACK: return ImGuiKey_Backspace;
445 case VK_SPACE: return ImGuiKey_Space;
446 case VK_RETURN: return ImGuiKey_Enter;
447 case VK_ESCAPE: return ImGuiKey_Escape;
448 case VK_OEM_7: return ImGuiKey_Apostrophe;
449 case VK_OEM_COMMA: return ImGuiKey_Comma;
450 case VK_OEM_MINUS: return ImGuiKey_Minus;
451 case VK_OEM_PERIOD: return ImGuiKey_Period;
452 case VK_OEM_2: return ImGuiKey_Slash;
453 case VK_OEM_1: return ImGuiKey_Semicolon;
454 case VK_OEM_PLUS: return ImGuiKey_Equal;
455 case VK_OEM_4: return ImGuiKey_LeftBracket;
456 case VK_OEM_5: return ImGuiKey_Backslash;
457 case VK_OEM_6: return ImGuiKey_RightBracket;
458 case VK_OEM_3: return ImGuiKey_GraveAccent;
459 case VK_CAPITAL: return ImGuiKey_CapsLock;
460 case VK_SCROLL: return ImGuiKey_ScrollLock;
461 case VK_NUMLOCK: return ImGuiKey_NumLock;
462 case VK_SNAPSHOT: return ImGuiKey_PrintScreen;
463 case VK_PAUSE: return ImGuiKey_Pause;
464 case VK_NUMPAD0: return ImGuiKey_Keypad0;
465 case VK_NUMPAD1: return ImGuiKey_Keypad1;
466 case VK_NUMPAD2: return ImGuiKey_Keypad2;
467 case VK_NUMPAD3: return ImGuiKey_Keypad3;
468 case VK_NUMPAD4: return ImGuiKey_Keypad4;
469 case VK_NUMPAD5: return ImGuiKey_Keypad5;
470 case VK_NUMPAD6: return ImGuiKey_Keypad6;
471 case VK_NUMPAD7: return ImGuiKey_Keypad7;
472 case VK_NUMPAD8: return ImGuiKey_Keypad8;
473 case VK_NUMPAD9: return ImGuiKey_Keypad9;
474 case VK_DECIMAL: return ImGuiKey_KeypadDecimal;
475 case VK_DIVIDE: return ImGuiKey_KeypadDivide;
476 case VK_MULTIPLY: return ImGuiKey_KeypadMultiply;
477 case VK_SUBTRACT: return ImGuiKey_KeypadSubtract;
478 case VK_ADD: return ImGuiKey_KeypadAdd;
479 case VK_LSHIFT: return ImGuiKey_LeftShift;
480 case VK_LCONTROL: return ImGuiKey_LeftCtrl;
481 case VK_LMENU: return ImGuiKey_LeftAlt;
482 case VK_LWIN: return ImGuiKey_LeftSuper;
483 case VK_RSHIFT: return ImGuiKey_RightShift;
484 case VK_RCONTROL: return ImGuiKey_RightCtrl;
485 case VK_RMENU: return ImGuiKey_RightAlt;
486 case VK_RWIN: return ImGuiKey_RightSuper;
487 case VK_APPS: return ImGuiKey_Menu;
488 case '0': return ImGuiKey_0;
489 case '1': return ImGuiKey_1;
490 case '2': return ImGuiKey_2;
491 case '3': return ImGuiKey_3;
492 case '4': return ImGuiKey_4;
493 case '5': return ImGuiKey_5;
494 case '6': return ImGuiKey_6;
495 case '7': return ImGuiKey_7;
496 case '8': return ImGuiKey_8;
497 case '9': return ImGuiKey_9;
498 case 'A': return ImGuiKey_A;
499 case 'B': return ImGuiKey_B;
500 case 'C': return ImGuiKey_C;
501 case 'D': return ImGuiKey_D;
502 case 'E': return ImGuiKey_E;
503 case 'F': return ImGuiKey_F;
504 case 'G': return ImGuiKey_G;
505 case 'H': return ImGuiKey_H;
506 case 'I': return ImGuiKey_I;
507 case 'J': return ImGuiKey_J;
508 case 'K': return ImGuiKey_K;
509 case 'L': return ImGuiKey_L;
510 case 'M': return ImGuiKey_M;
511 case 'N': return ImGuiKey_N;
512 case 'O': return ImGuiKey_O;
513 case 'P': return ImGuiKey_P;
514 case 'Q': return ImGuiKey_Q;
515 case 'R': return ImGuiKey_R;
516 case 'S': return ImGuiKey_S;
517 case 'T': return ImGuiKey_T;
518 case 'U': return ImGuiKey_U;
519 case 'V': return ImGuiKey_V;
520 case 'W': return ImGuiKey_W;
521 case 'X': return ImGuiKey_X;
522 case 'Y': return ImGuiKey_Y;
523 case 'Z': return ImGuiKey_Z;
524 case VK_F1: return ImGuiKey_F1;
525 case VK_F2: return ImGuiKey_F2;
526 case VK_F3: return ImGuiKey_F3;
527 case VK_F4: return ImGuiKey_F4;
528 case VK_F5: return ImGuiKey_F5;
529 case VK_F6: return ImGuiKey_F6;
530 case VK_F7: return ImGuiKey_F7;
531 case VK_F8: return ImGuiKey_F8;
532 case VK_F9: return ImGuiKey_F9;
533 case VK_F10: return ImGuiKey_F10;
534 case VK_F11: return ImGuiKey_F11;
535 case VK_F12: return ImGuiKey_F12;
536 case VK_F13: return ImGuiKey_F13;
537 case VK_F14: return ImGuiKey_F14;
538 case VK_F15: return ImGuiKey_F15;
539 case VK_F16: return ImGuiKey_F16;
540 case VK_F17: return ImGuiKey_F17;
541 case VK_F18: return ImGuiKey_F18;
542 case VK_F19: return ImGuiKey_F19;
543 case VK_F20: return ImGuiKey_F20;
544 case VK_F21: return ImGuiKey_F21;
545 case VK_F22: return ImGuiKey_F22;
546 case VK_F23: return ImGuiKey_F23;
547 case VK_F24: return ImGuiKey_F24;
548 case VK_BROWSER_BACK: return ImGuiKey_AppBack;
549 case VK_BROWSER_FORWARD: return ImGuiKey_AppForward;
550 default: return ImGuiKey_None;
551 }
552 }
553
554 // Allow compilation with old Windows SDK. MinGW doesn't have default _WIN32_WINNT/WINVER versions.
555 #ifndef WM_MOUSEHWHEEL
556 #define WM_MOUSEHWHEEL 0x020E
557 #endif
558 #ifndef DBT_DEVNODES_CHANGED
559 #define DBT_DEVNODES_CHANGED 0x0007
560 #endif
561
562 // Helper to obtain the source of mouse messages.
563 // See https://learn.microsoft.com/en-us/windows/win32/tablet/system-events-and-mouse-messages
564 // Prefer to call this at the top of the message handler to avoid the possibility of other Win32 calls interfering with this.
565 static ImGuiMouseSource ImGui_ImplWin32_GetMouseSourceFromMessageExtraInfo()
566 {
567 LPARAM extra_info = ::GetMessageExtraInfo();
568 if ((extra_info & 0xFFFFFF80) == 0xFF515700)
569 return ImGuiMouseSource_Pen;
570 if ((extra_info & 0xFFFFFF80) == 0xFF515780)
571 return ImGuiMouseSource_TouchScreen;
572 return ImGuiMouseSource_Mouse;
573 }
574
575 // Win32 message handler (process Win32 mouse/keyboard inputs, etc.)
576 // Call from your application's message handler. Keep calling your message handler unless this function returns TRUE.
577 // When implementing your own backend, you can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if Dear ImGui wants to use your inputs.
578 // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application, or clear/overwrite your copy of the mouse data.
579 // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application, or clear/overwrite your copy of the keyboard data.
580 // Generally you may always pass all inputs to Dear ImGui, and hide them from your application based on those two flags.
581 // PS: 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
583 // Copy either 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); // Use ImGui::GetCurrentContext()
585 extern IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandlerEx(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam, ImGuiIO& io); // Doesn't use ImGui::GetCurrentContext()
586
587 IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
588 {
589 // Most backends don't have silent checks like this one, but we need it because WndProc are called early in CreateWindow().
590 // We silently allow both context or just only backend data to be nullptr.
591 if (ImGui::GetCurrentContext() == nullptr)
592 return 0;
593 return ImGui_ImplWin32_WndProcHandlerEx(hwnd, msg, wParam, lParam, ImGui::GetIO());
594 }
595
596 // This version is in theory thread-safe in the sense that no path should access ImGui::GetCurrentContext().
597 IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandlerEx(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam, ImGuiIO& io)
598 {
599 ImGui_ImplWin32_Data* bd = ImGui_ImplWin32_GetBackendData(io);
600 if (bd == nullptr)
601 return 0;
602 switch (msg)
603 {
604 case WM_MOUSEMOVE:
605 case WM_NCMOUSEMOVE:
606 {
607 // We need to call TrackMouseEvent in order to receive WM_MOUSELEAVE events
608 ImGuiMouseSource mouse_source = ImGui_ImplWin32_GetMouseSourceFromMessageExtraInfo();
609 const int area = (msg == WM_MOUSEMOVE) ? 1 : 2;
610 bd->MouseHwnd = hwnd;
611 if (bd->MouseTrackedArea != area)
612 {
613 TRACKMOUSEEVENT tme_cancel = { sizeof(tme_cancel), TME_CANCEL, hwnd, 0 };
614 TRACKMOUSEEVENT tme_track = { sizeof(tme_track), (DWORD)((area == 2) ? (TME_LEAVE | TME_NONCLIENT) : TME_LEAVE), hwnd, 0 };
615 if (bd->MouseTrackedArea != 0)
616 ::TrackMouseEvent(&tme_cancel);
617 ::TrackMouseEvent(&tme_track);
618 bd->MouseTrackedArea = area;
619 }
620 POINT mouse_pos = { (LONG)GET_X_LPARAM(lParam), (LONG)GET_Y_LPARAM(lParam) };
621 if (msg == WM_NCMOUSEMOVE && ::ScreenToClient(hwnd, &mouse_pos) == FALSE) // WM_NCMOUSEMOVE are provided in absolute coordinates.
622 return 0;
623 io.AddMouseSourceEvent(mouse_source);
624 io.AddMousePosEvent((float)mouse_pos.x, (float)mouse_pos.y);
625 return 0;
626 }
627 case WM_MOUSELEAVE:
628 case WM_NCMOUSELEAVE:
629 {
630 const int area = (msg == WM_MOUSELEAVE) ? 1 : 2;
631 if (bd->MouseTrackedArea == area)
632 {
633 if (bd->MouseHwnd == hwnd)
634 bd->MouseHwnd = nullptr;
635 bd->MouseTrackedArea = 0;
636 io.AddMousePosEvent(-FLT_MAX, -FLT_MAX);
637 }
638 return 0;
639 }
640 case WM_DESTROY:
641 if (bd->MouseHwnd == hwnd && bd->MouseTrackedArea != 0)
642 {
643 TRACKMOUSEEVENT tme_cancel = { sizeof(tme_cancel), TME_CANCEL, hwnd, 0 };
644 ::TrackMouseEvent(&tme_cancel);
645 bd->MouseHwnd = nullptr;
646 bd->MouseTrackedArea = 0;
647 io.AddMousePosEvent(-FLT_MAX, -FLT_MAX);
648 }
649 return 0;
650 case WM_LBUTTONDOWN: case WM_LBUTTONDBLCLK:
651 case WM_RBUTTONDOWN: case WM_RBUTTONDBLCLK:
652 case WM_MBUTTONDOWN: case WM_MBUTTONDBLCLK:
653 case WM_XBUTTONDOWN: case WM_XBUTTONDBLCLK:
654 {
655 ImGuiMouseSource mouse_source = ImGui_ImplWin32_GetMouseSourceFromMessageExtraInfo();
656 int button = 0;
657 if (msg == WM_LBUTTONDOWN || msg == WM_LBUTTONDBLCLK) { button = 0; }
658 if (msg == WM_RBUTTONDOWN || msg == WM_RBUTTONDBLCLK) { button = 1; }
659 if (msg == WM_MBUTTONDOWN || msg == WM_MBUTTONDBLCLK) { button = 2; }
660 if (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONDBLCLK) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; }
661 if (bd->MouseButtonsDown == 0 && ::GetCapture() == nullptr)
662 ::SetCapture(hwnd); // Allow us to read mouse coordinates when dragging mouse outside of our window bounds.
663 bd->MouseButtonsDown |= 1 << button;
664 io.AddMouseSourceEvent(mouse_source);
665 io.AddMouseButtonEvent(button, true);
666 return 0;
667 }
668 case WM_LBUTTONUP:
669 case WM_RBUTTONUP:
670 case WM_MBUTTONUP:
671 case WM_XBUTTONUP:
672 {
673 ImGuiMouseSource mouse_source = ImGui_ImplWin32_GetMouseSourceFromMessageExtraInfo();
674 int button = 0;
675 if (msg == WM_LBUTTONUP) { button = 0; }
676 if (msg == WM_RBUTTONUP) { button = 1; }
677 if (msg == WM_MBUTTONUP) { button = 2; }
678 if (msg == WM_XBUTTONUP) { button = (GET_XBUTTON_WPARAM(wParam) == XBUTTON1) ? 3 : 4; }
679 bd->MouseButtonsDown &= ~(1 << button);
680 if (bd->MouseButtonsDown == 0 && ::GetCapture() == hwnd)
681 ::ReleaseCapture();
682 io.AddMouseSourceEvent(mouse_source);
683 io.AddMouseButtonEvent(button, false);
684 return 0;
685 }
686 case WM_MOUSEWHEEL:
687 io.AddMouseWheelEvent(0.0f, (float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA);
688 return 0;
689 case WM_MOUSEHWHEEL:
690 io.AddMouseWheelEvent(-(float)GET_WHEEL_DELTA_WPARAM(wParam) / (float)WHEEL_DELTA, 0.0f);
691 return 0;
692 case WM_KEYDOWN:
693 case WM_KEYUP:
694 case WM_SYSKEYDOWN:
695 case WM_SYSKEYUP:
696 {
697 const bool is_key_down = (msg == WM_KEYDOWN || msg == WM_SYSKEYDOWN);
698 if (wParam < 256)
699 {
700 // Submit modifiers
701 ImGui_ImplWin32_UpdateKeyModifiers(io);
702
703 // Obtain virtual key code and convert to ImGuiKey
704 const ImGuiKey key = ImGui_ImplWin32_KeyEventToImGuiKey(wParam, lParam);
705 const int vk = (int)wParam;
706 const int scancode = (int)LOBYTE(HIWORD(lParam));
707
708 // Special behavior for VK_SNAPSHOT / ImGuiKey_PrintScreen as Windows doesn't emit the key down event.
709 if (key == ImGuiKey_PrintScreen && !is_key_down)
710 ImGui_ImplWin32_AddKeyEvent(io, key, true, vk, scancode);
711
712 // Submit key event
713 if (key != ImGuiKey_None)
714 ImGui_ImplWin32_AddKeyEvent(io, key, is_key_down, vk, scancode);
715
716 // Submit individual left/right modifier events
717 if (vk == VK_SHIFT)
718 {
719 // Important: Shift keys tend to get stuck when pressed together, missing key-up events are corrected in ImGui_ImplWin32_ProcessKeyEventsWorkarounds()
720 if (IsVkDown(VK_LSHIFT) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftShift, is_key_down, VK_LSHIFT, scancode); }
721 if (IsVkDown(VK_RSHIFT) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightShift, is_key_down, VK_RSHIFT, scancode); }
722 }
723 else if (vk == VK_CONTROL)
724 {
725 if (IsVkDown(VK_LCONTROL) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftCtrl, is_key_down, VK_LCONTROL, scancode); }
726 if (IsVkDown(VK_RCONTROL) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightCtrl, is_key_down, VK_RCONTROL, scancode); }
727 }
728 else if (vk == VK_MENU)
729 {
730 if (IsVkDown(VK_LMENU) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_LeftAlt, is_key_down, VK_LMENU, scancode); }
731 if (IsVkDown(VK_RMENU) == is_key_down) { ImGui_ImplWin32_AddKeyEvent(io, ImGuiKey_RightAlt, is_key_down, VK_RMENU, scancode); }
732 }
733 }
734 return 0;
735 }
736 case WM_SETFOCUS:
737 case WM_KILLFOCUS:
738 io.AddFocusEvent(msg == WM_SETFOCUS);
739 return 0;
740 case WM_INPUTLANGCHANGE:
741 ImGui_ImplWin32_UpdateKeyboardCodePage(io);
742 return 0;
743 case WM_CHAR:
744 if (::IsWindowUnicode(hwnd))
745 {
746 // You can also use ToAscii()+GetKeyboardState() to retrieve characters.
747 if (wParam > 0 && wParam < 0x10000)
748 io.AddInputCharacterUTF16((unsigned short)wParam);
749 }
750 else
751 {
752 wchar_t wch = 0;
753 ::MultiByteToWideChar(bd->KeyboardCodePage, MB_PRECOMPOSED, (char*)&wParam, 1, &wch, 1);
754 io.AddInputCharacter(wch);
755 }
756 return 0;
757 case WM_SETCURSOR:
758 // This is required to restore cursor when transitioning from e.g resize borders to client area.
759 if (LOWORD(lParam) == HTCLIENT && ImGui_ImplWin32_UpdateMouseCursor(io, bd->LastMouseCursor))
760 return 1;
761 return 0;
762 case WM_DEVICECHANGE:
763 #ifndef IMGUI_IMPL_WIN32_DISABLE_GAMEPAD
764 if ((UINT)wParam == DBT_DEVNODES_CHANGED)
765 bd->WantUpdateHasGamepad = true;
766 #endif
767 return 0;
768 }
769 return 0;
770 }
771
772
773 //--------------------------------------------------------------------------------------------------------
774 // DPI-related helpers (optional)
775 //--------------------------------------------------------------------------------------------------------
776 // - Use to enable DPI awareness without having to create an application manifest.
777 // - Your own app may already do this via a manifest or explicit calls. This is mostly useful for our examples/ apps.
778 // - In theory we could call simple functions from Windows SDK such as SetProcessDPIAware(), SetProcessDpiAwareness(), etc.
779 // but most of the functions provided by Microsoft require Windows 8.1/10+ SDK at compile time and Windows 8/10+ at runtime,
780 // neither we want to require the user to have. So we dynamically select and load those functions to avoid dependencies.
781 //---------------------------------------------------------------------------------------------------------
782 // This is the scheme successfully used by GLFW (from which we borrowed some of the code) and other apps aiming to be highly portable.
783 // ImGui_ImplWin32_EnableDpiAwareness() is just a helper called by main.cpp, we don't call it automatically.
784 // If you are trying to implement your own backend for your own engine, you may ignore that noise.
785 //---------------------------------------------------------------------------------------------------------
786
787 // Perform our own check with RtlVerifyVersionInfo() instead of using functions from <VersionHelpers.h> as they
788 // require a manifest to be functional for checks above 8.1. See https://github.com/ocornut/imgui/issues/4200
789 static BOOL _IsWindowsVersionOrGreater(WORD major, WORD minor, WORD)
790 {
791 typedef LONG(WINAPI* PFN_RtlVerifyVersionInfo)(OSVERSIONINFOEXW*, ULONG, ULONGLONG);
792 static PFN_RtlVerifyVersionInfo RtlVerifyVersionInfoFn = nullptr;
793 if (RtlVerifyVersionInfoFn == nullptr)
794 if (HMODULE ntdllModule = ::GetModuleHandleA("ntdll.dll"))
795 RtlVerifyVersionInfoFn = (PFN_RtlVerifyVersionInfo)GetProcAddress(ntdllModule, "RtlVerifyVersionInfo");
796 if (RtlVerifyVersionInfoFn == nullptr)
797 return FALSE;
798
799 RTL_OSVERSIONINFOEXW versionInfo = { };
800 ULONGLONG conditionMask = 0;
801 versionInfo.dwOSVersionInfoSize = sizeof(RTL_OSVERSIONINFOEXW);
802 versionInfo.dwMajorVersion = major;
803 versionInfo.dwMinorVersion = minor;
804 VER_SET_CONDITION(conditionMask, VER_MAJORVERSION, VER_GREATER_EQUAL);
805 VER_SET_CONDITION(conditionMask, VER_MINORVERSION, VER_GREATER_EQUAL);
806 return (RtlVerifyVersionInfoFn(&versionInfo, VER_MAJORVERSION | VER_MINORVERSION, conditionMask) == 0) ? TRUE : FALSE;
807 }
808
809 #define _IsWindowsVistaOrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0600), LOBYTE(0x0600), 0) // _WIN32_WINNT_VISTA
810 #define _IsWindows8OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0602), LOBYTE(0x0602), 0) // _WIN32_WINNT_WIN8
811 #define _IsWindows8Point1OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0603), LOBYTE(0x0603), 0) // _WIN32_WINNT_WINBLUE
812 #define _IsWindows10OrGreater() _IsWindowsVersionOrGreater(HIBYTE(0x0A00), LOBYTE(0x0A00), 0) // _WIN32_WINNT_WINTHRESHOLD / _WIN32_WINNT_WIN10
813
814 #ifndef DPI_ENUMS_DECLARED
815 typedef enum { PROCESS_DPI_UNAWARE = 0, PROCESS_SYSTEM_DPI_AWARE = 1, PROCESS_PER_MONITOR_DPI_AWARE = 2 } PROCESS_DPI_AWARENESS;
816 typedef enum { MDT_EFFECTIVE_DPI = 0, MDT_ANGULAR_DPI = 1, MDT_RAW_DPI = 2, MDT_DEFAULT = MDT_EFFECTIVE_DPI } MONITOR_DPI_TYPE;
817 #endif
818 #ifndef _DPI_AWARENESS_CONTEXTS_
819 DECLARE_HANDLE(DPI_AWARENESS_CONTEXT);
820 #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE (DPI_AWARENESS_CONTEXT)-3
821 #endif
822 #ifndef DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2
823 #define DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2 (DPI_AWARENESS_CONTEXT)-4
824 #endif
825 typedef HRESULT(WINAPI* PFN_SetProcessDpiAwareness)(PROCESS_DPI_AWARENESS); // Shcore.lib + dll, Windows 8.1+
826 typedef HRESULT(WINAPI* PFN_GetDpiForMonitor)(HMONITOR, MONITOR_DPI_TYPE, UINT*, UINT*); // Shcore.lib + dll, Windows 8.1+
827 typedef DPI_AWARENESS_CONTEXT(WINAPI* PFN_SetThreadDpiAwarenessContext)(DPI_AWARENESS_CONTEXT); // User32.lib + dll, Windows 10 v1607+ (Creators Update)
828
829 // Helper function to enable DPI awareness without setting up a manifest
830 void ImGui_ImplWin32_EnableDpiAwareness()
831 {
832 if (_IsWindows10OrGreater())
833 {
834 static HINSTANCE user32_dll = ::LoadLibraryA("user32.dll"); // Reference counted per-process
835 if (PFN_SetThreadDpiAwarenessContext SetThreadDpiAwarenessContextFn = (PFN_SetThreadDpiAwarenessContext)::GetProcAddress(user32_dll, "SetThreadDpiAwarenessContext"))
836 {
837 SetThreadDpiAwarenessContextFn(DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2);
838 return;
839 }
840 }
841 if (_IsWindows8Point1OrGreater())
842 {
843 static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
844 if (PFN_SetProcessDpiAwareness SetProcessDpiAwarenessFn = (PFN_SetProcessDpiAwareness)::GetProcAddress(shcore_dll, "SetProcessDpiAwareness"))
845 {
846 SetProcessDpiAwarenessFn(PROCESS_PER_MONITOR_DPI_AWARE);
847 return;
848 }
849 }
850 #if _WIN32_WINNT >= 0x0600
851 ::SetProcessDPIAware();
852 #endif
853 }
854
855 #if defined(_MSC_VER) && !defined(NOGDI)
856 #pragma comment(lib, "gdi32") // Link with gdi32.lib for GetDeviceCaps(). MinGW will require linking with '-lgdi32'
857 #endif
858
859 float ImGui_ImplWin32_GetDpiScaleForMonitor(void* monitor)
860 {
861 UINT xdpi = 96, ydpi = 96;
862 if (_IsWindows8Point1OrGreater())
863 {
864 static HINSTANCE shcore_dll = ::LoadLibraryA("shcore.dll"); // Reference counted per-process
865 static PFN_GetDpiForMonitor GetDpiForMonitorFn = nullptr;
866 if (GetDpiForMonitorFn == nullptr && shcore_dll != nullptr)
867 GetDpiForMonitorFn = (PFN_GetDpiForMonitor)::GetProcAddress(shcore_dll, "GetDpiForMonitor");
868 if (GetDpiForMonitorFn != nullptr)
869 {
870 GetDpiForMonitorFn((HMONITOR)monitor, MDT_EFFECTIVE_DPI, &xdpi, &ydpi);
871 IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert!
872 return xdpi / 96.0f;
873 }
874 }
875 #ifndef NOGDI
876 const HDC dc = ::GetDC(nullptr);
877 xdpi = ::GetDeviceCaps(dc, LOGPIXELSX);
878 ydpi = ::GetDeviceCaps(dc, LOGPIXELSY);
879 IM_ASSERT(xdpi == ydpi); // Please contact me if you hit this assert!
880 ::ReleaseDC(nullptr, dc);
881 #endif
882 return xdpi / 96.0f;
883 }
884
885 float ImGui_ImplWin32_GetDpiScaleForHwnd(void* hwnd)
886 {
887 HMONITOR monitor = ::MonitorFromWindow((HWND)hwnd, MONITOR_DEFAULTTONEAREST);
888 return ImGui_ImplWin32_GetDpiScaleForMonitor(monitor);
889 }
890
891 //---------------------------------------------------------------------------------------------------------
892 // Transparency related helpers (optional)
893 //--------------------------------------------------------------------------------------------------------
894
895 #if defined(_MSC_VER)
896 #pragma comment(lib, "dwmapi") // Link with dwmapi.lib. MinGW will require linking with '-ldwmapi'
897 #endif
898
899 // [experimental]
900 // Borrowed from GLFW's function updateFramebufferTransparency() in src/win32_window.c
901 // (the Dwm* functions are Vista era functions but we are borrowing logic from GLFW)
902 void ImGui_ImplWin32_EnableAlphaCompositing(void* hwnd)
903 {
904 if (!_IsWindowsVistaOrGreater())
905 return;
906
907 BOOL composition;
908 if (FAILED(::DwmIsCompositionEnabled(&composition)) || !composition)
909 return;
910
911 BOOL opaque;
912 DWORD color;
913 if (_IsWindows8OrGreater() || (SUCCEEDED(::DwmGetColorizationColor(&color, &opaque)) && !opaque))
914 {
915 HRGN region = ::CreateRectRgn(0, 0, -1, -1);
916 DWM_BLURBEHIND bb = {};
917 bb.dwFlags = DWM_BB_ENABLE | DWM_BB_BLURREGION;
918 bb.hRgnBlur = region;
919 bb.fEnable = TRUE;
920 ::DwmEnableBlurBehindWindow((HWND)hwnd, &bb);
921 ::DeleteObject(region);
922 }
923 else
924 {
925 DWM_BLURBEHIND bb = {};
926 bb.dwFlags = DWM_BB_ENABLE;
927 ::DwmEnableBlurBehindWindow((HWND)hwnd, &bb);
928 }
929 }
930
931 //---------------------------------------------------------------------------------------------------------
932
933 #if defined(__GNUC__)
934 #pragma GCC diagnostic pop
935 #endif
936 #if defined(__clang__)
937 #pragma clang diagnostic pop
938 #endif
939
940 #endif // #ifndef IMGUI_DISABLE