Complete macOS docking and viewport support #4821

stuartcarnie · 2021-12-22T10:47:00Z

This PR builds on the work of #2778 to provide complete docking and viewport support for macOS. This PR address the following issues:

✅ Correct viewport window focus. Borderless windows can become key windows, allowing individual viewports to be brought forward:
✅ Fix a performance / hang issue when a window is completely occluded, which resulted in nextDrawable hanging for about 1 second, causing ImGui to become unresponsive.
✅ Fix crash in Metal backend when ImDrawCmd->ElemCount == 0, which would occur when showing modal windows
✅ Correct behaviour when dragging viewports across multiple monitors
✅ Handle high-frequency, momentum mouse wheel scroll events, for a native macOS feel when flicking a trackpad or magic mouse to scroll a view:
✅ Handle monitor reconfigure events
✅ Rebased and merged on latest docking branch

stuartcarnie · 2022-01-27T22:31:21Z

@ocornut this branch is ready for review to add complete docking support to macOS. I have found it works really well and performs better than GLFW and SDL2 on macOS, maintaining 60 fps even when there are several windows opened.

rokups · 2022-01-31T09:11:57Z

backends/imgui_impl_metal.mm

 #if TARGET_OS_OSX || TARGET_OS_MACCATALYST
-    textureDescriptor.storageMode = MTLStorageModeManaged;
+    if (@available(macOS 10.15, macCatalyst 13.0, *)) {
+        if (device.hasUnifiedMemory) {


This does not build on 10.13 (Xcode 10.1). macCatalyst and hasUnifiedMemory symbols are not available.

I'll add preprocessor checks for this.

rokups · 2022-01-31T09:23:43Z

Hey, thanks for this PR! I am testing it out and i experience some issues still.

Viewport windows are moved together with main viewport window.

Drag "Hello, world!" window out of main viewport.
Drag main viewport window.
Observed: "Hello, world!" is moved by same amount as main viewport is dragged.
Expected: "Hello, world!" window should remain stationary.

Window focus does not work 100 correct.

Drag "Hello, world!" window out of main viewport.
Click "Hello, world!" window to focus it (titlebar becomes blue).
Focus a third party window like terminal or finder.
Observed: "Hello, world!" window titlebar remains blue.
Expected: "Hello, world!" window titlebar should become black.

stuartcarnie · 2022-01-31T19:56:20Z

Thanks for the feedback. I have a couple of questions.

Hey, thanks for this PR! I am testing it out and i experience some issues still.

Viewport windows are moved together with main viewport window.

Drag "Hello, world!" window out of main viewport.

Drag main viewport window.
Observed: "Hello, world!" is moved by same amount as main viewport is dragged.
Expected: "Hello, world!" window should remain stationary.

What OS version? I am not observing that behaviour on macOS 12.3 (or any version of 12 prior).

Window focus does not work 100 correct.

Drag "Hello, world!" window out of main viewport.

Click "Hello, world!" window to focus it (titlebar becomes blue).

Focus a third party window like terminal or finder.
Observed: "Hello, world!" window titlebar remains blue.
Expected: "Hello, world!" window titlebar should become black.

I think we can fix it; however, that behaviour is the same when the window is inside the viewport:

Hopefully we can send an app-focus event to ImGui to resolve it.

stuartcarnie · 2022-02-01T03:35:05Z

@rokups

Window focus does not work 100 correct.

Drag "Hello, world!" window out of main viewport.

Click "Hello, world!" window to focus it (titlebar becomes blue).

Focus a third party window like terminal or finder.
Observed: "Hello, world!" window titlebar remains blue.
Expected: "Hello, world!" window titlebar should become black.

This appears to be an ImGui issue. I have observed the same behaviour testing with GLFW and SDL docking versions. The OSX backend does send the App active / inactive events, but ImGui does not change the window title.

rokups · 2022-02-02T11:10:18Z

What OS version?

I am testing on 10.13.

This appears to be an ImGui issue.

Indeed it is! Ignore this comment then. Most important thing is backend sending these events. We will fix focus issue in the core.

rokups · 2022-04-27T15:02:28Z

examples/example_apple_metal/main.mm

    ImGui_ImplOSX_Init(self.view);

+    [NSApp activateIgnoringOtherApps:YES];


Could you describe purpose of this and other changes in this file? Few changes are needed for viewports support, what about everything else?

We shouldn't need that – it can be removed.

rokups · 2022-04-27T15:03:23Z

backends/imgui_impl_metal.mm

@@ -193,7 +361,7 @@ - (instancetype)initWithBuffer:(id<MTLBuffer>)buffer
    if ((self = [super init]))
    {
        _buffer = buffer;
-        _lastReuseTime = [NSDate date].timeIntervalSince1970;
+        _lastReuseTime = GetMachAbsoluteTimeInSeconds();


Does change to timing function fix anything, or is it just a "good practice" change?

Was just good practice, as [NSDate data].timeIntervalSince1970 is a bit slower (showed up in profiling).

rokups · 2022-04-27T15:04:06Z

backends/imgui_impl_metal.mm

@@ -295,32 +469,32 @@ - (void)makeFontTextureWithDevice:(id<MTLDevice>)device

 - (MetalBuffer *)dequeueReusableBufferOfLength:(NSUInteger)length device:(id<MTLDevice>)device
 {
-    NSTimeInterval now = [NSDate date].timeIntervalSince1970;
+    uint64_t now = GetMachAbsoluteTimeInSeconds();


Does timing function change here change any behavior?

No, as the two values are time instants, so the mathematics is the same.

rokups · 2022-04-28T07:43:27Z

Thanks for replies @stuartcarnie 🙏 Could you please point me to changes that implement these things you listed?

Fix a performance / hang issue when a window is completely occluded, which resulted in nextDrawable hanging for about 1 second, causing ImGui to become unresponsive.
Fix crash in Metal backend when ImDrawCmd->ElemCount == 0, which would occur when showing modal windows

stuartcarnie · 2022-05-01T22:20:51Z

@rokups sure thing!

Thanks for replies @stuartcarnie 🙏 Could you please point me to changes that implement these things you listed?

Fix a performance / hang issue when a window is completely occluded, which resulted in nextDrawable hanging for about 1 second, causing ImGui to become unresponsive.

https://github.com/stuartcarnie/imgui/blob/6a27fa53f06f5f8511b8fe82594aaef51c9d6646/backends/imgui_impl_metal.mm#L283-L290

Fix crash in Metal backend when ImDrawCmd->ElemCount == 0, which would occur when showing modal windows

I think this is fixed now, but here is the check:

https://github.com/stuartcarnie/imgui/blob/6a27fa53f06f5f8511b8fe82594aaef51c9d6646/backends/imgui_impl_metal.mm#L732-L733

…estamp. (#4821) + Rename ImGuiFocusObserver. Docking branch will use it for more than focus.

…Move event tracking (desktop only) to OSX backend. (#4821) Fix using NSKeyUp (#5268).

…tweaks. . (#4821, #2778)

ocornut · 2022-05-03T16:19:06Z

Merged in master d58b841, e66fc22
Merged in docking 6868d11 (+ small bits d666a1d)
All as reworked by @rokups from #4821 (which itself is based on #2778)
Thanks @metarutaiga and @stuartcarnie !

Before we close this topic #4821 could Rokups write a recap of all open questions/issues and what hasn't been merged? Some might end up in separate issues.

At minimum I know the mouse stuff hasn't been merged. I suspect ImGui::UpdateInputEvents() has a bug, in the else if (e->Type == ImGuiInputEventType_MouseWheel) block, if (trickle_fast_inputs && (mouse_wheeled || mouse_button_changed != 0)) should IHMO be changed to if (trickle_fast_inputs && (mouse_moved || mouse_button_changed != 0)) to both merge multiple wheel events and trickle wheel events after a mouse pos event.

rokups · 2022-05-04T09:07:15Z

In addition to momentum mouse change, improvement to MTLStorageModeManaged texture mode detection was also left out. Primary reason is that it used a compiler feature @available(), which wasnt guaranteed to be available on older compilers. We need to reevaluate whether we have to switch back to preprocessor defines or if our decided version constraints (no support below v10.12 Sierra) allow using these expressions. Also, from what i read in the documentation it made me doubt whether we need MTLStorageModeShared at all, considering only data exchange between GPU and CPU happens on font texture upload after rasterization and we can very well do it manually, making MTLStorageModeManaged not necessary.

stuartcarnie · 2022-05-05T00:08:40Z

@rokups MTLStorageModeManaged is probably not necessary, unless benchmarks and profiling says otherwise

ocornut · 2022-05-18T12:16:35Z

I suspect ImGui::UpdateInputEvents() has a bug, in the else if (e->Type == ImGuiInputEventType_MouseWheel) block, if (trickle_fast_inputs && (mouse_wheeled || mouse_button_changed != 0)) should IHMO be changed to if (trickle_fast_inputs && (mouse_moved || mouse_button_changed != 0)) to both merge multiple wheel events and trickle wheel events after a mouse pos event.

I pushed e346059 with this change now.

ocornut · 2022-07-06T07:17:03Z

Hello Stuart, some elements of this branch were not merged hence why we kept the PR open.

stuartcarnie · 2022-07-06T07:55:31Z

Ahh, sorry @ocornut - I have restored the branch and re-opened the PR

@ocornut

* Docking: added comments. added experimental TabItemFlagsOverrideSet to ImGuiWindowClass. (Could probably do something similar with TabBarFlagsOverrideSet+Clear for ocornut#2700 later.) * Docking: docked window honor tab and text colors by storing them. (ocornut#2771) Later to lead into ocornut#2700 and ocornut#2539 Move tab submission block above in DockNodeUpdateTabBar(), not strictly necessary for this change as is, but useful if needing to apply override for TitleBg* as we'd need a value for node->VisibleWindow earlier than currently set. * Fixed some compile warnings with Clang on Windows (ocornut#3754) * Viewports, Backends: Vulkan: handle VK_ERROR_OUT_OF_DATE_KHR when resizing secondary viewport (ocornut#3766, ocornut#3758) Cannot repro here but appears to a user on Linux. Fix may be not super solid. * Docking: on node split, update memorized DockId for currently closed windows (ocornut#3716) Amended by @ocornut with same fix in DockBuilderRemoveNodeChildNodes(). * Docking: fix gap in hit test hold when using ImGuiDockNodeFlags_PassthruCentralNode touching the edge of a viewport. (ocornut#3733) * Viewports: (breaking) removed ImGuiPlatformIO::MainViewport which is now pretty much unused and duplicate (and misleading as we will evolve the concept) Use GetMainViewport() if stuck. * Viewports: Moved in own section of imgui.h ahead of merging a small part of viewport interface to master. * Viewports: trying to treat GetMainViewport() as const. Reducing unnecessary casts of ImGuiViewportP* Metrics: readded root Drawlists node in metrics to match master. The (void*) casts are implying const-casst but currently left GetMainViewport() as returning non-const. * Viewports: (Breaking) turned GetWorkPos(), GetWorkSize() into straight fields -> WorkPos, WorkSize before exposing in master branch. * Fix for compiling imgui_internal.h without operators + made GetWorkRect() consistent with clamped WorkSize. * Misc tweaks - mostly toward minimizing diff in upcoming backport merge of a few viewport structures in master * Viewports: Fix issue inferring viewport z-order when new popups gets created. (ocornut#3734) + Metrics updates. Revert 6bc5266 Showing inferred order and missing flags in metrics. * Viewports: Setting the new (currently dummy) flags on viewports. (ocornut#3789, ocornut#1542, ocornut#3680, ocornut#3350, ocornut#3012, ocornut#2471) Amend the merging of f14042c (merge ee59d7a) * Remove redundant GetMainViewport decl in imgui.h (ocornut#3801, ocornut#3800) * Docking: Made close button enable logic consistent on dockspace. When no docked window have a close button or it is disabled on the node, the space is given to tabs. Clarified close_button_is_visible vs close_button_is_enabled behavior in DockNodeUpdateTabBar().. (ocornut#3633, ocornut#3521) Reduced alpha of disabled close button a little bit further. Removed 'EnableCloseButton' which was actually unused (can't be infered early, need ->VisibleWindow anyway, which is not == ->ActiveWindow) * Examples: DX9-DX11: Removed half-assed DPI awareness enable. Updated Docking/Viewports part of Changelog (e.g. removed bits that are now already in master, clarified some added bits) * Viewports: Fix setting of ImGuiViewportFlags_NoRendererClear. (ocornut#3213) * Internals: Add a way to request window to not process any interactions for specified number of frames. * Added missing IMGUI_API to internal docking-related structs. (ocornut#3850) * Internals: Docking: some renaming. * Internals: rename RootWindow->RootWindowDockTree, RootWindowDockStop->RootWindow. Why? So by default RootWindow matches user expectation on both branches, and RootWindowDockTree is more intentful. (Actually should reduce diff between master<>docking) * Viewports, Backend: SDL: Fix missing ImGuiBackendFlags_HasSetMousePos flag in docking branch (ok in master), GLFW: Fix application of WantSetMousePos. (ocornut#1542, ocornut#787) Shows how little this feature is used with nav (was designed for small devices and frankly may be dropped) - but the backend support itself we will make use of for other features. * Viewports, Internals: added GetViewportPlatformMonitor() will a safety net to keep code portable + simplified handling of disconnected monitor in Begin(). * ImDrawFlags: rework/revert c2d6d26 + 39432bf in a way that is closer to old version and back to opt-in but with default 0 = all corners. * Removed deprecated flag stopping compilation (ocornut#3902) * Docking: Dockspace() never draws a background. (ocornut#3924) * Docking: undocking nodes/windows covering most of the monitor max their size down to 90% to ease further manipulations. Kind of a welcome hack. * Docking: Add support for split_outer in DockContextCalcDropPosForDocking(). Misc: Add FIXME regarding behavior of some window fields. * Viewports, Backends: Vulkan: Rebuild swapchain on VK_SUBOPTIMAL_KHR. (ocornut#3881) * BeginMainMenuBar(): remove expectation that we don't know menu bar height ahead, allowing up to generalize placement in any direction (will be done in master) Amend 75de34e * Viewports: Hotfix for crash in monitor array access, caused by 4b9bc49. (ocornut#3967) * TabBar: Use mouse position instead of hardcoded +1/-1 offset when reordering tabs. Fixes tab reordering in test engine when using fast mode. # Conflicts: # imgui_widgets.cpp * TabBar: Amend previous commit. Fix tab reordering when tab bar has scrolling. Some tidying up with helpers + honor 16-bit offsets as with other tab bar features (unlikely single reorder can reach that but consistent) * Backends, Viewports: GLFW: Add a workaround for stuck keys after closing a GLFW window (ocornut#3837). * Docking: DockSpace() returns its node ID + adding branch changelog. * Docking: fix undocking from tab-bar by moving mouse horizontally, broken by d705192. * Docking: removed io.ConfigDockingWithShift option. (ocornut#2109) * Docking: fix undocking from tab-bar by moving mouse horizontally, amend 3ed07a8 + d705192. Automation system may drag e.g. right-most tab far left (and vice-versa) and one frame and our current logic would fail at it. * Fix popup positioning, broken by 84e6fe4. (ocornut#3991, ocornut#3982) * Docking: Fixed restoring of tab order within a dockspace or a split node. (tests in "docking_tab_order") * Docking: Fixed multiple simultaneously reappearing window from appearing undocked in their initial frame. * Docking: Fixed reappearing docked windows with no close button showing a tab with extraneous space for one frame. * Docking: move NavWindow to SelectedTabId application lower to leave a chance for in-between code to alter focus. + store per-node window menu button id to simplify usage. * Docking: Fix window menu button. Broken by 3f16a52 (ocornut#4043) Worked on single-frame click. * Changelog: added docking+entries from 1.72 to 1.82 to increase their visibility. * Backends: Vulkan: Fix for using IMGUI_IMPL_VULKAN_NO_PROTOTYPES (ocornut#4151, ocornut#3759, ocornut#3227) * Docking: Docking node tab bar honors ItemInnerSpacing.x before first tab. Tweak rendering and alignment of dock node menu marker. (ocornut#4130) + Fix ~0 in EndFrameDrawDimmedBackgrounds() which is obsolete way of signifying "all round corners". * Docking: Fix IsWindowAppearing() and ImGuiCond_Appearing on docked windows. (ocornut#4177, ocornut#3982, ocornut#1497, ocornut#1061) * Docking: Amend 91704b7, window->DockXXX booleans not properly cleared when window not docked. (ocornut#4177, ocornut#3982, ocornut#1497, ocornut#1061) Fix issue with freshly split windows/nodes incorrectly returning true to IsWindowAppearing(). * Docking: Fix IsWindowAppearing() unnecessarily returning true twice in a row. (ocornut#4177, ocornut#3982, ocornut#1497, ocornut#1061) + added a zealous assert. * Docking: Clicking on the right-most close button of a docking node closes all windows. (ocornut#4186) * Docking: comments (ocornut#4189) * Added PushDisabled(), PopDisabled() currently only exposed in imgui_internal.h (ocornut#211) * ImVector: added clear_delete(), clear_destruct() helpers. # Conflicts: # imgui.cpp * Nav, Drag and Drop, Docking: fixed two issues leading nav result to conflict with moving a window. (ocornut#4211, ocornut#3025) * Backends, Viewports: Vulkan: Fix the use of the incorrect fence in wait for fence. (ocornut#4208) The fence being waited upon was not the one associated with the current frame. This results in validation error detecting a reset of command buffers still in use and resetting fences while still in use. Read more details in ocornut#4208 * Metrics: Tentative fix for bad printf format. Ref b53b8f5, a7a1b3b * Viewport: extracted code out of Begin() into WindowSyncOwnedViewport() - no other change * Viewports: Fix popup/tooltip created without a parent window from being given a ParentViewportId value of the implicit/fallback window. (ocornut#4236, ocornut#2409) Amend 3ead982 * Backends: amends to 1db1066 + merge minor bits from docking incl SetActiveIdUsingNavAndKeys(). No need to clear fields before deletion. DX12: renamed to match docking branch. * Backends: Viewports: renamed viewport storage structures ImGuiViewportDataXXXX -> ImGui_ImplXXXX_ViewportData and locals (matching naming convention in 70c6038) * Docking: removed DockNodeFlagsOverrideClear flags from ImGuiWindowClass. (ocornut#2999, ocornut#3521, ocornut#3633) + extraded bits of metrics into DebugNodeDockNodeFlags() * Docking: Reworked node flags saving/inheritance... (ocornut#4292, ocornut#3834, ocornut#3633, ocornut#3521, ocornut#3492, ocornut#3335, ocornut#2999, ocornut#2648) ..so that flags enforced by docked windows via the DockNodeFlagsOverrideSet mechanism are are not left in empty dockspace nodes once the windows gets undocked. * Docking: Added ImGuiDockNodeFlags_NoDockingOverEmpty. Breaking definition of ImGuiDockNodeFlags_NoDockingOverOther which now means "non empty node". (ocornut#3492, ocornut#2648, ocornut#4292) * Docking: Fixed crash issues using DockBuilderRemoveNode() in some situations. (ocornut#3111, ocornut#3179, ocornut#3203, ocornut#4295) If the deleted root node isn't part of a dockspace with a central node, it won't be "protected" but removed when last window gets removed. * Docking: Fix crash when a dock node gets re-qualified as dockspace>floating>dockspace.. (ocornut#3203, ocornut#4295) Which tends to happen when incorrectly calling DockBuilderAddNode() without ImGuiDockNodeFlags_Dockspace and using it as a Dockspace on the next frame after the floating window hosting the node has been automatically created. * Added missing IMGUI_API to GetViewportPlatformMonitor. (ocornut#4309) * Backends: Win32, SDL, GLFW: only honor io.WantSetMousePos when focused + fix GLFW uninstalling handler + tweaks to reduce branch drift with docking. (ocornut#787, ocornut#2445, ocornut#2696, ocornut#3751, ocornut#4377) # Conflicts: # backends/imgui_impl_glfw.cpp # backends/imgui_impl_sdl.cpp # backends/imgui_impl_win32.cpp * IO: modify io.AddFocusEvent() to tolerate in/out for multi-viewports. Amend 2f40be6. (ocornut#3532) * Fix BeginDisabled(false), (ocornut#211, ocornut#4452) * Fix BeginDisabled(false), again, (ocornut#211, ocornut#4452, ocornut#4453) Version 1.84.1 (forced pushed since our earlier versioning didn't sort correctly in github web) # Conflicts: # docs/CHANGELOG.txt * Backends: GLFW: Fixed unused variable warning for empty assert macro. (ocornut#4459) * Docking: fixed settings load issue when mouse wheeling. (ocornut#4310) * Docking: fix 58f5092 (ocornut#4310) If we clear _ChildWindow flag we must remove it from here otherwise render loop will fail. * Docking: warning fix for when IM_ASSERT() is empty * Fixed bad merge of Changelog in docking branch * Internals: refactored IsWindowHovered()/IsWindowFocused() to make their logic more similar + change underlying value of ImGuiHoveredFlags_AllowWhenBlockedByPopup + comment out docking only flags. * Fixed _ChildWindows from leaking docking hierarchy. Added ImGuiFocusedFlags_DockHierarchy and ImGuiHoveredFlags_DockHierarchy. * Viewports: fixed unnecessary creation of temporary viewports when multiple docked windows got reassigned to a new node (created mid-frame) which already has a HostWindow * Viewports: Fixed a crash while a window owning its viewport disappear while being dragged. t would manifest when e.g. reconfiguring dock nodes while dragging. * Viewports: fix window with viewport ini data immediately merged into a host viewport from leaving a temporary viewport alive for a frame (would leak into backend). * Fixed IsWindowFocused/IsWindowHovered with _ChildWindows for not following through popup parents (amend 6b1e094, fix ocornut#4527) * Viewports: extracted DestroyViewport() out of UpdateViewportsNewFrame() function. * Docking: bits. * Docking: floating node with a central node hides properly when nothing is docked + rename. * Docking: Improved resizing system so that non-central zone are better at keeping their fixed size. * Nav: Fixed an issue with losing focus on docked windows when pressing Alt while keyboard navigation is disabled. (ocornut#4547, ocornut#4439) * Docking: Fixed IsItemHovered() and functions depending on it (e.g. BeginPopupContextItem()) when called after Begin() on a docked window (ocornut#3851) Fix ee643b2 * Added ImGuiFocusedFlags_NoPopupHierarchy and ImGuiHoveredFlags_NoPopupHierarchy (followup ocornut#4527) IsWindowFocused: fix flag usage (amend 6b1e094) was technically harmless because of light typing. * Docking: reinstate io.ConfigDockingWithShift option. (ocornut#4643) This more or less reverts commit 3ed07a8. * Fixed nested BeginDisabled()/EndDisabled() bug in Docking branch due to bad merge. (ocornut#4655, ocornut#4452, ocornut#4453, ocornut#4462) * Backends: Made it possible to shutdown default Platform Backends before the Renderer backends. (ocornut#4656) * Viewports: Made it possible to explicitly assign ImGuiWindowClass::ParentViewportId to 0. (ocornut#3152, ocornut#2871) * Fixed tooltip in own viewport over modal from being incorrectly dimmed. (ocornut#4729) Normally we would aim to ensure that g.Windows[] gets maintained to reflect display layer but it is presently non trivial. * Fixed crash on right-click without modal, introduced by previous commit a3667f4, (ocornut#4729) * Viewports: fix missing default per-window value for ParentViewportId due to zero-cleared in-window instance (ocornut#4756) Broken by 2080d12 * Docking: Fixed a bug undocking windows docked into a non-visible or _KeepAliveOnly dockspace. (ocornut#4757) * Docking: Fix typo (had no side effect) (ocornut#4778) Co-authored-by: Mikko Sivulainen <mikko.sivulainen@supercell.com> * Viewports: Fixed CTRL+TAB highlight outline on docked windows not always fitting in host viewport + moved EndFrameDrawDimmedBackgrounds() call + removed duplicate code in Begin() already in EndFrameDrawDimmedBackgrounds() * Docking: Fixed incorrectly rounded tab bars for dock node that are not at the top of their dock tree. * Docking: Fixed single-frame node pos/size inconsistencies when window stop or start being submitted. Fix 718e15c while preserving its intended property. Tested by "docking_window_appearing_layout". (ocornut#2109) * Docking: internals: extracted rounding corner calculation into reusable CalcRoundingFlagsForRectInRect() function. * Docking: docked windows honor ImGuiCol_WindowBg. Host window in charge of rendering seams. (ocornut#2700, ocornut#2539 + Docked windows honor display their border properly. (ocornut#2522) Plus: better support for transparent one in nodes Side effects: DockContextBindNodeToWindow doesn't alter node->IsVisible. Side effects: ImDrawList:: _ResetForNewFrame() needs to merge, sane (in case of (Amended, force-pushed) * Docking: Amend b16f738 fixed dimming of docked window + removed thin highlight around windows (never worked on docked window, not viewports friendly, hard to move to EndFrame) (ocornut#2700, ocornut#2539, ocornut#2522) * Nav, Docking: reworked modal/ctrl+tab dimming system to be entirely processed at end of the frame, which will simplify things for an upcoming commit. (Will backport some of this back to master now.) * Nav, Docking: Fix dimming on docked windows. * Nav, Docking: Fix crash on dimming docked window and DockSpaceOverViewport() with PassthruCentralNode. (amend 1dc3af3, 23ef6c1, 657073a) * Added an assertion for the common user mistake of using "" as an identifier at the root level of a window. (ocornut#1414, ocornut#2562, ocornut#2807, ocornut#4008, ocornut#4158, ocornut#4375, ocornut#4548, ocornut#4657, ocornut#4796) ocornut#4158, ocornut#4375, ocornut#4548, ocornut#4657, ocornut#4796) * Docking: prevent docking any window created above a popup/modal. (ocornut#4317) * Internals: UpdateWindowInFocusOrderList: amend a528398 to fix docking. (ocornut#3496, ocornut#4797) * Internals: reduced side-effects of setting window->HiddenFramesForRenderOnly > 0 * Viewports: Fixed a CTRL+TAB crash with viewports enabled (ocornut#4023, ocornut#787) (amend 1dc3af3, 23ef6c1, 657073a) + Expose FindHoveredViewportFromPlatformWindowStack() in imgui_internal.h * Update .gitignore * Backends: OSX: Fixed typo. * Rename io.AddKeyModEvent() -> io.AddKeyModsEvent() and updated backends accordingly. (ocornut#2625, ocornut#4858) Amend 790132a (breaking) # Conflicts: # backends/imgui_impl_glfw.cpp # backends/imgui_impl_sdl.cpp # backends/imgui_impl_win32.cpp * IO: fix SetKeyEventNativeData() not handling ImGuiKey_None the same way as AddKeyEvent(). (ocornut#4905, ocornut#4858) * Merge "Backends: SDL: Fix for Emscriptem. Amend 98ce013." + Fix bad merge from master of "is_app_focused" property (Amend 0647ba3) * Viewports: Fixed active InputText() from preventing viewports to merge. (ocornut#4212) * Viewports: Relaxed specs for backend supporting ImGuiBackendFlags_HasMouseHoveredViewport. Backends: SDL: Added support for simplified HasMouseHoveredViewport. (ocornut#1542, ocornut#4665) * IO: added AddMouseViewportEvent() + used in backends. * Docking: Fixed a CTRL+TAB crash when aiming at an empty docked window. (ocornut#4792) * Revert moving ImGuiKeyModFlags to internal.h (amendc906c65) # Conflicts: # imgui.cpp * Backends: SDL: no support for ImGuiBackendFlags_HasMouseHoveredViewport under OSX/LInux (ocornut#4960) * Docking: Fixed size constraints not working on single window holding on a dock id (still doesn't work on docked windows). * Docking: Tabs use their own identifier (in order to make window->ID refer to whole window in test engine). Also prevents Tab ID from clashing with "" which was common. * Docking: Fixed CTRL+TAB back into a docked window not selecting menu layer when no item are on main layer. Could merge on master. * Backends: SDL: Amend 08350e5, multi-viewports mouse tracking works under Linux. (ocornut#4960) + Reword tests to help static analysis. * Docking: fixed potential crash if a passthrough dock node is submitted without a child intermediate (currently not possible via API) * Internals: rework RenderMouseCursor() signature so we can use it in docking branch more naturally. (Merged from master+ rework for docking) # Conflicts: # imgui.cpp # imgui_draw.cpp * Viewports: Fixed main viewport size not matching ImDrawData::DisplaySize for one frame during resize when multi-viewports are disabled. (ocornut#4900) * Docking: Fixed floating docked nodes not being clamped into viewport workrect to stay reachable when g.ConfigWindowsMoveFromTitleBarOnly is set and multi-viewports are disabled. (ocornut#5044) * Viewports: Fixed translating a host viewport from briefly altering the size of AlwaysAutoResize windows. (ocornut#5057) * Backends: SDL: Fix multi-viewport dragging issue with SDL on some systems. (ocornut#5012) * Backends: SDL: Fix more dragging issues. SDL_CaptureMouse() is essentially broken. (ocornut#5012, ocornut#5082) master got c5f6721 which is combining f337378 and this commit. * Windows: Fixed first-time windows appearing in negative coordinates. (ocornut#5215, ocornut#3414) Regression added in 6af92b0 * Backends: OSX, Metal: Added multi-viewports support. (ocornut#4821, ocornut#2778) * Backends: OSX, Metal: Amend d111133, tidying up, remove unused, misc tweaks. . (ocornut#4821, ocornut#2778) * Backends: OSX: Implement ImGui_ImplOSX_ShowWindow(). (ocornut#5299) * Examples: Apple+OpenGL: Fix build. * Docking: Fixed moving window being interrupted when undocing a window with "io.ConfigDockingAlwaysTabBar = true". (ocornut#5324) Regression introduced in 6b77668 * Docking: Fix unhiding tab bar regression. (ocornut#5325, ocornut#5181) Broken by 9038678 * Misc: Fix custom assertion macro failing to compile imgui.cpp (ocornut#5378) * Docking: Fixed incorrect focus highlight on docking node when focusing empty central node or a child window which was manually injected into a dockspace window. * Backends: SDL+GLFW, Examples: SDL+Metal, GLFW+Metal: Fix viewport support with Metal backend. Fixes ocornut#5392 + alignment fixes and removed static_cast<> + Amended with fix. * Docking, Modal: Fixed a crash when opening popup from a parent which is being docked on the same frame. (ocornut#5401) Ideally we should untangle the purpose of parent_window_in_stack / ParentWindowInBeginStack better. * Docking: Amend 24dfebf. Fixed incorrect focus highlight on docking node with nested hierarchies. * Backends: GLFW: Fixed leftover static variable preventing from changing or reinitializing backend while application is running. (ocornut#4616, ocornut#5434) * Backends, Viewport: Metal: Pull format from shared context. (ocornut#5403, ocornut#5437) * Docking, Nav: Fixed using gamepad/keyboard navigation not being able enter menu layer (ocornut#5463, ocornut#4792) Fix 37958ca * Docking: Fix docked window contents not rendering when switching with CTRL+Tab. (regression from 8eb8689). * Internals: Docking: make DockContextFindNodeByID() more visible (instead of DockBuilderGetNode) + using defines for channel changes. * Docking: Fixed splitting/docking into a node that has buttons amended into tab bar. Windows were not moved correctly. (ocornut#5515) * Docking: Fixed amending into an existing tab bar from rendering invisible items. (ocornut#5515, amend b16f738 ocornut#2700, ocornut#2539) Commit b16f738 left us with a "current" channel 0 which seems inadequate. Undoing that, assuming default is always 1, code filling bg color does a switch. Only DockContextEndFrame() leave it at 0 and it's not particularly necessary. * Docking+Viewports: Fix undocking window node causing parent viewport to become unresponsive. (ocornut#5503) Amend 67be485, Somehow ties to 58f5092 + 0eb45a0 (ocornut#4310) Unsure of exact chain of event but this caused a parent link msimatch between the time of the MouseMoving test in AddUpdateViewport() setting _NoInputs on the wrong parent., and the release clearing _NoInputs on the rght one. * Docking: Simplify logic of moving tabs between nodes. Amends 0abe7d. (ocornut#5515) The idea is that in the absence of a tab bar, as new one gets created new tabs will be sorted based on window->DockOrder so this may work but we're not 100% sure. * Docking: Add source dock node parameter DockContextCalcDropPosForDocking() to facilitate test engine (un)docking nodes before they are split out to their own window. Metrics: Display dock_node->Windows in node metrics. * Internals: Docking: rename HoveredDockNode to DebugHoveredDockNode to clarify that it isn't usable for much other than debugging. * Nav: Fixed regression in e99c4fc preventing CTR+Tab to work without NavEnableKeyboard (ocornut#5504, ocornut#4023); * Obsoleted using SetCursorPos()/SetCursorScreenPos() to extend parent window/cell boundaries. (ocornut#5548) This incorrect pattern has been mentioned or suggested in: ocornut#4510, ocornut#3355, ocornut#1760, ocornut#1490, ocornut#4152, ocornut#150 # Conflicts: # imgui.cpp * Backends: SDL: Fixed building backend under non-OSX Apple targets (e.g. iPhone). (ocornut#5665) * Docking: Fixed incorrect focus highlight on docking node when focusing a menu. (ocornut#5702) * Backends: OpenGL: Add ability to #define IMGUI_IMPL_OPENGL_DEBUG. (ocornut#4468, ocornut#4825, ocornut#4832, ocornut#5127, ocornut#5655, ocornut#5709) # Conflicts: # backends/imgui_impl_opengl3.cpp * Update imgui_impl_vulkan.h to match martty/imgui https://github.com/martty/imgui/blob/master/examples/imgui_impl_vulkan.h * Update imgui_impl_vulkan.cpp to match martty/imgui https://github.com/martty/imgui/blob/master/examples/imgui_impl_vulkan.cpp * Viewports: Fix AddMouseViewportEvent() to honor AppAcceptingEvents, filter duplicate, add to debug log. * Docking: Fixed missing highlight when using dock node host window borders. (ocornut#5702) Amend 8f43487, 9764adc, 24dfebf * Fixed ImGuiWindowFlags_UnsavedDocument clipping label in docked windows with no close button. [changes for docking] (ocornut#5745) + TabBar: starts displaying the unsaved document marker with a frame delay to match how close button is processed, otherwise the transition would be noticeable. * Fix for Vulkan validation layer warnings Fix from: TheCherno@add065f ocornut#3957 Co-authored-by: ocornut <omarcornut@gmail.com> Co-authored-by: Sammy Fatnassi <sammyfreg@gmail.com> Co-authored-by: GamingMinds-DanielC <daniel.cremers@gamingmindsstudios.com> Co-authored-by: Adam Kewley <contact@adamkewley.com> Co-authored-by: Rokas Kupstys <rokups@zoho.com> Co-authored-by: David Maas <contact@pathogenstudios.com> Co-authored-by: CheckmateAt7 <66566308+CheckmateAt7@users.noreply.github.com> Co-authored-by: warriormaster12 <streng.alexander@gmail.com> Co-authored-by: Michel Lesoinne <michel.lesoinne@androdevllc.com> Co-authored-by: Mikko Sivulainen <mikko.sivulainen@gmail.com> Co-authored-by: Mikko Sivulainen <mikko.sivulainen@supercell.com> Co-authored-by: Dima Koltun <koltundimachamp@gmail.com> Co-authored-by: stuartcarnie <stuart.carnie@gmail.com> Co-authored-by: omar <ocornut@users.noreply.github.com> Co-authored-by: Andrej Redeky <41929176+WSSDude420@users.noreply.github.com> Co-authored-by: Runik <rtoumazet@free.fr> Co-authored-by: Stephen H. Gerstacker <stephen@gerstacker.us>

…2778)

stuartcarnie mentioned this pull request Dec 22, 2021

Implement Multi-Viewports on macOS #2778

Closed

ocornut added backends osx/ios labels Dec 22, 2021

stuartcarnie force-pushed the sgc/apple/docking branch 2 times, most recently from 9bf9fc9 to b685b62 Compare December 22, 2021 20:25

meshula mentioned this pull request Dec 23, 2021

Is there a way to resize a window? floooh/sokol#590

Open

ocornut changed the title ~~feat: complete macOS docking and viewport support~~ Complete macOS docking and viewport support Dec 27, 2021

stuartcarnie force-pushed the sgc/apple/docking branch 3 times, most recently from 284e52a to 6fee12e Compare January 5, 2022 19:38

stuartcarnie force-pushed the sgc/apple/docking branch 5 times, most recently from 2b23adf to 7330d26 Compare January 18, 2022 20:55

stuartcarnie force-pushed the sgc/apple/docking branch 3 times, most recently from 6a43383 to ab8e63e Compare January 27, 2022 20:24

stuartcarnie marked this pull request as ready for review January 27, 2022 22:30

rokups reviewed Jan 31, 2022

View reviewed changes

stuartcarnie force-pushed the sgc/apple/docking branch from ab8e63e to b50affd Compare February 1, 2022 23:37

stuartcarnie force-pushed the sgc/apple/docking branch 3 times, most recently from 093e1e8 to 933a35d Compare February 8, 2022 20:19

stuartcarnie force-pushed the sgc/apple/docking branch from 933a35d to b8fd84c Compare February 10, 2022 19:47

rokups reviewed Apr 27, 2022

View reviewed changes

ocornut pushed a commit that referenced this pull request May 3, 2022

Backends: OSX, Metal: Tweaks. Use preferred method of obtaining a tim…

d58b841

…estamp. (#4821) + Rename ImGuiFocusObserver. Docking branch will use it for more than focus.

ocornut pushed a commit that referenced this pull request May 3, 2022

Backends: OSX: Removed ImGui_ImplOSX_HandleEvent() from backend API. …

e66fc22

…Move event tracking (desktop only) to OSX backend. (#4821) Fix using NSKeyUp (#5268).

ocornut pushed a commit that referenced this pull request May 3, 2022

Backends: OSX, Metal: Added multi-viewports support. (#4821, #2778)

6868d11

ocornut added a commit that referenced this pull request May 3, 2022

Backends: OSX, Metal: Amend d111133, tidying up, remove unused, misc …

d666a1d

…tweaks. . (#4821, #2778)

ocornut mentioned this pull request May 3, 2022

Multi-Viewports #5175

Closed

ocornut added a commit that referenced this pull request May 18, 2022

IO: Fixed input queue trickling of mouse wheel events. (#4921, #4821)

e346059

ocornut mentioned this pull request Jun 13, 2022

ImGui docking branch issues with SDL2 + Metal #5392

Open

ocornut force-pushed the docking branch from cf2de07 to 101aec9 Compare June 16, 2022 11:12

stuartcarnie closed this Jul 6, 2022

stuartcarnie deleted the sgc/apple/docking branch July 6, 2022 05:23

stuartcarnie restored the sgc/apple/docking branch July 6, 2022 07:55

stuartcarnie reopened this Jul 6, 2022

ocornut mentioned this pull request Jan 3, 2023

Metal backend: secondary viewports are not rendered #6015

Closed

ocornut added a commit that referenced this pull request Jan 3, 2023

Backends: Metal: fixed secondary viewport rendering. (#6015, #4821, #…

42e1660

…2778)

ocornut mentioned this pull request Jan 3, 2023

Fixed ImGui_ImplOSX_GetWindowSize and ConvertNSRect #6009

Closed

ocornut force-pushed the docking branch from 7eaa1d3 to d822c65 Compare January 5, 2023 14:58

ocornut force-pushed the docking branch from 7f662a0 to ad44f58 Compare March 21, 2023 16:05

ocornut force-pushed the docking branch from 86af182 to adf693c Compare April 21, 2023 13:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Complete macOS docking and viewport support #4821

Complete macOS docking and viewport support #4821

stuartcarnie commented Dec 22, 2021 •

edited

Loading

stuartcarnie commented Jan 27, 2022

rokups Jan 31, 2022

stuartcarnie Jan 31, 2022

rokups commented Jan 31, 2022

stuartcarnie commented Jan 31, 2022

stuartcarnie commented Feb 1, 2022 •

edited

Loading

rokups commented Feb 2, 2022 •

edited

Loading

rokups Apr 27, 2022

stuartcarnie May 1, 2022

rokups Apr 27, 2022

stuartcarnie Apr 27, 2022

rokups Apr 27, 2022

stuartcarnie Apr 27, 2022

rokups commented Apr 28, 2022

stuartcarnie commented May 1, 2022 •

edited

Loading

ocornut commented May 3, 2022

rokups commented May 4, 2022

stuartcarnie commented May 5, 2022

ocornut commented May 18, 2022

ocornut commented Jul 6, 2022

stuartcarnie commented Jul 6, 2022

		ImGui_ImplOSX_Init(self.view);

		[NSApp activateIgnoringOtherApps:YES];

Complete macOS docking and viewport support #4821

Are you sure you want to change the base?

Complete macOS docking and viewport support #4821

Conversation

stuartcarnie commented Dec 22, 2021 • edited Loading

stuartcarnie commented Jan 27, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rokups commented Jan 31, 2022

stuartcarnie commented Jan 31, 2022

stuartcarnie commented Feb 1, 2022 • edited Loading

rokups commented Feb 2, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rokups commented Apr 28, 2022

stuartcarnie commented May 1, 2022 • edited Loading

ocornut commented May 3, 2022

rokups commented May 4, 2022

stuartcarnie commented May 5, 2022

ocornut commented May 18, 2022

ocornut commented Jul 6, 2022

stuartcarnie commented Jul 6, 2022

stuartcarnie commented Dec 22, 2021 •

edited

Loading

stuartcarnie commented Feb 1, 2022 •

edited

Loading

rokups commented Feb 2, 2022 •

edited

Loading

stuartcarnie commented May 1, 2022 •

edited

Loading