imgui_impl_glfw.cpp 86 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627
  1. // dear imgui: Platform Backend for GLFW
  2. // This needs to be used along with a Renderer (e.g. OpenGL3, Vulkan, WebGPU..)
  3. // (Info: GLFW is a cross-platform general purpose library for handling windows, inputs, OpenGL/Vulkan graphics context creation, etc.)
  4. // (Requires: GLFW 3.1+. Prefer GLFW 3.3+ or GLFW 3.4+ for full feature support.)
  5. // Implemented features:
  6. // [X] Platform: Clipboard support.
  7. // [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen/Pen (Windows only).
  8. // [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 GLFW_KEY_* values are obsolete since 1.87 and not supported since 1.91.5]
  9. // [X] Platform: Gamepad support. Enable with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
  10. // [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Resizing cursors requires GLFW 3.4+! Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  11. // [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  12. // [X] Multiple Dear ImGui contexts support.
  13. // Missing features or Issues:
  14. // [ ] Platform: Touch events are only correctly identified as Touch on Windows. This create issues with some interactions. GLFW doesn't provide a way to identify touch inputs from mouse inputs, we cannot call io.AddMouseSourceEvent() to identify the source. We provide a Windows-specific workaround.
  15. // [ ] Platform: Missing ImGuiMouseCursor_Wait and ImGuiMouseCursor_Progress cursors.
  16. // [ ] Platform: Multi-viewport: Missing ImGuiBackendFlags_HasParentViewport support. The viewport->ParentViewportID field is ignored, and therefore io.ConfigViewportsNoDefaultParent has no effect either.
  17. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  18. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  19. // Learn about Dear ImGui:
  20. // - FAQ https://dearimgui.com/faq
  21. // - Getting Started https://dearimgui.com/getting-started
  22. // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
  23. // - Introduction, links and more at the top of imgui.cpp
  24. // About Emscripten support:
  25. // - Emscripten provides its own GLFW (3.2.1) implementation (syntax: "-sUSE_GLFW=3"), but Joystick is broken and several features are not supported (multiple windows, clipboard, timer, etc.)
  26. // - A third-party Emscripten GLFW (3.4.0) implementation (syntax: "--use-port=contrib.glfw3") fixes the Joystick issue and implements all relevant features for the browser.
  27. // See https://github.com/pongasoft/emscripten-glfw/blob/master/docs/Comparison.md for details.
  28. // CHANGELOG
  29. // (minor and older changes stripped away, please see git history for details)
  30. // 2025-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  31. // 2025-09-18: Call platform_io.ClearPlatformHandlers() on shutdown.
  32. // 2025-09-15: Content Scales are always reported as 1.0 on Wayland. FramebufferScale are always reported as 1.0 on X11. (#8920, #8921)
  33. // 2025-09-10: [Docking] Improve multi-viewport behavior in tiling WMs on X11 via the ImGui_ImplGlfw_SetWindowFloating() function. Note: using GLFW backend on Linux/BSD etc. requires linking with -lX11. (#8884, #8474, #8289)
  34. // 2025-07-08: Made ImGui_ImplGlfw_GetContentScaleForWindow(), ImGui_ImplGlfw_GetContentScaleForMonitor() helpers return 1.0f on Emscripten and Android platforms, matching macOS logic. (#8742, #8733)
  35. // 2025-06-18: Added support for multiple Dear ImGui contexts. (#8676, #8239, #8069)
  36. // 2025-06-11: Added ImGui_ImplGlfw_GetContentScaleForWindow(GLFWwindow* window) and ImGui_ImplGlfw_GetContentScaleForMonitor(GLFWmonitor* monitor) helper to facilitate making DPI-aware apps.
  37. // 2025-05-15: [Docking] Add Platform_GetWindowFramebufferScale() handler, to allow varying Retina display density on multiple monitors.
  38. // 2025-04-26: [Docking] Disable multi-viewports under Wayland. (#8587)
  39. // 2025-03-10: Map GLFW_KEY_WORLD_1 and GLFW_KEY_WORLD_2 into ImGuiKey_Oem102.
  40. // 2025-03-03: Fixed clipboard handler assertion when using GLFW <= 3.2.1 compiled with asserts enabled.
  41. // 2025-02-21: [Docking] Update monitors and work areas information every frame, as the later may change regardless of monitor changes. (#8415)
  42. // 2024-11-05: [Docking] Added Linux workaround for spurious mouse up events emitted while dragging and creating new viewport. (#3158, #7733, #7922)
  43. // 2024-08-22: Moved some OS/backend related function pointers from ImGuiIO to ImGuiPlatformIO:
  44. // - io.GetClipboardTextFn -> platform_io.Platform_GetClipboardTextFn
  45. // - io.SetClipboardTextFn -> platform_io.Platform_SetClipboardTextFn
  46. // - io.PlatformOpenInShellFn -> platform_io.Platform_OpenInShellFn
  47. // 2024-07-31: Added ImGui_ImplGlfw_Sleep() helper function for usage by our examples app, since GLFW doesn't provide one.
  48. // 2024-07-08: *BREAKING* Renamed ImGui_ImplGlfw_InstallEmscriptenCanvasResizeCallback to ImGui_ImplGlfw_InstallEmscriptenCallbacks(), added GLFWWindow* parameter.
  49. // 2024-07-08: Emscripten: Added support for GLFW3 contrib port (GLFW 3.4.0 features + bug fixes): to enable, replace -sUSE_GLFW=3 with --use-port=contrib.glfw3 (requires emscripten 3.1.59+) (https://github.com/pongasoft/emscripten-glfw)
  50. // 2024-07-02: Emscripten: Added io.PlatformOpenInShellFn() handler for Emscripten versions.
  51. // 2023-12-19: Emscripten: Added ImGui_ImplGlfw_InstallEmscriptenCanvasResizeCallback() to register canvas selector and auto-resize GLFW window.
  52. // 2023-10-05: Inputs: Added support for extra ImGuiKey values: F13 to F24 function keys.
  53. // 2023-07-18: Inputs: Revert ignoring mouse data on GLFW_CURSOR_DISABLED as it can be used differently. User may set ImGuiConfigFLags_NoMouse if desired. (#5625, #6609)
  54. // 2023-06-12: Accept glfwGetTime() not returning a monotonically increasing value. This seems to happens on some Windows setup when peripherals disconnect, and is likely to also happen on browser + Emscripten. (#6491)
  55. // 2023-04-04: Inputs: Added support for io.AddMouseSourceEvent() to discriminate ImGuiMouseSource_Mouse/ImGuiMouseSource_TouchScreen/ImGuiMouseSource_Pen on Windows ONLY, using a custom WndProc hook. (#2702)
  56. // 2023-03-16: Inputs: Fixed key modifiers handling on secondary viewports (docking branch). Broken on 2023/01/04. (#6248, #6034)
  57. // 2023-03-14: Emscripten: Avoid using glfwGetError() and glfwGetGamepadState() which are not correctly implemented in Emscripten emulation. (#6240)
  58. // 2023-02-03: Emscripten: Registering custom low-level mouse wheel handler to get more accurate scrolling impulses on Emscripten. (#4019, #6096)
  59. // 2023-01-18: Handle unsupported glfwGetVideoMode() call on e.g. Emscripten.
  60. // 2023-01-04: Inputs: Fixed mods state on Linux when using Alt-GR text input (e.g. German keyboard layout), could lead to broken text input. Revert a 2022/01/17 change were we resumed using mods provided by GLFW, turns out they were faulty.
  61. // 2022-11-22: Perform a dummy glfwGetError() read to cancel missing names with glfwGetKeyName(). (#5908)
  62. // 2022-10-18: Perform a dummy glfwGetError() read to cancel missing mouse cursors errors. Using GLFW_VERSION_COMBINED directly. (#5785)
  63. // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
  64. // 2022-09-26: Inputs: Renamed ImGuiKey_ModXXX introduced in 1.87 to ImGuiMod_XXX (old names still supported).
  65. // 2022-09-01: Inputs: Honor GLFW_CURSOR_DISABLED by not setting mouse position *EDIT* Reverted 2023-07-18.
  66. // 2022-04-30: Inputs: Fixed ImGui_ImplGlfw_TranslateUntranslatedKey() for lower case letters on OSX.
  67. // 2022-03-23: Inputs: Fixed a regression in 1.87 which resulted in keyboard modifiers events being reported incorrectly on Linux/X11.
  68. // 2022-02-07: Added ImGui_ImplGlfw_InstallCallbacks()/ImGui_ImplGlfw_RestoreCallbacks() helpers to facilitate user installing callbacks after initializing backend.
  69. // 2022-01-26: Inputs: replaced short-lived io.AddKeyModsEvent() (added two weeks ago) with io.AddKeyEvent() using ImGuiKey_ModXXX flags. Sorry for the confusion.
  70. // 2021-01-20: Inputs: calling new io.AddKeyAnalogEvent() for gamepad support, instead of writing directly to io.NavInputs[].
  71. // 2022-01-17: Inputs: calling new io.AddMousePosEvent(), io.AddMouseButtonEvent(), io.AddMouseWheelEvent() API (1.87+).
  72. // 2022-01-17: Inputs: always update key mods next and before key event (not in NewFrame) to fix input queue with very low framerates.
  73. // 2022-01-12: *BREAKING CHANGE*: Now using glfwSetCursorPosCallback(). If you called ImGui_ImplGlfw_InitXXX() with install_callbacks = false, you MUST install glfwSetCursorPosCallback() and forward it to the backend via ImGui_ImplGlfw_CursorPosCallback().
  74. // 2022-01-10: Inputs: calling new io.AddKeyEvent(), io.AddKeyModsEvent() + io.SetKeyEventNativeData() API (1.87+). Support for full ImGuiKey range.
  75. // 2022-01-05: Inputs: Converting GLFW untranslated keycodes back to translated keycodes (in the ImGui_ImplGlfw_KeyCallback() function) in order to match the behavior of every other backend, and facilitate the use of GLFW with lettered-shortcuts API.
  76. // 2021-08-17: *BREAKING CHANGE*: Now using glfwSetWindowFocusCallback() to calling io.AddFocusEvent(). If you called ImGui_ImplGlfw_InitXXX() with install_callbacks = false, you MUST install glfwSetWindowFocusCallback() and forward it to the backend via ImGui_ImplGlfw_WindowFocusCallback().
  77. // 2021-07-29: *BREAKING CHANGE*: Now using glfwSetCursorEnterCallback(). MousePos is correctly reported when the host platform window is hovered but not focused. If you called ImGui_ImplGlfw_InitXXX() with install_callbacks = false, you MUST install glfwSetWindowFocusCallback() callback and forward it to the backend via ImGui_ImplGlfw_CursorEnterCallback().
  78. // 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).
  79. // 2020-01-17: Inputs: Disable error callback while assigning mouse cursors because some X11 setup don't have them and it generates errors.
  80. // 2019-12-05: Inputs: Added support for new mouse cursors added in GLFW 3.4+ (resizing cursors, not allowed cursor).
  81. // 2019-10-18: Misc: Previously installed user callbacks are now restored on shutdown.
  82. // 2019-07-21: Inputs: Added mapping for ImGuiKey_KeyPadEnter.
  83. // 2019-05-11: Inputs: Don't filter value from character callback before calling AddInputCharacter().
  84. // 2019-03-12: Misc: Preserve DisplayFramebufferScale when main window is minimized.
  85. // 2018-11-30: Misc: Setting up io.BackendPlatformName so it can be displayed in the About Window.
  86. // 2018-11-07: Inputs: When installing our GLFW callbacks, we save user's previously installed ones - if any - and chain call them.
  87. // 2018-08-01: Inputs: Workaround for Emscripten which doesn't seem to handle focus related calls.
  88. // 2018-06-29: Inputs: Added support for the ImGuiMouseCursor_Hand cursor.
  89. // 2018-06-08: Misc: Extracted imgui_impl_glfw.cpp/.h away from the old combined GLFW+OpenGL/Vulkan examples.
  90. // 2018-03-20: Misc: Setup io.BackendFlags ImGuiBackendFlags_HasMouseCursors flag + honor ImGuiConfigFlags_NoMouseCursorChange flag.
  91. // 2018-02-20: Inputs: Added support for mouse cursors (ImGui::GetMouseCursor() value, passed to glfwSetCursor()).
  92. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  93. // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
  94. // 2018-01-25: Inputs: Added gamepad support if ImGuiConfigFlags_NavEnableGamepad is set.
  95. // 2018-01-25: Inputs: Honoring the io.WantSetMousePos by repositioning the mouse (when using navigation and ImGuiConfigFlags_NavMoveMouse is set).
  96. // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
  97. // 2018-01-18: Inputs: Added mapping for ImGuiKey_Insert.
  98. // 2017-08-25: Inputs: MousePos set to -FLT_MAX,-FLT_MAX when mouse is unavailable/missing (instead of -1,-1).
  99. // 2016-10-15: Misc: Added a void* user_data parameter to Clipboard function handlers.
  100. #include "imgui.h"
  101. #ifndef IMGUI_DISABLE
  102. #include "imgui_impl_glfw.h"
  103. // Clang warnings with -Weverything
  104. #if defined(__clang__)
  105. #pragma clang diagnostic push
  106. #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast
  107. #pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness
  108. #elif defined(__GNUC__)
  109. #pragma GCC diagnostic ignored "-Wfloat-equal" // warning: comparing floating-point with '==' or '!=' is unsafe
  110. #endif
  111. // GLFW
  112. #if defined(__linux__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) || defined(__DragonFly__)
  113. #define GLFW_HAS_X11_OR_WAYLAND 1
  114. #else
  115. #define GLFW_HAS_X11_OR_WAYLAND 0
  116. #endif
  117. #include <GLFW/glfw3.h>
  118. #ifdef _WIN32
  119. #undef APIENTRY
  120. #ifndef GLFW_EXPOSE_NATIVE_WIN32 // for glfwGetWin32Window()
  121. #define GLFW_EXPOSE_NATIVE_WIN32
  122. #endif
  123. #include <GLFW/glfw3native.h>
  124. #elif defined(__APPLE__)
  125. #ifndef GLFW_EXPOSE_NATIVE_COCOA // for glfwGetCocoaWindow()
  126. #define GLFW_EXPOSE_NATIVE_COCOA
  127. #endif
  128. #include <GLFW/glfw3native.h>
  129. #elif GLFW_HAS_X11_OR_WAYLAND
  130. #ifndef GLFW_EXPOSE_NATIVE_X11 // for glfwGetX11Display(), glfwGetX11Window() on Freedesktop (Linux, BSD, etc.)
  131. #define GLFW_EXPOSE_NATIVE_X11
  132. #include <X11/Xatom.h>
  133. #endif
  134. #ifndef GLFW_EXPOSE_NATIVE_WAYLAND
  135. #define GLFW_EXPOSE_NATIVE_WAYLAND
  136. #endif
  137. #include <GLFW/glfw3native.h>
  138. #undef Status // X11 headers are leaking this.
  139. #endif
  140. #ifndef _WIN32
  141. #include <unistd.h> // for usleep()
  142. #endif
  143. #include <stdio.h> // for snprintf()
  144. #ifdef __EMSCRIPTEN__
  145. #include <emscripten.h>
  146. #include <emscripten/html5.h>
  147. #ifdef EMSCRIPTEN_USE_PORT_CONTRIB_GLFW3
  148. #include <GLFW/emscripten_glfw3.h>
  149. #else
  150. #define EMSCRIPTEN_USE_EMBEDDED_GLFW3
  151. #endif
  152. #endif
  153. // We gather version tests as define in order to easily see which features are version-dependent.
  154. #define GLFW_VERSION_COMBINED (GLFW_VERSION_MAJOR * 1000 + GLFW_VERSION_MINOR * 100 + GLFW_VERSION_REVISION)
  155. #define GLFW_HAS_WINDOW_TOPMOST (GLFW_VERSION_COMBINED >= 3200) // 3.2+ GLFW_FLOATING
  156. #define GLFW_HAS_WINDOW_HOVERED (GLFW_VERSION_COMBINED >= 3300) // 3.3+ GLFW_HOVERED
  157. #define GLFW_HAS_WINDOW_ALPHA (GLFW_VERSION_COMBINED >= 3300) // 3.3+ glfwSetWindowOpacity
  158. #define GLFW_HAS_PER_MONITOR_DPI (GLFW_VERSION_COMBINED >= 3300) // 3.3+ glfwGetMonitorContentScale
  159. #if defined(__EMSCRIPTEN__) || defined(__SWITCH__) // no Vulkan support in GLFW for Emscripten or homebrew Nintendo Switch
  160. #define GLFW_HAS_VULKAN (0)
  161. #else
  162. #define GLFW_HAS_VULKAN (GLFW_VERSION_COMBINED >= 3200) // 3.2+ glfwCreateWindowSurface
  163. #endif
  164. #define GLFW_HAS_FOCUS_WINDOW (GLFW_VERSION_COMBINED >= 3200) // 3.2+ glfwFocusWindow
  165. #define GLFW_HAS_FOCUS_ON_SHOW (GLFW_VERSION_COMBINED >= 3300) // 3.3+ GLFW_FOCUS_ON_SHOW
  166. #define GLFW_HAS_MONITOR_WORK_AREA (GLFW_VERSION_COMBINED >= 3300) // 3.3+ glfwGetMonitorWorkarea
  167. #define GLFW_HAS_OSX_WINDOW_POS_FIX (GLFW_VERSION_COMBINED >= 3301) // 3.3.1+ Fixed: Resizing window repositions it on MacOS #1553
  168. #ifdef GLFW_RESIZE_NESW_CURSOR // Let's be nice to people who pulled GLFW between 2019-04-16 (3.4 define) and 2019-11-29 (cursors defines) // FIXME: Remove when GLFW 3.4 is released?
  169. #define GLFW_HAS_NEW_CURSORS (GLFW_VERSION_COMBINED >= 3400) // 3.4+ GLFW_RESIZE_ALL_CURSOR, GLFW_RESIZE_NESW_CURSOR, GLFW_RESIZE_NWSE_CURSOR, GLFW_NOT_ALLOWED_CURSOR
  170. #else
  171. #define GLFW_HAS_NEW_CURSORS (0)
  172. #endif
  173. #ifdef GLFW_MOUSE_PASSTHROUGH // Let's be nice to people who pulled GLFW between 2019-04-16 (3.4 define) and 2020-07-17 (passthrough)
  174. #define GLFW_HAS_MOUSE_PASSTHROUGH (GLFW_VERSION_COMBINED >= 3400) // 3.4+ GLFW_MOUSE_PASSTHROUGH
  175. #else
  176. #define GLFW_HAS_MOUSE_PASSTHROUGH (0)
  177. #endif
  178. #define GLFW_HAS_GAMEPAD_API (GLFW_VERSION_COMBINED >= 3300) // 3.3+ glfwGetGamepadState() new api
  179. #define GLFW_HAS_GETKEYNAME (GLFW_VERSION_COMBINED >= 3200) // 3.2+ glfwGetKeyName()
  180. #define GLFW_HAS_GETERROR (GLFW_VERSION_COMBINED >= 3300) // 3.3+ glfwGetError()
  181. #define GLFW_HAS_GETPLATFORM (GLFW_VERSION_COMBINED >= 3400) // 3.4+ glfwGetPlatform()
  182. // Map GLFWWindow* to ImGuiContext*.
  183. // - Would be simpler if we could use glfwSetWindowUserPointer()/glfwGetWindowUserPointer(), but this is a single and shared resource.
  184. // - Would be simpler if we could use e.g. std::map<> as well. But we don't.
  185. // - This is not particularly optimized as we expect size to be small and queries to be rare.
  186. struct ImGui_ImplGlfw_WindowToContext { GLFWwindow* Window; ImGuiContext* Context; };
  187. static ImVector<ImGui_ImplGlfw_WindowToContext> g_ContextMap;
  188. static void ImGui_ImplGlfw_ContextMap_Add(GLFWwindow* window, ImGuiContext* ctx) { g_ContextMap.push_back(ImGui_ImplGlfw_WindowToContext{ window, ctx }); }
  189. static void ImGui_ImplGlfw_ContextMap_Remove(GLFWwindow* window) { for (ImGui_ImplGlfw_WindowToContext& entry : g_ContextMap) if (entry.Window == window) { g_ContextMap.erase_unsorted(&entry); return; } }
  190. static ImGuiContext* ImGui_ImplGlfw_ContextMap_Get(GLFWwindow* window) { for (ImGui_ImplGlfw_WindowToContext& entry : g_ContextMap) if (entry.Window == window) return entry.Context; return nullptr; }
  191. enum GlfwClientApi
  192. {
  193. GlfwClientApi_OpenGL,
  194. GlfwClientApi_Vulkan,
  195. GlfwClientApi_Unknown, // Anything else fits here.
  196. };
  197. // GLFW data
  198. struct ImGui_ImplGlfw_Data
  199. {
  200. ImGuiContext* Context;
  201. GLFWwindow* Window;
  202. GlfwClientApi ClientApi;
  203. double Time;
  204. GLFWwindow* MouseWindow;
  205. GLFWcursor* MouseCursors[ImGuiMouseCursor_COUNT];
  206. bool MouseIgnoreButtonUpWaitForFocusLoss;
  207. bool MouseIgnoreButtonUp;
  208. ImVec2 LastValidMousePos;
  209. GLFWwindow* KeyOwnerWindows[GLFW_KEY_LAST];
  210. bool IsWayland;
  211. bool InstalledCallbacks;
  212. bool CallbacksChainForAllWindows;
  213. char BackendPlatformName[32];
  214. #ifdef EMSCRIPTEN_USE_EMBEDDED_GLFW3
  215. const char* CanvasSelector;
  216. #endif
  217. // Chain GLFW callbacks: our callbacks will call the user's previously installed callbacks, if any.
  218. GLFWwindowfocusfun PrevUserCallbackWindowFocus;
  219. GLFWcursorposfun PrevUserCallbackCursorPos;
  220. GLFWcursorenterfun PrevUserCallbackCursorEnter;
  221. GLFWmousebuttonfun PrevUserCallbackMousebutton;
  222. GLFWscrollfun PrevUserCallbackScroll;
  223. GLFWkeyfun PrevUserCallbackKey;
  224. GLFWcharfun PrevUserCallbackChar;
  225. GLFWmonitorfun PrevUserCallbackMonitor;
  226. #ifdef _WIN32
  227. WNDPROC PrevWndProc;
  228. #endif
  229. ImGui_ImplGlfw_Data() { memset((void*)this, 0, sizeof(*this)); }
  230. };
  231. // Backend data stored in io.BackendPlatformUserData to allow support for multiple Dear ImGui contexts
  232. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  233. // FIXME: multi-context support is not well tested and probably dysfunctional in this backend.
  234. // - Because glfwPollEvents() process all windows and some events may be called outside of it, you will need to register your own callbacks
  235. // (passing install_callbacks=false in ImGui_ImplGlfw_InitXXX functions), set the current dear imgui context and then call our callbacks.
  236. // - Otherwise we may need to store a GLFWWindow* -> ImGuiContext* map and handle this in the backend, adding a little bit of extra complexity to it.
  237. // FIXME: some shared resources (mouse cursor shape, gamepad) are mishandled when using multi-context.
  238. namespace ImGui { extern ImGuiIO& GetIO(ImGuiContext*); }
  239. static ImGui_ImplGlfw_Data* ImGui_ImplGlfw_GetBackendData()
  240. {
  241. // Get data for current context
  242. return ImGui::GetCurrentContext() ? (ImGui_ImplGlfw_Data*)ImGui::GetIO().BackendPlatformUserData : nullptr;
  243. }
  244. static ImGui_ImplGlfw_Data* ImGui_ImplGlfw_GetBackendData(GLFWwindow* window)
  245. {
  246. // Get data for a given GLFW window, regardless of current context (since GLFW events are sent together)
  247. ImGuiContext* ctx = ImGui_ImplGlfw_ContextMap_Get(window);
  248. return (ImGui_ImplGlfw_Data*)ImGui::GetIO(ctx).BackendPlatformUserData;
  249. }
  250. // Forward Declarations
  251. static void ImGui_ImplGlfw_UpdateMonitors();
  252. static void ImGui_ImplGlfw_InitMultiViewportSupport();
  253. static void ImGui_ImplGlfw_ShutdownMultiViewportSupport();
  254. // Functions
  255. static bool ImGui_ImplGlfw_IsWayland()
  256. {
  257. #if !GLFW_HAS_X11_OR_WAYLAND
  258. return false;
  259. #elif GLFW_HAS_GETPLATFORM
  260. return glfwGetPlatform() == GLFW_PLATFORM_WAYLAND;
  261. #else
  262. const char* version = glfwGetVersionString();
  263. if (strstr(version, "Wayland") == NULL) // e.g. Ubuntu 22.04 ships with GLFW 3.3.6 compiled without Wayland
  264. return false;
  265. #ifdef GLFW_EXPOSE_NATIVE_X11
  266. if (glfwGetX11Display() != NULL)
  267. return false;
  268. #endif
  269. return true;
  270. #endif
  271. }
  272. // Not static to allow third-party code to use that if they want to (but undocumented)
  273. ImGuiKey ImGui_ImplGlfw_KeyToImGuiKey(int keycode, int scancode);
  274. ImGuiKey ImGui_ImplGlfw_KeyToImGuiKey(int keycode, int scancode)
  275. {
  276. IM_UNUSED(scancode);
  277. switch (keycode)
  278. {
  279. case GLFW_KEY_TAB: return ImGuiKey_Tab;
  280. case GLFW_KEY_LEFT: return ImGuiKey_LeftArrow;
  281. case GLFW_KEY_RIGHT: return ImGuiKey_RightArrow;
  282. case GLFW_KEY_UP: return ImGuiKey_UpArrow;
  283. case GLFW_KEY_DOWN: return ImGuiKey_DownArrow;
  284. case GLFW_KEY_PAGE_UP: return ImGuiKey_PageUp;
  285. case GLFW_KEY_PAGE_DOWN: return ImGuiKey_PageDown;
  286. case GLFW_KEY_HOME: return ImGuiKey_Home;
  287. case GLFW_KEY_END: return ImGuiKey_End;
  288. case GLFW_KEY_INSERT: return ImGuiKey_Insert;
  289. case GLFW_KEY_DELETE: return ImGuiKey_Delete;
  290. case GLFW_KEY_BACKSPACE: return ImGuiKey_Backspace;
  291. case GLFW_KEY_SPACE: return ImGuiKey_Space;
  292. case GLFW_KEY_ENTER: return ImGuiKey_Enter;
  293. case GLFW_KEY_ESCAPE: return ImGuiKey_Escape;
  294. case GLFW_KEY_APOSTROPHE: return ImGuiKey_Apostrophe;
  295. case GLFW_KEY_COMMA: return ImGuiKey_Comma;
  296. case GLFW_KEY_MINUS: return ImGuiKey_Minus;
  297. case GLFW_KEY_PERIOD: return ImGuiKey_Period;
  298. case GLFW_KEY_SLASH: return ImGuiKey_Slash;
  299. case GLFW_KEY_SEMICOLON: return ImGuiKey_Semicolon;
  300. case GLFW_KEY_EQUAL: return ImGuiKey_Equal;
  301. case GLFW_KEY_LEFT_BRACKET: return ImGuiKey_LeftBracket;
  302. case GLFW_KEY_BACKSLASH: return ImGuiKey_Backslash;
  303. case GLFW_KEY_WORLD_1: return ImGuiKey_Oem102;
  304. case GLFW_KEY_WORLD_2: return ImGuiKey_Oem102;
  305. case GLFW_KEY_RIGHT_BRACKET: return ImGuiKey_RightBracket;
  306. case GLFW_KEY_GRAVE_ACCENT: return ImGuiKey_GraveAccent;
  307. case GLFW_KEY_CAPS_LOCK: return ImGuiKey_CapsLock;
  308. case GLFW_KEY_SCROLL_LOCK: return ImGuiKey_ScrollLock;
  309. case GLFW_KEY_NUM_LOCK: return ImGuiKey_NumLock;
  310. case GLFW_KEY_PRINT_SCREEN: return ImGuiKey_PrintScreen;
  311. case GLFW_KEY_PAUSE: return ImGuiKey_Pause;
  312. case GLFW_KEY_KP_0: return ImGuiKey_Keypad0;
  313. case GLFW_KEY_KP_1: return ImGuiKey_Keypad1;
  314. case GLFW_KEY_KP_2: return ImGuiKey_Keypad2;
  315. case GLFW_KEY_KP_3: return ImGuiKey_Keypad3;
  316. case GLFW_KEY_KP_4: return ImGuiKey_Keypad4;
  317. case GLFW_KEY_KP_5: return ImGuiKey_Keypad5;
  318. case GLFW_KEY_KP_6: return ImGuiKey_Keypad6;
  319. case GLFW_KEY_KP_7: return ImGuiKey_Keypad7;
  320. case GLFW_KEY_KP_8: return ImGuiKey_Keypad8;
  321. case GLFW_KEY_KP_9: return ImGuiKey_Keypad9;
  322. case GLFW_KEY_KP_DECIMAL: return ImGuiKey_KeypadDecimal;
  323. case GLFW_KEY_KP_DIVIDE: return ImGuiKey_KeypadDivide;
  324. case GLFW_KEY_KP_MULTIPLY: return ImGuiKey_KeypadMultiply;
  325. case GLFW_KEY_KP_SUBTRACT: return ImGuiKey_KeypadSubtract;
  326. case GLFW_KEY_KP_ADD: return ImGuiKey_KeypadAdd;
  327. case GLFW_KEY_KP_ENTER: return ImGuiKey_KeypadEnter;
  328. case GLFW_KEY_KP_EQUAL: return ImGuiKey_KeypadEqual;
  329. case GLFW_KEY_LEFT_SHIFT: return ImGuiKey_LeftShift;
  330. case GLFW_KEY_LEFT_CONTROL: return ImGuiKey_LeftCtrl;
  331. case GLFW_KEY_LEFT_ALT: return ImGuiKey_LeftAlt;
  332. case GLFW_KEY_LEFT_SUPER: return ImGuiKey_LeftSuper;
  333. case GLFW_KEY_RIGHT_SHIFT: return ImGuiKey_RightShift;
  334. case GLFW_KEY_RIGHT_CONTROL: return ImGuiKey_RightCtrl;
  335. case GLFW_KEY_RIGHT_ALT: return ImGuiKey_RightAlt;
  336. case GLFW_KEY_RIGHT_SUPER: return ImGuiKey_RightSuper;
  337. case GLFW_KEY_MENU: return ImGuiKey_Menu;
  338. case GLFW_KEY_0: return ImGuiKey_0;
  339. case GLFW_KEY_1: return ImGuiKey_1;
  340. case GLFW_KEY_2: return ImGuiKey_2;
  341. case GLFW_KEY_3: return ImGuiKey_3;
  342. case GLFW_KEY_4: return ImGuiKey_4;
  343. case GLFW_KEY_5: return ImGuiKey_5;
  344. case GLFW_KEY_6: return ImGuiKey_6;
  345. case GLFW_KEY_7: return ImGuiKey_7;
  346. case GLFW_KEY_8: return ImGuiKey_8;
  347. case GLFW_KEY_9: return ImGuiKey_9;
  348. case GLFW_KEY_A: return ImGuiKey_A;
  349. case GLFW_KEY_B: return ImGuiKey_B;
  350. case GLFW_KEY_C: return ImGuiKey_C;
  351. case GLFW_KEY_D: return ImGuiKey_D;
  352. case GLFW_KEY_E: return ImGuiKey_E;
  353. case GLFW_KEY_F: return ImGuiKey_F;
  354. case GLFW_KEY_G: return ImGuiKey_G;
  355. case GLFW_KEY_H: return ImGuiKey_H;
  356. case GLFW_KEY_I: return ImGuiKey_I;
  357. case GLFW_KEY_J: return ImGuiKey_J;
  358. case GLFW_KEY_K: return ImGuiKey_K;
  359. case GLFW_KEY_L: return ImGuiKey_L;
  360. case GLFW_KEY_M: return ImGuiKey_M;
  361. case GLFW_KEY_N: return ImGuiKey_N;
  362. case GLFW_KEY_O: return ImGuiKey_O;
  363. case GLFW_KEY_P: return ImGuiKey_P;
  364. case GLFW_KEY_Q: return ImGuiKey_Q;
  365. case GLFW_KEY_R: return ImGuiKey_R;
  366. case GLFW_KEY_S: return ImGuiKey_S;
  367. case GLFW_KEY_T: return ImGuiKey_T;
  368. case GLFW_KEY_U: return ImGuiKey_U;
  369. case GLFW_KEY_V: return ImGuiKey_V;
  370. case GLFW_KEY_W: return ImGuiKey_W;
  371. case GLFW_KEY_X: return ImGuiKey_X;
  372. case GLFW_KEY_Y: return ImGuiKey_Y;
  373. case GLFW_KEY_Z: return ImGuiKey_Z;
  374. case GLFW_KEY_F1: return ImGuiKey_F1;
  375. case GLFW_KEY_F2: return ImGuiKey_F2;
  376. case GLFW_KEY_F3: return ImGuiKey_F3;
  377. case GLFW_KEY_F4: return ImGuiKey_F4;
  378. case GLFW_KEY_F5: return ImGuiKey_F5;
  379. case GLFW_KEY_F6: return ImGuiKey_F6;
  380. case GLFW_KEY_F7: return ImGuiKey_F7;
  381. case GLFW_KEY_F8: return ImGuiKey_F8;
  382. case GLFW_KEY_F9: return ImGuiKey_F9;
  383. case GLFW_KEY_F10: return ImGuiKey_F10;
  384. case GLFW_KEY_F11: return ImGuiKey_F11;
  385. case GLFW_KEY_F12: return ImGuiKey_F12;
  386. case GLFW_KEY_F13: return ImGuiKey_F13;
  387. case GLFW_KEY_F14: return ImGuiKey_F14;
  388. case GLFW_KEY_F15: return ImGuiKey_F15;
  389. case GLFW_KEY_F16: return ImGuiKey_F16;
  390. case GLFW_KEY_F17: return ImGuiKey_F17;
  391. case GLFW_KEY_F18: return ImGuiKey_F18;
  392. case GLFW_KEY_F19: return ImGuiKey_F19;
  393. case GLFW_KEY_F20: return ImGuiKey_F20;
  394. case GLFW_KEY_F21: return ImGuiKey_F21;
  395. case GLFW_KEY_F22: return ImGuiKey_F22;
  396. case GLFW_KEY_F23: return ImGuiKey_F23;
  397. case GLFW_KEY_F24: return ImGuiKey_F24;
  398. default: return ImGuiKey_None;
  399. }
  400. }
  401. // X11 does not include current pressed/released modifier key in 'mods' flags submitted by GLFW
  402. // See https://github.com/ocornut/imgui/issues/6034 and https://github.com/glfw/glfw/issues/1630
  403. static void ImGui_ImplGlfw_UpdateKeyModifiers(ImGuiIO& io, GLFWwindow* window)
  404. {
  405. io.AddKeyEvent(ImGuiMod_Ctrl, (glfwGetKey(window, GLFW_KEY_LEFT_CONTROL) == GLFW_PRESS) || (glfwGetKey(window, GLFW_KEY_RIGHT_CONTROL) == GLFW_PRESS));
  406. io.AddKeyEvent(ImGuiMod_Shift, (glfwGetKey(window, GLFW_KEY_LEFT_SHIFT) == GLFW_PRESS) || (glfwGetKey(window, GLFW_KEY_RIGHT_SHIFT) == GLFW_PRESS));
  407. io.AddKeyEvent(ImGuiMod_Alt, (glfwGetKey(window, GLFW_KEY_LEFT_ALT) == GLFW_PRESS) || (glfwGetKey(window, GLFW_KEY_RIGHT_ALT) == GLFW_PRESS));
  408. io.AddKeyEvent(ImGuiMod_Super, (glfwGetKey(window, GLFW_KEY_LEFT_SUPER) == GLFW_PRESS) || (glfwGetKey(window, GLFW_KEY_RIGHT_SUPER) == GLFW_PRESS));
  409. }
  410. static bool ImGui_ImplGlfw_ShouldChainCallback(ImGui_ImplGlfw_Data* bd, GLFWwindow* window)
  411. {
  412. return bd->CallbacksChainForAllWindows ? true : (window == bd->Window);
  413. }
  414. void ImGui_ImplGlfw_MouseButtonCallback(GLFWwindow* window, int button, int action, int mods)
  415. {
  416. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  417. if (bd->PrevUserCallbackMousebutton != nullptr && ImGui_ImplGlfw_ShouldChainCallback(bd, window))
  418. bd->PrevUserCallbackMousebutton(window, button, action, mods);
  419. // Workaround for Linux: ignore mouse up events which are following an focus loss following a viewport creation
  420. if (bd->MouseIgnoreButtonUp && action == GLFW_RELEASE)
  421. return;
  422. ImGuiIO& io = ImGui::GetIO(bd->Context);
  423. ImGui_ImplGlfw_UpdateKeyModifiers(io, window);
  424. if (button >= 0 && button < ImGuiMouseButton_COUNT)
  425. io.AddMouseButtonEvent(button, action == GLFW_PRESS);
  426. }
  427. void ImGui_ImplGlfw_ScrollCallback(GLFWwindow* window, double xoffset, double yoffset)
  428. {
  429. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  430. if (bd->PrevUserCallbackScroll != nullptr && ImGui_ImplGlfw_ShouldChainCallback(bd, window))
  431. bd->PrevUserCallbackScroll(window, xoffset, yoffset);
  432. #ifdef EMSCRIPTEN_USE_EMBEDDED_GLFW3
  433. // Ignore GLFW events: will be processed in ImGui_ImplEmscripten_WheelCallback().
  434. return;
  435. #endif
  436. ImGuiIO& io = ImGui::GetIO(bd->Context);
  437. io.AddMouseWheelEvent((float)xoffset, (float)yoffset);
  438. }
  439. // FIXME: should this be baked into ImGui_ImplGlfw_KeyToImGuiKey()? then what about the values passed to io.SetKeyEventNativeData()?
  440. static int ImGui_ImplGlfw_TranslateUntranslatedKey(int key, int scancode)
  441. {
  442. #if GLFW_HAS_GETKEYNAME && !defined(EMSCRIPTEN_USE_EMBEDDED_GLFW3)
  443. // GLFW 3.1+ attempts to "untranslate" keys, which goes the opposite of what every other framework does, making using lettered shortcuts difficult.
  444. // (It had reasons to do so: namely GLFW is/was more likely to be used for WASD-type game controls rather than lettered shortcuts, but IHMO the 3.1 change could have been done differently)
  445. // See https://github.com/glfw/glfw/issues/1502 for details.
  446. // Adding a workaround to undo this (so our keys are translated->untranslated->translated, likely a lossy process).
  447. // This won't cover edge cases but this is at least going to cover common cases.
  448. if (key >= GLFW_KEY_KP_0 && key <= GLFW_KEY_KP_EQUAL)
  449. return key;
  450. GLFWerrorfun prev_error_callback = glfwSetErrorCallback(nullptr);
  451. const char* key_name = glfwGetKeyName(key, scancode);
  452. glfwSetErrorCallback(prev_error_callback);
  453. #if GLFW_HAS_GETERROR && !defined(EMSCRIPTEN_USE_EMBEDDED_GLFW3) // Eat errors (see #5908)
  454. (void)glfwGetError(nullptr);
  455. #endif
  456. if (key_name && key_name[0] != 0 && key_name[1] == 0)
  457. {
  458. const char char_names[] = "`-=[]\\,;\'./";
  459. const int char_keys[] = { GLFW_KEY_GRAVE_ACCENT, GLFW_KEY_MINUS, GLFW_KEY_EQUAL, GLFW_KEY_LEFT_BRACKET, GLFW_KEY_RIGHT_BRACKET, GLFW_KEY_BACKSLASH, GLFW_KEY_COMMA, GLFW_KEY_SEMICOLON, GLFW_KEY_APOSTROPHE, GLFW_KEY_PERIOD, GLFW_KEY_SLASH, 0 };
  460. IM_ASSERT(IM_ARRAYSIZE(char_names) == IM_ARRAYSIZE(char_keys));
  461. if (key_name[0] >= '0' && key_name[0] <= '9') { key = GLFW_KEY_0 + (key_name[0] - '0'); }
  462. else if (key_name[0] >= 'A' && key_name[0] <= 'Z') { key = GLFW_KEY_A + (key_name[0] - 'A'); }
  463. else if (key_name[0] >= 'a' && key_name[0] <= 'z') { key = GLFW_KEY_A + (key_name[0] - 'a'); }
  464. else if (const char* p = strchr(char_names, key_name[0])) { key = char_keys[p - char_names]; }
  465. }
  466. // if (action == GLFW_PRESS) printf("key %d scancode %d name '%s'\n", key, scancode, key_name);
  467. #else
  468. IM_UNUSED(scancode);
  469. #endif
  470. return key;
  471. }
  472. void ImGui_ImplGlfw_KeyCallback(GLFWwindow* window, int keycode, int scancode, int action, int mods)
  473. {
  474. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  475. if (bd->PrevUserCallbackKey != nullptr && ImGui_ImplGlfw_ShouldChainCallback(bd, window))
  476. bd->PrevUserCallbackKey(window, keycode, scancode, action, mods);
  477. if (action != GLFW_PRESS && action != GLFW_RELEASE)
  478. return;
  479. ImGuiIO& io = ImGui::GetIO(bd->Context);
  480. ImGui_ImplGlfw_UpdateKeyModifiers(io, window);
  481. if (keycode >= 0 && keycode < IM_ARRAYSIZE(bd->KeyOwnerWindows))
  482. bd->KeyOwnerWindows[keycode] = (action == GLFW_PRESS) ? window : nullptr;
  483. keycode = ImGui_ImplGlfw_TranslateUntranslatedKey(keycode, scancode);
  484. ImGuiKey imgui_key = ImGui_ImplGlfw_KeyToImGuiKey(keycode, scancode);
  485. io.AddKeyEvent(imgui_key, (action == GLFW_PRESS));
  486. io.SetKeyEventNativeData(imgui_key, keycode, scancode); // To support legacy indexing (<1.87 user code)
  487. }
  488. void ImGui_ImplGlfw_WindowFocusCallback(GLFWwindow* window, int focused)
  489. {
  490. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  491. if (bd->PrevUserCallbackWindowFocus != nullptr && ImGui_ImplGlfw_ShouldChainCallback(bd, window))
  492. bd->PrevUserCallbackWindowFocus(window, focused);
  493. // Workaround for Linux: when losing focus with MouseIgnoreButtonUpWaitForFocusLoss set, we will temporarily ignore subsequent Mouse Up events
  494. bd->MouseIgnoreButtonUp = (bd->MouseIgnoreButtonUpWaitForFocusLoss && focused == 0);
  495. bd->MouseIgnoreButtonUpWaitForFocusLoss = false;
  496. ImGuiIO& io = ImGui::GetIO(bd->Context);
  497. io.AddFocusEvent(focused != 0);
  498. }
  499. void ImGui_ImplGlfw_CursorPosCallback(GLFWwindow* window, double x, double y)
  500. {
  501. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  502. if (bd->PrevUserCallbackCursorPos != nullptr && ImGui_ImplGlfw_ShouldChainCallback(bd, window))
  503. bd->PrevUserCallbackCursorPos(window, x, y);
  504. ImGuiIO& io = ImGui::GetIO(bd->Context);
  505. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  506. {
  507. int window_x, window_y;
  508. glfwGetWindowPos(window, &window_x, &window_y);
  509. x += window_x;
  510. y += window_y;
  511. }
  512. io.AddMousePosEvent((float)x, (float)y);
  513. bd->LastValidMousePos = ImVec2((float)x, (float)y);
  514. }
  515. // Workaround: X11 seems to send spurious Leave/Enter events which would make us lose our position,
  516. // so we back it up and restore on Leave/Enter (see https://github.com/ocornut/imgui/issues/4984)
  517. void ImGui_ImplGlfw_CursorEnterCallback(GLFWwindow* window, int entered)
  518. {
  519. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  520. if (bd->PrevUserCallbackCursorEnter != nullptr && ImGui_ImplGlfw_ShouldChainCallback(bd, window))
  521. bd->PrevUserCallbackCursorEnter(window, entered);
  522. ImGuiIO& io = ImGui::GetIO(bd->Context);
  523. if (entered)
  524. {
  525. bd->MouseWindow = window;
  526. io.AddMousePosEvent(bd->LastValidMousePos.x, bd->LastValidMousePos.y);
  527. }
  528. else if (!entered && bd->MouseWindow == window)
  529. {
  530. bd->LastValidMousePos = io.MousePos;
  531. bd->MouseWindow = nullptr;
  532. io.AddMousePosEvent(-FLT_MAX, -FLT_MAX);
  533. }
  534. }
  535. void ImGui_ImplGlfw_CharCallback(GLFWwindow* window, unsigned int c)
  536. {
  537. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  538. if (bd->PrevUserCallbackChar != nullptr && ImGui_ImplGlfw_ShouldChainCallback(bd, window))
  539. bd->PrevUserCallbackChar(window, c);
  540. ImGuiIO& io = ImGui::GetIO(bd->Context);
  541. io.AddInputCharacter(c);
  542. }
  543. void ImGui_ImplGlfw_MonitorCallback(GLFWmonitor*, int)
  544. {
  545. // This function is technically part of the API even if we stopped using the callback, so leaving it around.
  546. }
  547. #ifdef EMSCRIPTEN_USE_EMBEDDED_GLFW3
  548. static EM_BOOL ImGui_ImplEmscripten_WheelCallback(int, const EmscriptenWheelEvent* ev, void* user_data)
  549. {
  550. // Mimic Emscripten_HandleWheel() in SDL.
  551. // Corresponding equivalent in GLFW JS emulation layer has incorrect quantizing preventing small values. See #6096
  552. ImGui_ImplGlfw_Data* bd = (ImGui_ImplGlfw_Data*)user_data;
  553. float multiplier = 0.0f;
  554. if (ev->deltaMode == DOM_DELTA_PIXEL) { multiplier = 1.0f / 100.0f; } // 100 pixels make up a step.
  555. else if (ev->deltaMode == DOM_DELTA_LINE) { multiplier = 1.0f / 3.0f; } // 3 lines make up a step.
  556. else if (ev->deltaMode == DOM_DELTA_PAGE) { multiplier = 80.0f; } // A page makes up 80 steps.
  557. float wheel_x = ev->deltaX * -multiplier;
  558. float wheel_y = ev->deltaY * -multiplier;
  559. ImGuiIO& io = ImGui::GetIO(bd->Context);
  560. io.AddMouseWheelEvent(wheel_x, wheel_y);
  561. //IMGUI_DEBUG_LOG("[Emsc] mode %d dx: %.2f, dy: %.2f, dz: %.2f --> feed %.2f %.2f\n", (int)ev->deltaMode, ev->deltaX, ev->deltaY, ev->deltaZ, wheel_x, wheel_y);
  562. return EM_TRUE;
  563. }
  564. #endif
  565. #ifdef _WIN32
  566. static LRESULT CALLBACK ImGui_ImplGlfw_WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
  567. #endif
  568. void ImGui_ImplGlfw_InstallCallbacks(GLFWwindow* window)
  569. {
  570. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  571. IM_ASSERT(bd->InstalledCallbacks == false && "Callbacks already installed!");
  572. IM_ASSERT(bd->Window == window);
  573. bd->PrevUserCallbackWindowFocus = glfwSetWindowFocusCallback(window, ImGui_ImplGlfw_WindowFocusCallback);
  574. bd->PrevUserCallbackCursorEnter = glfwSetCursorEnterCallback(window, ImGui_ImplGlfw_CursorEnterCallback);
  575. bd->PrevUserCallbackCursorPos = glfwSetCursorPosCallback(window, ImGui_ImplGlfw_CursorPosCallback);
  576. bd->PrevUserCallbackMousebutton = glfwSetMouseButtonCallback(window, ImGui_ImplGlfw_MouseButtonCallback);
  577. bd->PrevUserCallbackScroll = glfwSetScrollCallback(window, ImGui_ImplGlfw_ScrollCallback);
  578. bd->PrevUserCallbackKey = glfwSetKeyCallback(window, ImGui_ImplGlfw_KeyCallback);
  579. bd->PrevUserCallbackChar = glfwSetCharCallback(window, ImGui_ImplGlfw_CharCallback);
  580. bd->PrevUserCallbackMonitor = glfwSetMonitorCallback(ImGui_ImplGlfw_MonitorCallback);
  581. bd->InstalledCallbacks = true;
  582. }
  583. void ImGui_ImplGlfw_RestoreCallbacks(GLFWwindow* window)
  584. {
  585. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  586. IM_ASSERT(bd->InstalledCallbacks == true && "Callbacks not installed!");
  587. IM_ASSERT(bd->Window == window);
  588. glfwSetWindowFocusCallback(window, bd->PrevUserCallbackWindowFocus);
  589. glfwSetCursorEnterCallback(window, bd->PrevUserCallbackCursorEnter);
  590. glfwSetCursorPosCallback(window, bd->PrevUserCallbackCursorPos);
  591. glfwSetMouseButtonCallback(window, bd->PrevUserCallbackMousebutton);
  592. glfwSetScrollCallback(window, bd->PrevUserCallbackScroll);
  593. glfwSetKeyCallback(window, bd->PrevUserCallbackKey);
  594. glfwSetCharCallback(window, bd->PrevUserCallbackChar);
  595. glfwSetMonitorCallback(bd->PrevUserCallbackMonitor);
  596. bd->InstalledCallbacks = false;
  597. bd->PrevUserCallbackWindowFocus = nullptr;
  598. bd->PrevUserCallbackCursorEnter = nullptr;
  599. bd->PrevUserCallbackCursorPos = nullptr;
  600. bd->PrevUserCallbackMousebutton = nullptr;
  601. bd->PrevUserCallbackScroll = nullptr;
  602. bd->PrevUserCallbackKey = nullptr;
  603. bd->PrevUserCallbackChar = nullptr;
  604. bd->PrevUserCallbackMonitor = nullptr;
  605. }
  606. // Set to 'true' to enable chaining installed callbacks for all windows (including secondary viewports created by backends or by user).
  607. // This is 'false' by default meaning we only chain callbacks for the main viewport.
  608. // We cannot set this to 'true' by default because user callbacks code may be not testing the 'window' parameter of their callback.
  609. // If you set this to 'true' your user callback code will need to make sure you are testing the 'window' parameter.
  610. void ImGui_ImplGlfw_SetCallbacksChainForAllWindows(bool chain_for_all_windows)
  611. {
  612. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  613. bd->CallbacksChainForAllWindows = chain_for_all_windows;
  614. }
  615. #ifdef __EMSCRIPTEN__
  616. #if EMSCRIPTEN_USE_PORT_CONTRIB_GLFW3 >= 34020240817
  617. void ImGui_ImplGlfw_EmscriptenOpenURL(const char* url) { if (url) emscripten::glfw3::OpenURL(url); }
  618. #else
  619. EM_JS(void, ImGui_ImplGlfw_EmscriptenOpenURL, (const char* url), { url = url ? UTF8ToString(url) : null; if (url) window.open(url, '_blank'); });
  620. #endif
  621. #endif
  622. static bool ImGui_ImplGlfw_Init(GLFWwindow* window, bool install_callbacks, GlfwClientApi client_api)
  623. {
  624. ImGuiIO& io = ImGui::GetIO();
  625. IMGUI_CHECKVERSION();
  626. IM_ASSERT(io.BackendPlatformUserData == nullptr && "Already initialized a platform backend!");
  627. //printf("GLFW_VERSION: %d.%d.%d (%d)", GLFW_VERSION_MAJOR, GLFW_VERSION_MINOR, GLFW_VERSION_REVISION, GLFW_VERSION_COMBINED);
  628. // Setup backend capabilities flags
  629. ImGui_ImplGlfw_Data* bd = IM_NEW(ImGui_ImplGlfw_Data)();
  630. snprintf(bd->BackendPlatformName, sizeof(bd->BackendPlatformName), "imgui_impl_glfw (%d)", GLFW_VERSION_COMBINED);
  631. io.BackendPlatformUserData = (void*)bd;
  632. io.BackendPlatformName = bd->BackendPlatformName;
  633. io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
  634. io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
  635. bool has_viewports = false;
  636. #ifndef __EMSCRIPTEN__
  637. has_viewports = true;
  638. #if GLFW_HAS_GETPLATFORM
  639. if (glfwGetPlatform() == GLFW_PLATFORM_WAYLAND)
  640. has_viewports = false;
  641. #endif
  642. if (has_viewports)
  643. io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports; // We can create multi-viewports on the Platform side (optional)
  644. #endif
  645. #if GLFW_HAS_MOUSE_PASSTHROUGH || GLFW_HAS_WINDOW_HOVERED
  646. io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport; // We can call io.AddMouseViewportEvent() with correct data (optional)
  647. #endif
  648. bd->Context = ImGui::GetCurrentContext();
  649. bd->Window = window;
  650. bd->Time = 0.0;
  651. bd->IsWayland = ImGui_ImplGlfw_IsWayland();
  652. ImGui_ImplGlfw_ContextMap_Add(window, bd->Context);
  653. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  654. #if GLFW_VERSION_COMBINED < 3300
  655. platform_io.Platform_SetClipboardTextFn = [](ImGuiContext*, const char* text) { glfwSetClipboardString(ImGui_ImplGlfw_GetBackendData()->Window, text); };
  656. platform_io.Platform_GetClipboardTextFn = [](ImGuiContext*) { return glfwGetClipboardString(ImGui_ImplGlfw_GetBackendData()->Window); };
  657. #else
  658. platform_io.Platform_SetClipboardTextFn = [](ImGuiContext*, const char* text) { glfwSetClipboardString(nullptr, text); };
  659. platform_io.Platform_GetClipboardTextFn = [](ImGuiContext*) { return glfwGetClipboardString(nullptr); };
  660. #endif
  661. #ifdef __EMSCRIPTEN__
  662. platform_io.Platform_OpenInShellFn = [](ImGuiContext*, const char* url) { ImGui_ImplGlfw_EmscriptenOpenURL(url); return true; };
  663. #endif
  664. // Create mouse cursors
  665. // (By design, on X11 cursors are user configurable and some cursors may be missing. When a cursor doesn't exist,
  666. // GLFW will emit an error which will often be printed by the app, so we temporarily disable error reporting.
  667. // Missing cursors will return nullptr and our _UpdateMouseCursor() function will use the Arrow cursor instead.)
  668. GLFWerrorfun prev_error_callback = glfwSetErrorCallback(nullptr);
  669. bd->MouseCursors[ImGuiMouseCursor_Arrow] = glfwCreateStandardCursor(GLFW_ARROW_CURSOR);
  670. bd->MouseCursors[ImGuiMouseCursor_TextInput] = glfwCreateStandardCursor(GLFW_IBEAM_CURSOR);
  671. bd->MouseCursors[ImGuiMouseCursor_ResizeNS] = glfwCreateStandardCursor(GLFW_VRESIZE_CURSOR);
  672. bd->MouseCursors[ImGuiMouseCursor_ResizeEW] = glfwCreateStandardCursor(GLFW_HRESIZE_CURSOR);
  673. bd->MouseCursors[ImGuiMouseCursor_Hand] = glfwCreateStandardCursor(GLFW_HAND_CURSOR);
  674. #if GLFW_HAS_NEW_CURSORS
  675. bd->MouseCursors[ImGuiMouseCursor_ResizeAll] = glfwCreateStandardCursor(GLFW_RESIZE_ALL_CURSOR);
  676. bd->MouseCursors[ImGuiMouseCursor_ResizeNESW] = glfwCreateStandardCursor(GLFW_RESIZE_NESW_CURSOR);
  677. bd->MouseCursors[ImGuiMouseCursor_ResizeNWSE] = glfwCreateStandardCursor(GLFW_RESIZE_NWSE_CURSOR);
  678. bd->MouseCursors[ImGuiMouseCursor_NotAllowed] = glfwCreateStandardCursor(GLFW_NOT_ALLOWED_CURSOR);
  679. #else
  680. bd->MouseCursors[ImGuiMouseCursor_ResizeAll] = glfwCreateStandardCursor(GLFW_ARROW_CURSOR);
  681. bd->MouseCursors[ImGuiMouseCursor_ResizeNESW] = glfwCreateStandardCursor(GLFW_ARROW_CURSOR);
  682. bd->MouseCursors[ImGuiMouseCursor_ResizeNWSE] = glfwCreateStandardCursor(GLFW_ARROW_CURSOR);
  683. bd->MouseCursors[ImGuiMouseCursor_NotAllowed] = glfwCreateStandardCursor(GLFW_ARROW_CURSOR);
  684. #endif
  685. glfwSetErrorCallback(prev_error_callback);
  686. #if GLFW_HAS_GETERROR && !defined(__EMSCRIPTEN__) // Eat errors (see #5908)
  687. (void)glfwGetError(nullptr);
  688. #endif
  689. // Chain GLFW callbacks: our callbacks will call the user's previously installed callbacks, if any.
  690. if (install_callbacks)
  691. ImGui_ImplGlfw_InstallCallbacks(window);
  692. // Update monitor a first time during init
  693. // (note: monitor callback are broken in GLFW 3.2 and earlier, see github.com/glfw/glfw/issues/784)
  694. ImGui_ImplGlfw_UpdateMonitors();
  695. glfwSetMonitorCallback(ImGui_ImplGlfw_MonitorCallback);
  696. // Set platform dependent data in viewport
  697. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  698. main_viewport->PlatformHandle = (void*)bd->Window;
  699. #ifdef _WIN32
  700. main_viewport->PlatformHandleRaw = glfwGetWin32Window(bd->Window);
  701. #elif defined(__APPLE__)
  702. main_viewport->PlatformHandleRaw = (void*)glfwGetCocoaWindow(bd->Window);
  703. #else
  704. IM_UNUSED(main_viewport);
  705. #endif
  706. if (has_viewports)
  707. ImGui_ImplGlfw_InitMultiViewportSupport();
  708. // Windows: register a WndProc hook so we can intercept some messages.
  709. #ifdef _WIN32
  710. HWND hwnd = (HWND)main_viewport->PlatformHandleRaw;
  711. ::SetPropA(hwnd, "IMGUI_BACKEND_DATA", bd);
  712. bd->PrevWndProc = (WNDPROC)::GetWindowLongPtrW(hwnd, GWLP_WNDPROC);
  713. IM_ASSERT(bd->PrevWndProc != nullptr);
  714. ::SetWindowLongPtrW((HWND)main_viewport->PlatformHandleRaw, GWLP_WNDPROC, (LONG_PTR)ImGui_ImplGlfw_WndProc);
  715. #endif
  716. // Emscripten: the same application can run on various platforms, so we detect the Apple platform at runtime
  717. // to override io.ConfigMacOSXBehaviors from its default (which is always false in Emscripten).
  718. #ifdef __EMSCRIPTEN__
  719. #if EMSCRIPTEN_USE_PORT_CONTRIB_GLFW3 >= 34020240817
  720. if (emscripten::glfw3::IsRuntimePlatformApple())
  721. {
  722. io.ConfigMacOSXBehaviors = true;
  723. // Due to how the browser (poorly) handles the Meta Key, this line essentially disables repeats when used.
  724. // This means that Meta + V only registers a single key-press, even if the keys are held.
  725. // This is a compromise for dealing with this issue in ImGui since ImGui implements key repeat itself.
  726. // See https://github.com/pongasoft/emscripten-glfw/blob/v3.4.0.20240817/docs/Usage.md#the-problem-of-the-super-key
  727. emscripten::glfw3::SetSuperPlusKeyTimeouts(10, 10);
  728. }
  729. #endif
  730. #endif
  731. bd->ClientApi = client_api;
  732. return true;
  733. }
  734. bool ImGui_ImplGlfw_InitForOpenGL(GLFWwindow* window, bool install_callbacks)
  735. {
  736. return ImGui_ImplGlfw_Init(window, install_callbacks, GlfwClientApi_OpenGL);
  737. }
  738. bool ImGui_ImplGlfw_InitForVulkan(GLFWwindow* window, bool install_callbacks)
  739. {
  740. return ImGui_ImplGlfw_Init(window, install_callbacks, GlfwClientApi_Vulkan);
  741. }
  742. bool ImGui_ImplGlfw_InitForOther(GLFWwindow* window, bool install_callbacks)
  743. {
  744. return ImGui_ImplGlfw_Init(window, install_callbacks, GlfwClientApi_Unknown);
  745. }
  746. void ImGui_ImplGlfw_Shutdown()
  747. {
  748. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  749. IM_ASSERT(bd != nullptr && "No platform backend to shutdown, or already shutdown?");
  750. ImGuiIO& io = ImGui::GetIO();
  751. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  752. ImGui_ImplGlfw_ShutdownMultiViewportSupport();
  753. if (bd->InstalledCallbacks)
  754. ImGui_ImplGlfw_RestoreCallbacks(bd->Window);
  755. #ifdef EMSCRIPTEN_USE_EMBEDDED_GLFW3
  756. if (bd->CanvasSelector)
  757. emscripten_set_wheel_callback(bd->CanvasSelector, nullptr, false, nullptr);
  758. #endif
  759. for (ImGuiMouseCursor cursor_n = 0; cursor_n < ImGuiMouseCursor_COUNT; cursor_n++)
  760. glfwDestroyCursor(bd->MouseCursors[cursor_n]);
  761. // Windows: restore our WndProc hook
  762. #ifdef _WIN32
  763. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  764. ::SetPropA((HWND)main_viewport->PlatformHandleRaw, "IMGUI_BACKEND_DATA", nullptr);
  765. ::SetWindowLongPtrW((HWND)main_viewport->PlatformHandleRaw, GWLP_WNDPROC, (LONG_PTR)bd->PrevWndProc);
  766. bd->PrevWndProc = nullptr;
  767. #endif
  768. io.BackendPlatformName = nullptr;
  769. io.BackendPlatformUserData = nullptr;
  770. io.BackendFlags &= ~(ImGuiBackendFlags_HasMouseCursors | ImGuiBackendFlags_HasSetMousePos | ImGuiBackendFlags_HasGamepad | ImGuiBackendFlags_PlatformHasViewports | ImGuiBackendFlags_HasMouseHoveredViewport);
  771. platform_io.ClearPlatformHandlers();
  772. ImGui_ImplGlfw_ContextMap_Remove(bd->Window);
  773. IM_DELETE(bd);
  774. }
  775. static void ImGui_ImplGlfw_UpdateMouseData()
  776. {
  777. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  778. ImGuiIO& io = ImGui::GetIO();
  779. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  780. ImGuiID mouse_viewport_id = 0;
  781. const ImVec2 mouse_pos_prev = io.MousePos;
  782. for (int n = 0; n < platform_io.Viewports.Size; n++)
  783. {
  784. ImGuiViewport* viewport = platform_io.Viewports[n];
  785. GLFWwindow* window = (GLFWwindow*)viewport->PlatformHandle;
  786. #ifdef EMSCRIPTEN_USE_EMBEDDED_GLFW3
  787. const bool is_window_focused = true;
  788. #else
  789. const bool is_window_focused = glfwGetWindowAttrib(window, GLFW_FOCUSED) != 0;
  790. #endif
  791. if (is_window_focused)
  792. {
  793. // (Optional) Set OS mouse position from Dear ImGui if requested (rarely used, only when io.ConfigNavMoveSetMousePos is enabled by user)
  794. // When multi-viewports are enabled, all Dear ImGui positions are same as OS positions.
  795. if (io.WantSetMousePos)
  796. glfwSetCursorPos(window, (double)(mouse_pos_prev.x - viewport->Pos.x), (double)(mouse_pos_prev.y - viewport->Pos.y));
  797. // (Optional) Fallback to provide mouse position when focused (ImGui_ImplGlfw_CursorPosCallback already provides this when hovered or captured)
  798. if (bd->MouseWindow == nullptr)
  799. {
  800. double mouse_x, mouse_y;
  801. glfwGetCursorPos(window, &mouse_x, &mouse_y);
  802. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  803. {
  804. // Single viewport mode: mouse position in client window coordinates (io.MousePos is (0,0) when the mouse is on the upper-left corner of the app window)
  805. // Multi-viewport mode: mouse position in OS absolute coordinates (io.MousePos is (0,0) when the mouse is on the upper-left of the primary monitor)
  806. int window_x, window_y;
  807. glfwGetWindowPos(window, &window_x, &window_y);
  808. mouse_x += window_x;
  809. mouse_y += window_y;
  810. }
  811. bd->LastValidMousePos = ImVec2((float)mouse_x, (float)mouse_y);
  812. io.AddMousePosEvent((float)mouse_x, (float)mouse_y);
  813. }
  814. }
  815. // (Optional) When using multiple viewports: call io.AddMouseViewportEvent() with the viewport the OS mouse cursor is hovering.
  816. // If ImGuiBackendFlags_HasMouseHoveredViewport is not set by the backend, Dear imGui will ignore this field and infer the information using its flawed heuristic.
  817. // - [X] GLFW >= 3.3 backend ON WINDOWS ONLY does correctly ignore viewports with the _NoInputs flag (since we implement hit via our WndProc hook)
  818. // On other platforms we rely on the library fallbacking to its own search when reporting a viewport with _NoInputs flag.
  819. // - [!] GLFW <= 3.2 backend CANNOT correctly ignore viewports with the _NoInputs flag, and CANNOT reported Hovered Viewport because of mouse capture.
  820. // Some backend are not able to handle that correctly. If a backend report an hovered viewport that has the _NoInputs flag (e.g. when dragging a window
  821. // for docking, the viewport has the _NoInputs flag in order to allow us to find the viewport under), then Dear ImGui is forced to ignore the value reported
  822. // by the backend, and use its flawed heuristic to guess the viewport behind.
  823. // - [X] GLFW backend correctly reports this regardless of another viewport behind focused and dragged from (we need this to find a useful drag and drop target).
  824. // FIXME: This is currently only correct on Win32. See what we do below with the WM_NCHITTEST, missing an equivalent for other systems.
  825. // See https://github.com/glfw/glfw/issues/1236 if you want to help in making this a GLFW feature.
  826. #if GLFW_HAS_MOUSE_PASSTHROUGH
  827. const bool window_no_input = (viewport->Flags & ImGuiViewportFlags_NoInputs) != 0;
  828. glfwSetWindowAttrib(window, GLFW_MOUSE_PASSTHROUGH, window_no_input);
  829. #endif
  830. #if GLFW_HAS_MOUSE_PASSTHROUGH || GLFW_HAS_WINDOW_HOVERED
  831. if (glfwGetWindowAttrib(window, GLFW_HOVERED))
  832. mouse_viewport_id = viewport->ID;
  833. #else
  834. // We cannot use bd->MouseWindow maintained from CursorEnter/Leave callbacks, because it is locked to the window capturing mouse.
  835. #endif
  836. }
  837. if (io.BackendFlags & ImGuiBackendFlags_HasMouseHoveredViewport)
  838. io.AddMouseViewportEvent(mouse_viewport_id);
  839. }
  840. static void ImGui_ImplGlfw_UpdateMouseCursor()
  841. {
  842. ImGuiIO& io = ImGui::GetIO();
  843. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  844. if ((io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange) || glfwGetInputMode(bd->Window, GLFW_CURSOR) == GLFW_CURSOR_DISABLED)
  845. return;
  846. ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
  847. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  848. for (int n = 0; n < platform_io.Viewports.Size; n++)
  849. {
  850. GLFWwindow* window = (GLFWwindow*)platform_io.Viewports[n]->PlatformHandle;
  851. if (imgui_cursor == ImGuiMouseCursor_None || io.MouseDrawCursor)
  852. {
  853. // Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
  854. glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_HIDDEN);
  855. }
  856. else
  857. {
  858. // Show OS mouse cursor
  859. // FIXME-PLATFORM: Unfocused windows seems to fail changing the mouse cursor with GLFW 3.2, but 3.3 works here.
  860. glfwSetCursor(window, bd->MouseCursors[imgui_cursor] ? bd->MouseCursors[imgui_cursor] : bd->MouseCursors[ImGuiMouseCursor_Arrow]);
  861. glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_NORMAL);
  862. }
  863. }
  864. }
  865. // Update gamepad inputs
  866. static inline float Saturate(float v) { return v < 0.0f ? 0.0f : v > 1.0f ? 1.0f : v; }
  867. static void ImGui_ImplGlfw_UpdateGamepads()
  868. {
  869. ImGuiIO& io = ImGui::GetIO();
  870. if ((io.ConfigFlags & ImGuiConfigFlags_NavEnableGamepad) == 0) // FIXME: Technically feeding gamepad shouldn't depend on this now that they are regular inputs, but see #8075
  871. return;
  872. io.BackendFlags &= ~ImGuiBackendFlags_HasGamepad;
  873. #if GLFW_HAS_GAMEPAD_API && !defined(EMSCRIPTEN_USE_EMBEDDED_GLFW3)
  874. GLFWgamepadstate gamepad;
  875. if (!glfwGetGamepadState(GLFW_JOYSTICK_1, &gamepad))
  876. return;
  877. #define MAP_BUTTON(KEY_NO, BUTTON_NO, _UNUSED) do { io.AddKeyEvent(KEY_NO, gamepad.buttons[BUTTON_NO] != 0); } while (0)
  878. #define MAP_ANALOG(KEY_NO, AXIS_NO, _UNUSED, V0, V1) do { float v = gamepad.axes[AXIS_NO]; v = (v - V0) / (V1 - V0); io.AddKeyAnalogEvent(KEY_NO, v > 0.10f, Saturate(v)); } while (0)
  879. #else
  880. int axes_count = 0, buttons_count = 0;
  881. const float* axes = glfwGetJoystickAxes(GLFW_JOYSTICK_1, &axes_count);
  882. const unsigned char* buttons = glfwGetJoystickButtons(GLFW_JOYSTICK_1, &buttons_count);
  883. if (axes_count == 0 || buttons_count == 0)
  884. return;
  885. #define MAP_BUTTON(KEY_NO, _UNUSED, BUTTON_NO) do { io.AddKeyEvent(KEY_NO, (buttons_count > BUTTON_NO && buttons[BUTTON_NO] == GLFW_PRESS)); } while (0)
  886. #define MAP_ANALOG(KEY_NO, _UNUSED, AXIS_NO, V0, V1) do { float v = (axes_count > AXIS_NO) ? axes[AXIS_NO] : V0; v = (v - V0) / (V1 - V0); io.AddKeyAnalogEvent(KEY_NO, v > 0.10f, Saturate(v)); } while (0)
  887. #endif
  888. io.BackendFlags |= ImGuiBackendFlags_HasGamepad;
  889. MAP_BUTTON(ImGuiKey_GamepadStart, GLFW_GAMEPAD_BUTTON_START, 7);
  890. MAP_BUTTON(ImGuiKey_GamepadBack, GLFW_GAMEPAD_BUTTON_BACK, 6);
  891. MAP_BUTTON(ImGuiKey_GamepadFaceLeft, GLFW_GAMEPAD_BUTTON_X, 2); // Xbox X, PS Square
  892. MAP_BUTTON(ImGuiKey_GamepadFaceRight, GLFW_GAMEPAD_BUTTON_B, 1); // Xbox B, PS Circle
  893. MAP_BUTTON(ImGuiKey_GamepadFaceUp, GLFW_GAMEPAD_BUTTON_Y, 3); // Xbox Y, PS Triangle
  894. MAP_BUTTON(ImGuiKey_GamepadFaceDown, GLFW_GAMEPAD_BUTTON_A, 0); // Xbox A, PS Cross
  895. MAP_BUTTON(ImGuiKey_GamepadDpadLeft, GLFW_GAMEPAD_BUTTON_DPAD_LEFT, 13);
  896. MAP_BUTTON(ImGuiKey_GamepadDpadRight, GLFW_GAMEPAD_BUTTON_DPAD_RIGHT, 11);
  897. MAP_BUTTON(ImGuiKey_GamepadDpadUp, GLFW_GAMEPAD_BUTTON_DPAD_UP, 10);
  898. MAP_BUTTON(ImGuiKey_GamepadDpadDown, GLFW_GAMEPAD_BUTTON_DPAD_DOWN, 12);
  899. MAP_BUTTON(ImGuiKey_GamepadL1, GLFW_GAMEPAD_BUTTON_LEFT_BUMPER, 4);
  900. MAP_BUTTON(ImGuiKey_GamepadR1, GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER, 5);
  901. MAP_ANALOG(ImGuiKey_GamepadL2, GLFW_GAMEPAD_AXIS_LEFT_TRIGGER, 4, -0.75f, +1.0f);
  902. MAP_ANALOG(ImGuiKey_GamepadR2, GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER, 5, -0.75f, +1.0f);
  903. MAP_BUTTON(ImGuiKey_GamepadL3, GLFW_GAMEPAD_BUTTON_LEFT_THUMB, 8);
  904. MAP_BUTTON(ImGuiKey_GamepadR3, GLFW_GAMEPAD_BUTTON_RIGHT_THUMB, 9);
  905. MAP_ANALOG(ImGuiKey_GamepadLStickLeft, GLFW_GAMEPAD_AXIS_LEFT_X, 0, -0.25f, -1.0f);
  906. MAP_ANALOG(ImGuiKey_GamepadLStickRight, GLFW_GAMEPAD_AXIS_LEFT_X, 0, +0.25f, +1.0f);
  907. MAP_ANALOG(ImGuiKey_GamepadLStickUp, GLFW_GAMEPAD_AXIS_LEFT_Y, 1, -0.25f, -1.0f);
  908. MAP_ANALOG(ImGuiKey_GamepadLStickDown, GLFW_GAMEPAD_AXIS_LEFT_Y, 1, +0.25f, +1.0f);
  909. MAP_ANALOG(ImGuiKey_GamepadRStickLeft, GLFW_GAMEPAD_AXIS_RIGHT_X, 2, -0.25f, -1.0f);
  910. MAP_ANALOG(ImGuiKey_GamepadRStickRight, GLFW_GAMEPAD_AXIS_RIGHT_X, 2, +0.25f, +1.0f);
  911. MAP_ANALOG(ImGuiKey_GamepadRStickUp, GLFW_GAMEPAD_AXIS_RIGHT_Y, 3, -0.25f, -1.0f);
  912. MAP_ANALOG(ImGuiKey_GamepadRStickDown, GLFW_GAMEPAD_AXIS_RIGHT_Y, 3, +0.25f, +1.0f);
  913. #undef MAP_BUTTON
  914. #undef MAP_ANALOG
  915. }
  916. static void ImGui_ImplGlfw_UpdateMonitors()
  917. {
  918. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  919. int monitors_count = 0;
  920. GLFWmonitor** glfw_monitors = glfwGetMonitors(&monitors_count);
  921. if (monitors_count == 0) // Preserve existing monitor list if there are none. Happens on macOS sleeping (#5683)
  922. return;
  923. platform_io.Monitors.resize(0);
  924. for (int n = 0; n < monitors_count; n++)
  925. {
  926. ImGuiPlatformMonitor monitor;
  927. int x, y;
  928. glfwGetMonitorPos(glfw_monitors[n], &x, &y);
  929. const GLFWvidmode* vid_mode = glfwGetVideoMode(glfw_monitors[n]);
  930. if (vid_mode == nullptr)
  931. continue; // Failed to get Video mode (e.g. Emscripten does not support this function)
  932. monitor.MainPos = monitor.WorkPos = ImVec2((float)x, (float)y);
  933. monitor.MainSize = monitor.WorkSize = ImVec2((float)vid_mode->width, (float)vid_mode->height);
  934. #if GLFW_HAS_MONITOR_WORK_AREA
  935. int w, h;
  936. glfwGetMonitorWorkarea(glfw_monitors[n], &x, &y, &w, &h);
  937. if (w > 0 && h > 0) // Workaround a small GLFW issue reporting zero on monitor changes: https://github.com/glfw/glfw/pull/1761
  938. {
  939. monitor.WorkPos = ImVec2((float)x, (float)y);
  940. monitor.WorkSize = ImVec2((float)w, (float)h);
  941. }
  942. #endif
  943. float scale = ImGui_ImplGlfw_GetContentScaleForMonitor(glfw_monitors[n]);
  944. if (scale == 0.0f)
  945. continue; // Some accessibility applications are declaring virtual monitors with a DPI of 0, see #7902.
  946. monitor.DpiScale = scale;
  947. monitor.PlatformHandle = (void*)glfw_monitors[n]; // [...] GLFW doc states: "guaranteed to be valid only until the monitor configuration changes"
  948. platform_io.Monitors.push_back(monitor);
  949. }
  950. }
  951. // - On Windows the process needs to be marked DPI-aware!! SDL2 doesn't do it by default. You can call ::SetProcessDPIAware() or call ImGui_ImplWin32_EnableDpiAwareness() from Win32 backend.
  952. // - Apple platforms use FramebufferScale so we always return 1.0f.
  953. // - Some accessibility applications are declaring virtual monitors with a DPI of 0.0f, see #7902. We preserve this value for caller to handle.
  954. float ImGui_ImplGlfw_GetContentScaleForWindow(GLFWwindow* window)
  955. {
  956. #if GLFW_HAS_X11_OR_WAYLAND
  957. if (ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window))
  958. if (bd->IsWayland)
  959. return 1.0f;
  960. #endif
  961. #if GLFW_HAS_PER_MONITOR_DPI && !(defined(__APPLE__) || defined(__EMSCRIPTEN__) || defined(__ANDROID__))
  962. float x_scale, y_scale;
  963. glfwGetWindowContentScale(window, &x_scale, &y_scale);
  964. return x_scale;
  965. #else
  966. IM_UNUSED(window);
  967. return 1.0f;
  968. #endif
  969. }
  970. float ImGui_ImplGlfw_GetContentScaleForMonitor(GLFWmonitor* monitor)
  971. {
  972. #if GLFW_HAS_X11_OR_WAYLAND
  973. if (ImGui_ImplGlfw_IsWayland()) // We can't access our bd->IsWayland cache for a monitor.
  974. return 1.0f;
  975. #endif
  976. #if GLFW_HAS_PER_MONITOR_DPI && !(defined(__APPLE__) || defined(__EMSCRIPTEN__) || defined(__ANDROID__))
  977. float x_scale, y_scale;
  978. glfwGetMonitorContentScale(monitor, &x_scale, &y_scale);
  979. return x_scale;
  980. #else
  981. IM_UNUSED(monitor);
  982. return 1.0f;
  983. #endif
  984. }
  985. static void ImGui_ImplGlfw_GetWindowSizeAndFramebufferScale(GLFWwindow* window, ImVec2* out_size, ImVec2* out_framebuffer_scale)
  986. {
  987. int w, h;
  988. int display_w, display_h;
  989. glfwGetWindowSize(window, &w, &h);
  990. glfwGetFramebufferSize(window, &display_w, &display_h);
  991. float fb_scale_x = (w > 0) ? (float)display_w / w : 1.0f;
  992. float fb_scale_y = (h > 0) ? (float)display_h / h : 1.0f;
  993. #if GLFW_HAS_X11_OR_WAYLAND
  994. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData(window);
  995. if (!bd->IsWayland)
  996. fb_scale_x = fb_scale_y = 1.0f;
  997. #endif
  998. if (out_size != nullptr)
  999. *out_size = ImVec2((float)w, (float)h);
  1000. if (out_framebuffer_scale != nullptr)
  1001. *out_framebuffer_scale = ImVec2(fb_scale_x, fb_scale_y);
  1002. }
  1003. void ImGui_ImplGlfw_NewFrame()
  1004. {
  1005. ImGuiIO& io = ImGui::GetIO();
  1006. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  1007. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplGlfw_InitForXXX()?");
  1008. // Setup main viewport size (every frame to accommodate for window resizing)
  1009. ImGui_ImplGlfw_GetWindowSizeAndFramebufferScale(bd->Window, &io.DisplaySize, &io.DisplayFramebufferScale);
  1010. ImGui_ImplGlfw_UpdateMonitors();
  1011. // Setup time step
  1012. // (Accept glfwGetTime() not returning a monotonically increasing value. Seems to happens on disconnecting peripherals and probably on VMs and Emscripten, see #6491, #6189, #6114, #3644)
  1013. double current_time = glfwGetTime();
  1014. if (current_time <= bd->Time)
  1015. current_time = bd->Time + 0.00001f;
  1016. io.DeltaTime = bd->Time > 0.0 ? (float)(current_time - bd->Time) : (float)(1.0f / 60.0f);
  1017. bd->Time = current_time;
  1018. bd->MouseIgnoreButtonUp = false;
  1019. ImGui_ImplGlfw_UpdateMouseData();
  1020. ImGui_ImplGlfw_UpdateMouseCursor();
  1021. // Update game controllers (if enabled and available)
  1022. ImGui_ImplGlfw_UpdateGamepads();
  1023. }
  1024. // GLFW doesn't provide a portable sleep function
  1025. void ImGui_ImplGlfw_Sleep(int milliseconds)
  1026. {
  1027. #ifdef _WIN32
  1028. ::Sleep(milliseconds);
  1029. #else
  1030. usleep(milliseconds * 1000);
  1031. #endif
  1032. }
  1033. #ifdef EMSCRIPTEN_USE_EMBEDDED_GLFW3
  1034. static EM_BOOL ImGui_ImplGlfw_OnCanvasSizeChange(int event_type, const EmscriptenUiEvent* event, void* user_data)
  1035. {
  1036. ImGui_ImplGlfw_Data* bd = (ImGui_ImplGlfw_Data*)user_data;
  1037. double canvas_width, canvas_height;
  1038. emscripten_get_element_css_size(bd->CanvasSelector, &canvas_width, &canvas_height);
  1039. glfwSetWindowSize(bd->Window, (int)canvas_width, (int)canvas_height);
  1040. return true;
  1041. }
  1042. static EM_BOOL ImGui_ImplEmscripten_FullscreenChangeCallback(int event_type, const EmscriptenFullscreenChangeEvent* event, void* user_data)
  1043. {
  1044. ImGui_ImplGlfw_Data* bd = (ImGui_ImplGlfw_Data*)user_data;
  1045. double canvas_width, canvas_height;
  1046. emscripten_get_element_css_size(bd->CanvasSelector, &canvas_width, &canvas_height);
  1047. glfwSetWindowSize(bd->Window, (int)canvas_width, (int)canvas_height);
  1048. return true;
  1049. }
  1050. // 'canvas_selector' is a CSS selector. The event listener is applied to the first element that matches the query.
  1051. // STRING MUST PERSIST FOR THE APPLICATION DURATION. PLEASE USE A STRING LITERAL OR ENSURE POINTER WILL STAY VALID.
  1052. void ImGui_ImplGlfw_InstallEmscriptenCallbacks(GLFWwindow*, const char* canvas_selector)
  1053. {
  1054. IM_ASSERT(canvas_selector != nullptr);
  1055. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  1056. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplGlfw_InitForXXX()?");
  1057. bd->CanvasSelector = canvas_selector;
  1058. emscripten_set_resize_callback(EMSCRIPTEN_EVENT_TARGET_WINDOW, bd, false, ImGui_ImplGlfw_OnCanvasSizeChange);
  1059. emscripten_set_fullscreenchange_callback(EMSCRIPTEN_EVENT_TARGET_DOCUMENT, bd, false, ImGui_ImplEmscripten_FullscreenChangeCallback);
  1060. // Change the size of the GLFW window according to the size of the canvas
  1061. ImGui_ImplGlfw_OnCanvasSizeChange(EMSCRIPTEN_EVENT_RESIZE, {}, bd);
  1062. // Register Emscripten Wheel callback to workaround issue in Emscripten GLFW Emulation (#6096)
  1063. // We intentionally do not check 'if (install_callbacks)' here, as some users may set it to false and call GLFW callback themselves.
  1064. // FIXME: May break chaining in case user registered their own Emscripten callback?
  1065. emscripten_set_wheel_callback(bd->CanvasSelector, bd, false, ImGui_ImplEmscripten_WheelCallback);
  1066. }
  1067. #elif defined(EMSCRIPTEN_USE_PORT_CONTRIB_GLFW3)
  1068. // When using --use-port=contrib.glfw3 for the GLFW implementation, you can override the behavior of this call
  1069. // by invoking emscripten_glfw_make_canvas_resizable afterward.
  1070. // See https://github.com/pongasoft/emscripten-glfw/blob/master/docs/Usage.md#how-to-make-the-canvas-resizable-by-the-user for an explanation
  1071. void ImGui_ImplGlfw_InstallEmscriptenCallbacks(GLFWwindow* window, const char* canvas_selector)
  1072. {
  1073. GLFWwindow* w = (GLFWwindow*)(EM_ASM_INT({ return Module.glfwGetWindow(UTF8ToString($0)); }, canvas_selector));
  1074. IM_ASSERT(window == w); // Sanity check
  1075. IM_UNUSED(w);
  1076. emscripten_glfw_make_canvas_resizable(window, "window", nullptr);
  1077. }
  1078. #endif // #ifdef EMSCRIPTEN_USE_PORT_CONTRIB_GLFW3
  1079. //--------------------------------------------------------------------------------------------------------
  1080. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  1081. // This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports simultaneously.
  1082. // 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..
  1083. //--------------------------------------------------------------------------------------------------------
  1084. // Helper structure we store in the void* PlatformUserData field of each ImGuiViewport to easily retrieve our backend data.
  1085. struct ImGui_ImplGlfw_ViewportData
  1086. {
  1087. GLFWwindow* Window; // Stored in ImGuiViewport::PlatformHandle
  1088. bool WindowOwned;
  1089. int IgnoreWindowPosEventFrame;
  1090. int IgnoreWindowSizeEventFrame;
  1091. #ifdef _WIN32
  1092. WNDPROC PrevWndProc;
  1093. #endif
  1094. ImGui_ImplGlfw_ViewportData() { memset((void*)this, 0, sizeof(*this)); IgnoreWindowSizeEventFrame = IgnoreWindowPosEventFrame = -1; }
  1095. ~ImGui_ImplGlfw_ViewportData() { IM_ASSERT(Window == nullptr); }
  1096. };
  1097. static void ImGui_ImplGlfw_WindowCloseCallback(GLFWwindow* window)
  1098. {
  1099. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle(window))
  1100. viewport->PlatformRequestClose = true;
  1101. }
  1102. // GLFW may dispatch window pos/size events after calling glfwSetWindowPos()/glfwSetWindowSize().
  1103. // However: depending on the platform the callback may be invoked at different time:
  1104. // - on Windows it appears to be called within the glfwSetWindowPos()/glfwSetWindowSize() call
  1105. // - on Linux it is queued and invoked during glfwPollEvents()
  1106. // Because the event doesn't always fire on glfwSetWindowXXX() we use a frame counter tag to only
  1107. // ignore recent glfwSetWindowXXX() calls.
  1108. static void ImGui_ImplGlfw_WindowPosCallback(GLFWwindow* window, int, int)
  1109. {
  1110. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle(window))
  1111. {
  1112. if (ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData)
  1113. {
  1114. bool ignore_event = (ImGui::GetFrameCount() <= vd->IgnoreWindowPosEventFrame + 1);
  1115. //data->IgnoreWindowPosEventFrame = -1;
  1116. if (ignore_event)
  1117. return;
  1118. }
  1119. viewport->PlatformRequestMove = true;
  1120. }
  1121. }
  1122. static void ImGui_ImplGlfw_WindowSizeCallback(GLFWwindow* window, int, int)
  1123. {
  1124. if (ImGuiViewport* viewport = ImGui::FindViewportByPlatformHandle(window))
  1125. {
  1126. if (ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData)
  1127. {
  1128. bool ignore_event = (ImGui::GetFrameCount() <= vd->IgnoreWindowSizeEventFrame + 1);
  1129. //data->IgnoreWindowSizeEventFrame = -1;
  1130. if (ignore_event)
  1131. return;
  1132. }
  1133. viewport->PlatformRequestResize = true;
  1134. }
  1135. }
  1136. #if !defined(__APPLE__) && !defined(_WIN32) && !defined(__EMSCRIPTEN__) && GLFW_HAS_GETPLATFORM
  1137. #define IMGUI_GLFW_HAS_SETWINDOWFLOATING
  1138. static void ImGui_ImplGlfw_SetWindowFloating(GLFWwindow* window)
  1139. {
  1140. #ifdef GLFW_EXPOSE_NATIVE_X11
  1141. if (glfwGetPlatform() == GLFW_PLATFORM_X11)
  1142. {
  1143. Display* display = glfwGetX11Display();
  1144. Window xwindow = glfwGetX11Window(window);
  1145. Atom wm_type = XInternAtom(display, "_NET_WM_WINDOW_TYPE", False);
  1146. Atom wm_type_dialog = XInternAtom(display, "_NET_WM_WINDOW_TYPE_DIALOG", False);
  1147. XChangeProperty(display, xwindow, wm_type, XA_ATOM, 32, PropModeReplace, (unsigned char*)&wm_type_dialog, 1);
  1148. XSetWindowAttributes attrs;
  1149. attrs.override_redirect = False;
  1150. XChangeWindowAttributes(display, xwindow, CWOverrideRedirect, &attrs);
  1151. XFlush(display);
  1152. }
  1153. #endif // GLFW_EXPOSE_NATIVE_X11
  1154. #ifdef GLFW_EXPOSE_NATIVE_WAYLAND
  1155. // FIXME: Help needed, see #8884, #8474 for discussions about this.
  1156. #endif // GLFW_EXPOSE_NATIVE_X11
  1157. }
  1158. #endif // IMGUI_GLFW_HAS_SETWINDOWFLOATING
  1159. static void ImGui_ImplGlfw_CreateWindow(ImGuiViewport* viewport)
  1160. {
  1161. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  1162. ImGui_ImplGlfw_ViewportData* vd = IM_NEW(ImGui_ImplGlfw_ViewportData)();
  1163. viewport->PlatformUserData = vd;
  1164. // Workaround for Linux: ignore mouse up events corresponding to losing focus of the previously focused window (#7733, #3158, #7922)
  1165. #ifdef __linux__
  1166. bd->MouseIgnoreButtonUpWaitForFocusLoss = true;
  1167. #endif
  1168. // GLFW 3.2 unfortunately always set focus on glfwCreateWindow() if GLFW_VISIBLE is set, regardless of GLFW_FOCUSED
  1169. // With GLFW 3.3, the hint GLFW_FOCUS_ON_SHOW fixes this problem
  1170. glfwWindowHint(GLFW_VISIBLE, false);
  1171. glfwWindowHint(GLFW_FOCUSED, false);
  1172. #if GLFW_HAS_FOCUS_ON_SHOW
  1173. glfwWindowHint(GLFW_FOCUS_ON_SHOW, false);
  1174. #endif
  1175. glfwWindowHint(GLFW_DECORATED, (viewport->Flags & ImGuiViewportFlags_NoDecoration) ? false : true);
  1176. #if GLFW_HAS_WINDOW_TOPMOST
  1177. glfwWindowHint(GLFW_FLOATING, (viewport->Flags & ImGuiViewportFlags_TopMost) ? true : false);
  1178. #endif
  1179. GLFWwindow* share_window = (bd->ClientApi == GlfwClientApi_OpenGL) ? bd->Window : nullptr;
  1180. vd->Window = glfwCreateWindow((int)viewport->Size.x, (int)viewport->Size.y, "No Title Yet", nullptr, share_window);
  1181. vd->WindowOwned = true;
  1182. ImGui_ImplGlfw_ContextMap_Add(vd->Window, bd->Context);
  1183. viewport->PlatformHandle = (void*)vd->Window;
  1184. #ifdef IMGUI_GLFW_HAS_SETWINDOWFLOATING
  1185. ImGui_ImplGlfw_SetWindowFloating(vd->Window);
  1186. #endif
  1187. #ifdef _WIN32
  1188. viewport->PlatformHandleRaw = glfwGetWin32Window(vd->Window);
  1189. ::SetPropA((HWND)viewport->PlatformHandleRaw, "IMGUI_BACKEND_DATA", bd);
  1190. #elif defined(__APPLE__)
  1191. viewport->PlatformHandleRaw = (void*)glfwGetCocoaWindow(vd->Window);
  1192. #endif
  1193. glfwSetWindowPos(vd->Window, (int)viewport->Pos.x, (int)viewport->Pos.y);
  1194. // Install GLFW callbacks for secondary viewports
  1195. glfwSetWindowFocusCallback(vd->Window, ImGui_ImplGlfw_WindowFocusCallback);
  1196. glfwSetCursorEnterCallback(vd->Window, ImGui_ImplGlfw_CursorEnterCallback);
  1197. glfwSetCursorPosCallback(vd->Window, ImGui_ImplGlfw_CursorPosCallback);
  1198. glfwSetMouseButtonCallback(vd->Window, ImGui_ImplGlfw_MouseButtonCallback);
  1199. glfwSetScrollCallback(vd->Window, ImGui_ImplGlfw_ScrollCallback);
  1200. glfwSetKeyCallback(vd->Window, ImGui_ImplGlfw_KeyCallback);
  1201. glfwSetCharCallback(vd->Window, ImGui_ImplGlfw_CharCallback);
  1202. glfwSetWindowCloseCallback(vd->Window, ImGui_ImplGlfw_WindowCloseCallback);
  1203. glfwSetWindowPosCallback(vd->Window, ImGui_ImplGlfw_WindowPosCallback);
  1204. glfwSetWindowSizeCallback(vd->Window, ImGui_ImplGlfw_WindowSizeCallback);
  1205. if (bd->ClientApi == GlfwClientApi_OpenGL)
  1206. {
  1207. glfwMakeContextCurrent(vd->Window);
  1208. glfwSwapInterval(0);
  1209. }
  1210. }
  1211. static void ImGui_ImplGlfw_DestroyWindow(ImGuiViewport* viewport)
  1212. {
  1213. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  1214. if (ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData)
  1215. {
  1216. if (vd->WindowOwned)
  1217. {
  1218. #if !GLFW_HAS_MOUSE_PASSTHROUGH && GLFW_HAS_WINDOW_HOVERED && defined(_WIN32)
  1219. HWND hwnd = (HWND)viewport->PlatformHandleRaw;
  1220. ::RemovePropA(hwnd, "IMGUI_VIEWPORT");
  1221. #endif
  1222. // Release any keys that were pressed in the window being destroyed and are still held down,
  1223. // because we will not receive any release events after window is destroyed.
  1224. for (int i = 0; i < IM_ARRAYSIZE(bd->KeyOwnerWindows); i++)
  1225. if (bd->KeyOwnerWindows[i] == vd->Window)
  1226. ImGui_ImplGlfw_KeyCallback(vd->Window, i, 0, GLFW_RELEASE, 0); // Later params are only used for main viewport, on which this function is never called.
  1227. ImGui_ImplGlfw_ContextMap_Remove(vd->Window);
  1228. glfwDestroyWindow(vd->Window);
  1229. }
  1230. vd->Window = nullptr;
  1231. IM_DELETE(vd);
  1232. }
  1233. viewport->PlatformUserData = viewport->PlatformHandle = nullptr;
  1234. }
  1235. static void ImGui_ImplGlfw_ShowWindow(ImGuiViewport* viewport)
  1236. {
  1237. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1238. #if defined(_WIN32)
  1239. // GLFW hack: Hide icon from task bar
  1240. HWND hwnd = (HWND)viewport->PlatformHandleRaw;
  1241. if (viewport->Flags & ImGuiViewportFlags_NoTaskBarIcon)
  1242. {
  1243. LONG ex_style = ::GetWindowLong(hwnd, GWL_EXSTYLE);
  1244. ex_style &= ~WS_EX_APPWINDOW;
  1245. ex_style |= WS_EX_TOOLWINDOW;
  1246. ::SetWindowLong(hwnd, GWL_EXSTYLE, ex_style);
  1247. }
  1248. // GLFW hack: install WndProc for mouse source event and WM_NCHITTEST message handler.
  1249. ::SetPropA(hwnd, "IMGUI_VIEWPORT", viewport);
  1250. vd->PrevWndProc = (WNDPROC)::GetWindowLongPtrW(hwnd, GWLP_WNDPROC);
  1251. ::SetWindowLongPtrW(hwnd, GWLP_WNDPROC, (LONG_PTR)ImGui_ImplGlfw_WndProc);
  1252. #if !GLFW_HAS_FOCUS_ON_SHOW
  1253. // GLFW hack: GLFW 3.2 has a bug where glfwShowWindow() also activates/focus the window.
  1254. // The fix was pushed to GLFW repository on 2018/01/09 and should be included in GLFW 3.3 via a GLFW_FOCUS_ON_SHOW window attribute.
  1255. // See https://github.com/glfw/glfw/issues/1189
  1256. // FIXME-VIEWPORT: Implement same work-around for Linux/OSX in the meanwhile.
  1257. if (viewport->Flags & ImGuiViewportFlags_NoFocusOnAppearing)
  1258. {
  1259. ::ShowWindow(hwnd, SW_SHOWNA);
  1260. return;
  1261. }
  1262. #endif
  1263. #endif
  1264. glfwShowWindow(vd->Window);
  1265. }
  1266. static ImVec2 ImGui_ImplGlfw_GetWindowPos(ImGuiViewport* viewport)
  1267. {
  1268. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1269. int x = 0, y = 0;
  1270. glfwGetWindowPos(vd->Window, &x, &y);
  1271. return ImVec2((float)x, (float)y);
  1272. }
  1273. static void ImGui_ImplGlfw_SetWindowPos(ImGuiViewport* viewport, ImVec2 pos)
  1274. {
  1275. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1276. vd->IgnoreWindowPosEventFrame = ImGui::GetFrameCount();
  1277. glfwSetWindowPos(vd->Window, (int)pos.x, (int)pos.y);
  1278. }
  1279. static ImVec2 ImGui_ImplGlfw_GetWindowSize(ImGuiViewport* viewport)
  1280. {
  1281. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1282. int w = 0, h = 0;
  1283. glfwGetWindowSize(vd->Window, &w, &h);
  1284. return ImVec2((float)w, (float)h);
  1285. }
  1286. static void ImGui_ImplGlfw_SetWindowSize(ImGuiViewport* viewport, ImVec2 size)
  1287. {
  1288. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1289. #if defined(__APPLE__) && !GLFW_HAS_OSX_WINDOW_POS_FIX
  1290. // Native OS windows are positioned from the bottom-left corner on macOS, whereas on other platforms they are
  1291. // positioned from the upper-left corner. GLFW makes an effort to convert macOS style coordinates, however it
  1292. // doesn't handle it when changing size. We are manually moving the window in order for changes of size to be based
  1293. // on the upper-left corner.
  1294. int x, y, width, height;
  1295. glfwGetWindowPos(vd->Window, &x, &y);
  1296. glfwGetWindowSize(vd->Window, &width, &height);
  1297. glfwSetWindowPos(vd->Window, x, y - height + size.y);
  1298. #endif
  1299. vd->IgnoreWindowSizeEventFrame = ImGui::GetFrameCount();
  1300. glfwSetWindowSize(vd->Window, (int)size.x, (int)size.y);
  1301. }
  1302. static ImVec2 ImGui_ImplGlfw_GetWindowFramebufferScale(ImGuiViewport* viewport)
  1303. {
  1304. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1305. ImVec2 framebuffer_scale;
  1306. ImGui_ImplGlfw_GetWindowSizeAndFramebufferScale(vd->Window, nullptr, &framebuffer_scale);
  1307. return framebuffer_scale;
  1308. }
  1309. static void ImGui_ImplGlfw_SetWindowTitle(ImGuiViewport* viewport, const char* title)
  1310. {
  1311. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1312. glfwSetWindowTitle(vd->Window, title);
  1313. }
  1314. static void ImGui_ImplGlfw_SetWindowFocus(ImGuiViewport* viewport)
  1315. {
  1316. #if GLFW_HAS_FOCUS_WINDOW
  1317. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1318. glfwFocusWindow(vd->Window);
  1319. #else
  1320. // FIXME: What are the effect of not having this function? At the moment imgui doesn't actually call SetWindowFocus - we set that up ahead, will answer that question later.
  1321. (void)viewport;
  1322. #endif
  1323. }
  1324. static bool ImGui_ImplGlfw_GetWindowFocus(ImGuiViewport* viewport)
  1325. {
  1326. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1327. return glfwGetWindowAttrib(vd->Window, GLFW_FOCUSED) != 0;
  1328. }
  1329. static bool ImGui_ImplGlfw_GetWindowMinimized(ImGuiViewport* viewport)
  1330. {
  1331. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1332. return glfwGetWindowAttrib(vd->Window, GLFW_ICONIFIED) != 0;
  1333. }
  1334. #if GLFW_HAS_WINDOW_ALPHA
  1335. static void ImGui_ImplGlfw_SetWindowAlpha(ImGuiViewport* viewport, float alpha)
  1336. {
  1337. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1338. glfwSetWindowOpacity(vd->Window, alpha);
  1339. }
  1340. #endif
  1341. static void ImGui_ImplGlfw_RenderWindow(ImGuiViewport* viewport, void*)
  1342. {
  1343. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  1344. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1345. if (bd->ClientApi == GlfwClientApi_OpenGL)
  1346. glfwMakeContextCurrent(vd->Window);
  1347. }
  1348. static void ImGui_ImplGlfw_SwapBuffers(ImGuiViewport* viewport, void*)
  1349. {
  1350. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  1351. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1352. if (bd->ClientApi == GlfwClientApi_OpenGL)
  1353. {
  1354. glfwMakeContextCurrent(vd->Window);
  1355. glfwSwapBuffers(vd->Window);
  1356. }
  1357. }
  1358. //--------------------------------------------------------------------------------------------------------
  1359. // Vulkan support (the Vulkan renderer needs to call a platform-side support function to create the surface)
  1360. //--------------------------------------------------------------------------------------------------------
  1361. // Avoid including <vulkan.h> so we can build without it
  1362. #if GLFW_HAS_VULKAN
  1363. #ifndef VULKAN_H_
  1364. #define VK_DEFINE_HANDLE(object) typedef struct object##_T* object;
  1365. #if defined(__LP64__) || defined(_WIN64) || defined(__x86_64__) || defined(_M_X64) || defined(__ia64) || defined (_M_IA64) || defined(__aarch64__) || defined(__powerpc64__)
  1366. #define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef struct object##_T *object;
  1367. #else
  1368. #define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef uint64_t object;
  1369. #endif
  1370. VK_DEFINE_HANDLE(VkInstance)
  1371. VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkSurfaceKHR)
  1372. struct VkAllocationCallbacks;
  1373. enum VkResult { VK_RESULT_MAX_ENUM = 0x7FFFFFFF };
  1374. #endif // VULKAN_H_
  1375. extern "C" { extern GLFWAPI VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow* window, const VkAllocationCallbacks* allocator, VkSurfaceKHR* surface); }
  1376. static int ImGui_ImplGlfw_CreateVkSurface(ImGuiViewport* viewport, ImU64 vk_instance, const void* vk_allocator, ImU64* out_vk_surface)
  1377. {
  1378. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  1379. ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData;
  1380. IM_UNUSED(bd);
  1381. IM_ASSERT(bd->ClientApi == GlfwClientApi_Vulkan);
  1382. VkResult err = glfwCreateWindowSurface((VkInstance)vk_instance, vd->Window, (const VkAllocationCallbacks*)vk_allocator, (VkSurfaceKHR*)out_vk_surface);
  1383. return (int)err;
  1384. }
  1385. #endif // GLFW_HAS_VULKAN
  1386. static void ImGui_ImplGlfw_InitMultiViewportSupport()
  1387. {
  1388. // Register platform interface (will be coupled with a renderer interface)
  1389. ImGui_ImplGlfw_Data* bd = ImGui_ImplGlfw_GetBackendData();
  1390. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  1391. platform_io.Platform_CreateWindow = ImGui_ImplGlfw_CreateWindow;
  1392. platform_io.Platform_DestroyWindow = ImGui_ImplGlfw_DestroyWindow;
  1393. platform_io.Platform_ShowWindow = ImGui_ImplGlfw_ShowWindow;
  1394. platform_io.Platform_SetWindowPos = ImGui_ImplGlfw_SetWindowPos;
  1395. platform_io.Platform_GetWindowPos = ImGui_ImplGlfw_GetWindowPos;
  1396. platform_io.Platform_SetWindowSize = ImGui_ImplGlfw_SetWindowSize;
  1397. platform_io.Platform_GetWindowSize = ImGui_ImplGlfw_GetWindowSize;
  1398. platform_io.Platform_GetWindowFramebufferScale = ImGui_ImplGlfw_GetWindowFramebufferScale;
  1399. platform_io.Platform_SetWindowFocus = ImGui_ImplGlfw_SetWindowFocus;
  1400. platform_io.Platform_GetWindowFocus = ImGui_ImplGlfw_GetWindowFocus;
  1401. platform_io.Platform_GetWindowMinimized = ImGui_ImplGlfw_GetWindowMinimized;
  1402. platform_io.Platform_SetWindowTitle = ImGui_ImplGlfw_SetWindowTitle;
  1403. platform_io.Platform_RenderWindow = ImGui_ImplGlfw_RenderWindow;
  1404. platform_io.Platform_SwapBuffers = ImGui_ImplGlfw_SwapBuffers;
  1405. #if GLFW_HAS_WINDOW_ALPHA
  1406. platform_io.Platform_SetWindowAlpha = ImGui_ImplGlfw_SetWindowAlpha;
  1407. #endif
  1408. #if GLFW_HAS_VULKAN
  1409. platform_io.Platform_CreateVkSurface = ImGui_ImplGlfw_CreateVkSurface;
  1410. #endif
  1411. // Register main window handle (which is owned by the main application, not by us)
  1412. // This is mostly for simplicity and consistency, so that our code (e.g. mouse handling etc.) can use same logic for main and secondary viewports.
  1413. ImGuiViewport* main_viewport = ImGui::GetMainViewport();
  1414. ImGui_ImplGlfw_ViewportData* vd = IM_NEW(ImGui_ImplGlfw_ViewportData)();
  1415. vd->Window = bd->Window;
  1416. vd->WindowOwned = false;
  1417. main_viewport->PlatformUserData = vd;
  1418. main_viewport->PlatformHandle = (void*)bd->Window;
  1419. }
  1420. static void ImGui_ImplGlfw_ShutdownMultiViewportSupport()
  1421. {
  1422. ImGui::DestroyPlatformWindows();
  1423. }
  1424. //-----------------------------------------------------------------------------
  1425. // WndProc hook (declared here because we will need access to ImGui_ImplGlfw_ViewportData)
  1426. #ifdef _WIN32
  1427. static ImGuiMouseSource GetMouseSourceFromMessageExtraInfo()
  1428. {
  1429. LPARAM extra_info = ::GetMessageExtraInfo();
  1430. if ((extra_info & 0xFFFFFF80) == 0xFF515700)
  1431. return ImGuiMouseSource_Pen;
  1432. if ((extra_info & 0xFFFFFF80) == 0xFF515780)
  1433. return ImGuiMouseSource_TouchScreen;
  1434. return ImGuiMouseSource_Mouse;
  1435. }
  1436. static LRESULT CALLBACK ImGui_ImplGlfw_WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)
  1437. {
  1438. ImGui_ImplGlfw_Data* bd = (ImGui_ImplGlfw_Data*)::GetPropA(hWnd, "IMGUI_BACKEND_DATA");
  1439. ImGuiIO& io = ImGui::GetIO(bd->Context);
  1440. WNDPROC prev_wndproc = bd->PrevWndProc;
  1441. ImGuiViewport* viewport = (ImGuiViewport*)::GetPropA(hWnd, "IMGUI_VIEWPORT");
  1442. if (viewport != NULL)
  1443. if (ImGui_ImplGlfw_ViewportData* vd = (ImGui_ImplGlfw_ViewportData*)viewport->PlatformUserData)
  1444. prev_wndproc = vd->PrevWndProc;
  1445. switch (msg)
  1446. {
  1447. // GLFW doesn't allow to distinguish Mouse vs TouchScreen vs Pen.
  1448. // Add support for Win32 (based on imgui_impl_win32), because we rely on _TouchScreen info to trickle inputs differently.
  1449. case WM_MOUSEMOVE: case WM_NCMOUSEMOVE:
  1450. case WM_LBUTTONDOWN: case WM_LBUTTONDBLCLK: case WM_LBUTTONUP:
  1451. case WM_RBUTTONDOWN: case WM_RBUTTONDBLCLK: case WM_RBUTTONUP:
  1452. case WM_MBUTTONDOWN: case WM_MBUTTONDBLCLK: case WM_MBUTTONUP:
  1453. case WM_XBUTTONDOWN: case WM_XBUTTONDBLCLK: case WM_XBUTTONUP:
  1454. io.AddMouseSourceEvent(GetMouseSourceFromMessageExtraInfo());
  1455. break;
  1456. // We have submitted https://github.com/glfw/glfw/pull/1568 to allow GLFW to support "transparent inputs".
  1457. // In the meanwhile we implement custom per-platform workarounds here (FIXME-VIEWPORT: Implement same work-around for Linux/OSX!)
  1458. #if !GLFW_HAS_MOUSE_PASSTHROUGH && GLFW_HAS_WINDOW_HOVERED
  1459. case WM_NCHITTEST:
  1460. {
  1461. // Let mouse pass-through the window. This will allow the backend to call io.AddMouseViewportEvent() properly (which is OPTIONAL).
  1462. // The ImGuiViewportFlags_NoInputs flag is set while dragging a viewport, as want to detect the window behind the one we are dragging.
  1463. // If you cannot easily access those viewport flags from your windowing/event code: you may manually synchronize its state e.g. in
  1464. // your main loop after calling UpdatePlatformWindows(). Iterate all viewports/platform windows and pass the flag to your windowing system.
  1465. if (viewport && (viewport->Flags & ImGuiViewportFlags_NoInputs))
  1466. return HTTRANSPARENT;
  1467. break;
  1468. }
  1469. #endif
  1470. default: break;
  1471. }
  1472. return ::CallWindowProcW(prev_wndproc, hWnd, msg, wParam, lParam);
  1473. }
  1474. #endif // #ifdef _WIN32
  1475. //-----------------------------------------------------------------------------
  1476. #if defined(__clang__)
  1477. #pragma clang diagnostic pop
  1478. #endif
  1479. #endif // #ifndef IMGUI_DISABLE