Add support for setting the window frame color #15441

zadjii-msft · 2023-05-25T17:57:10Z

Summary of the Pull Request

Add support for $theme.window.frame, .unfocusedFrame, and .rainbowFrame. The first two accept a ThemeColor to set the window frame, using DwmSetWindowAttribute with DWMWA_BORDER_COLOR. rainbowFrame accepts a bool. When enabled, it'll cycle the color of the frame through all the hues, ala this gif (but, constantly, instead of just when the window moves).

This only works on Windows 11.

Validation Steps Performed

Works on Windows 11
Doesn't explode on Windows 10

PR Checklist

Closes Rainbow Frame #12950
See also Add comprehensive XAML "theming" functionality #3327
Schema updated (if necessary)

other details

There's probably some impact to perf with rainbowFrame. It's one DispatcherTimer per window. That could probably be optimized somehow to like, one per process, but meh?

some sample json for copypasta

{
    "name": "Accent Titlebar",
    "tab":
    {
        "background": "terminalBackground",
        "unfocusedBackground": "#00000000",
        "showCloseButton": "hover"
    },
    "tabRow":
    {
        "background": "accent"
    },
    "window":
    {
        "applicationTheme": "system",
        "frame": "accent",
        // "frame": "terminalBackground",
        "unfocusedFrame": "#ff0000",
        // "unfocusedFrame": null,
        "rainbowFrame": true
    }
},

lhecker · 2023-05-25T19:04:13Z

doc/cascadia/profiles.schema.json

@@ -1813,6 +1813,19 @@
          "description": "True if the Terminal should use a Mica backdrop for the window. This will apply underneath all controls (including the terminal panes and the titlebar)",
          "type": "boolean",
          "default": false
+        },
+        "rainbowFrame": {


I think we should mark it as experimental. so we declare it as "no strings attached"-kinda support. Should we really put this into 1.18?

lhecker · 2023-05-25T19:07:56Z

src/cascadia/TerminalApp/TerminalPage.cpp

+            }
+            return nullptr;
+        };
+        const auto terminalBrush = getTerminalBrush();


I was about to comment asking why this lambda is needed, when you can also just do this:

Brush terminalBrush{ nullptr }; if (const auto& control{ _GetActiveControl() }) { terminalBrush = control.BackgroundBrush(); } else if (auto settingsTab = _GetFocusedTab().try_as<TerminalApp::SettingsTab>()) { terminalBrush = settingsTab.Content().try_as<Settings::Editor::MainPage>().BackgroundBrush(); }

but then I realized the code only moved. Still, you could consider making this change since it got changed anyways.

lhecker · 2023-05-25T19:08:37Z

src/cascadia/TerminalApp/TerminalWindow.h

+        winrt::Windows::UI::Xaml::Media::Brush TitlebarBrush() { return _root ? _root->TitlebarBrush() : nullptr; }
+        winrt::Windows::UI::Xaml::Media::Brush FrameBrush() { return _root ? _root->FrameBrush() : nullptr; }


This should probably be moved into the .cpp file.

lhecker · 2023-05-25T19:16:42Z

src/cascadia/WindowsTerminal/AppHost.cpp

+
+// Method Description:
+// - Updates the color of the window frame to cycle through all the colors. This
+//   is called as the `_frameTimer` Tick callback, roughly 60 times per second.


BTW This is one of the things we should probably put into the renderer and not the UI parts. Over RDP it'll run too fast (<= 30Hz) and on modern PCs too slow (>= 120Hz). It's similar to our scrollbar updates, etc.

lhecker · 2023-05-25T19:22:58Z

src/cascadia/WindowsTerminal/AppHost.cpp

+    // Don't log this one. If it failed, chances are so will the next one, and
+    // we really don't want to just log 60x/s


It does log the error though!

Ah, wrote that comment before making _frameColorHelper

lhecker · 2023-05-25T19:28:11Z

src/cascadia/WindowsTerminal/AppHost.cpp

+    // - Set the frame's color to that RGB color.
+    const auto now = std::chrono::high_resolution_clock::now();
+    const std::chrono::duration<float> delta{ now - _started };
+    const auto millis = delta.count() / 4; // divide by four, to make the effect slower. Otherwise it flashes way to fast.


I think this should say seconds. It might be better to do the division below where the fmod_1 is.

If I put the division after the modf, then it only loops through the first 25% of the hues

Oh what I meant is something like:

float unused; const seconds = std::chrono::duration<float>(now - _started).count(); const auto hue = std::modf(seconds / 4.0f, &unused); const auto color = hueToRGB(hue);

BTW technically, when you use the generic overloads of the math functions you always have to prefix them with std:: (modf is for double; modff is for float). The C header does not have such generic overloads and the MSVC CRT just happens to define them.

lhecker · 2023-05-25T19:35:27Z

src/cascadia/WindowsTerminal/AppHost.cpp

+    const std::chrono::duration<float> delta{ now - _started };
+    const auto millis = delta.count() / 4; // divide by four, to make the effect slower. Otherwise it flashes way to fast.
+
+    const auto color = hueToRGB(fmod_1(millis));


You can also use modf here.

…america-number-1

HotCakeX · 2023-09-28T09:35:38Z

I love this!

zadjii-msft added 4 commits May 25, 2023 09:09

This almost all works. The new tab button is a little wack though

f1ed087

this works right, needs better comments

7ac1bc9

comments et al

bed8f94

less spew

e581f75

microsoft-github-policy-service bot added Issue-Task It's a feature request, but it doesn't really need a major design. Area-Theming Anything related to the theming of elements of the window Product-Terminal The new Windows Terminal. labels May 25, 2023

mmk

c90bff2

zadjii-msft added this to To Cherry Pick in 1.18 Servicing Pipeline via automation May 25, 2023

lhecker reviewed May 25, 2023

View reviewed changes

zadjii-msft added 2 commits May 26, 2023 05:22

Merge remote-tracking branch 'origin/main' into dev/migrie/f/captain-…

dfd73e0

…america-number-1

pr nits

425c0d7

lhecker approved these changes May 26, 2023

View reviewed changes

carlos-zamora approved these changes Jun 6, 2023

View reviewed changes

carlos-zamora removed this from To Cherry Pick in 1.18 Servicing Pipeline Jun 6, 2023

carlos-zamora merged commit 8f83322 into main Jun 6, 2023
15 checks passed

carlos-zamora deleted the dev/migrie/f/captain-america-number-1 branch June 6, 2023 23:17

zadjii-msft mentioned this pull request Sep 19, 2023

White borders are back in 1.17 #14744

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for setting the window frame color #15441

Add support for setting the window frame color #15441

zadjii-msft commented May 25, 2023

lhecker May 25, 2023

lhecker May 25, 2023

lhecker May 25, 2023

lhecker May 25, 2023

lhecker May 25, 2023

zadjii-msft May 26, 2023

lhecker May 25, 2023

zadjii-msft May 26, 2023

lhecker May 26, 2023

lhecker May 25, 2023

HotCakeX commented Sep 28, 2023

		winrt::Windows::UI::Xaml::Media::Brush TitlebarBrush() { return _root ? _root->TitlebarBrush() : nullptr; }
		winrt::Windows::UI::Xaml::Media::Brush FrameBrush() { return _root ? _root->FrameBrush() : nullptr; }

		// Don't log this one. If it failed, chances are so will the next one, and
		// we really don't want to just log 60x/s

Add support for setting the window frame color #15441

Add support for setting the window frame color #15441

Conversation

zadjii-msft commented May 25, 2023

Summary of the Pull Request

Validation Steps Performed

PR Checklist

other details

some sample json for copypasta

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

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

HotCakeX commented Sep 28, 2023