Enable Vintage Opacity #11180

zadjii-msft · 2021-09-08T21:07:36Z

Summary of the Pull Request

Adds support for vintage style opacity, on Windows 11+. The API we're using for this exists since the time immemorial, but there's a bug in XAML Islands that prevents it from working right until Windows 11 (which we're working on backporting).

Replaces the acrylicOpacity setting with opacity, which is a uint between 0 and 100 (inclusive), default to 100.

useAcrylic now controls whether acrylic is used or not. Setting an opacity < 100 with "useAcrylic": false will use vintage style opacity.

Mouse wheeling adjusts opacity. Whether acrylic is used or not is dependent upon useAcrylic.

opacity will stealthily default to 50 if useAcrylic:true is set.

PR Checklist

Closes Feature Request: Standard Opacity options like the traditional console. #603
I work here
Tests added/passed
Opacity docs MicrosoftDocs/terminal#416

Detailed Description of the Pull Request / Additional comments

Opacity was moved to AppearanceConfig. In the future, I have a mind to allow unfocused acrylic, so that'll be important then.

Validation Steps Performed

just look at it

This reverts commit cb4f58d.

DHowett

21/29

src/cascadia/WindowsTerminal/WindowsTerminal.vcxproj

src/cascadia/WindowsTerminal/IslandWindow.cpp

src/cascadia/TerminalSettingsModel/TerminalSettingsSerializationHelpers.h

src/cascadia/TerminalSettingsModel/TerminalSettings.h

wasker · 2021-09-09T22:19:25Z

src/cascadia/TerminalApp/TabManagement.cpp

@@ -84,7 +84,7 @@ namespace winrt::TerminalApp::implementation
            TraceLoggingBool(usedManualProfile, "ProfileSpecified", "Whether the new tab specified a profile explicitly"),
            TraceLoggingGuid(profile.Guid(), "ProfileGuid", "The GUID of the profile spawned in the new tab"),
            TraceLoggingBool(settings.DefaultSettings().UseAcrylic(), "UseAcrylic", "The acrylic preference from the settings"),
-            TraceLoggingFloat64(settings.DefaultSettings().TintOpacity(), "TintOpacity", "Opacity preference from the settings"),
+            TraceLoggingFloat64(settings.DefaultSettings().Opacity(), "TintOpacity", "Opacity preference from the settings"),


"TintOpacity" -> "Opacity"?

carlos-zamora

👍👍

DHowett · 2021-09-20T18:25:43Z

src/cascadia/WindowsTerminal/NonClientIslandWindow.cpp

@@ -685,9 +685,18 @@ SIZE NonClientIslandWindow::GetTotalNonClientExclusiveSize(UINT dpi) const noexc
 // - the HRESULT returned by DwmExtendFrameIntoClientArea.
 void NonClientIslandWindow::_UpdateFrameMargins() const noexcept
 {
-    MARGINS margins = {};
+    MARGINS margins = { 0, 0, 0, 0 };


This part didn't seem necessary 🤔

DHowett · 2021-09-20T18:26:06Z

src/cascadia/WindowsTerminal/NonClientIslandWindow.cpp

@@ -896,6 +905,10 @@ void NonClientIslandWindow::_SetIsBorderless(const bool borderlessEnabled)
        _titlebar.Visibility(_IsTitlebarVisible() ? Visibility::Visible : Visibility::Collapsed);
    }

+    // Update the margins when entering/leaving focus mode, so we can prevent
+    // the titlebar from showing through transparent terminal controls
+    _UpdateFrameMargins();


fwiw the titlebar now appears behind all terminals on resize

not just fomo

Yea. Couldn't find a way to suppress that. Before the island would paint on top of where the win32 titlebar is, so it wouldn't be visible. Now the island is transparent, so there's nothing to obscure the titlebar.

We could maybe paint the region that's between the side of the window and the island with some color, then paint over it with BLACK_BRUSH once the island resizes, but I'm not sure if that'll work, or if we get the right paint messages to enable that.

DHowett · 2021-09-20T18:26:09Z

src/cascadia/WindowsTerminal/NonClientIslandWindow.cpp

@@ -896,6 +905,10 @@ void NonClientIslandWindow::_SetIsBorderless(const bool borderlessEnabled)
        _titlebar.Visibility(_IsTitlebarVisible() ? Visibility::Visible : Visibility::Collapsed);
    }

+    // Update the margins when entering/leaving focus mode, so we can prevent
+    // the titlebar from showing through transparent terminal controls
+    _UpdateFrameMargins();


not just fomo

DHowett · 2021-09-20T18:27:29Z

src/cascadia/TerminalControl/ControlCore.cpp

-                if (newOpacity >= 1.0)
-                {
-                    _settings.UseAcrylic(false);
-                }


We're putting a lot of trust in the platform that it will "do the right thing" when acrylic is enabled and set to 1.0.

DHowett · 2021-09-20T18:28:02Z

src/cascadia/TerminalControl/ControlCore.cpp

-        }
-        else if (adjustment < 0)
-        {
-            _settings.UseAcrylic(true);


If I had to guess, this is part of what breaks the "go from solid to acrylic" wheel action on Windows 10. ☹️

Oooof. Might need to add this back to fix #11285, to make sure that we have some acrylic on win10. Gross.

) This logic was seemingly redundant. There's two cases I'm looking at here: #### Case 1 ```jsonc "defaults": { "opacity": 35 }, "list": [ { "commandline": "cmd.exe", "name": "Command Prompt" }, ``` In this case, we wouldn't set the `TerminalSettings` Opacity to .35, we'd set it to 1.0, because the profile didn't have an `opactity`. #### Case 2 ```jsonc "defaults": { "useAcrylic": true }, "list": [ { "commandline": "cmd.exe", "name": "Command Prompt" }, ``` In this case we still want to have an acrylic effect. Previously, we'd default this effect to 50% opaque. I'm not sure that we can actually get that anymore. BUT it turns out, we _can_ have 100% opacity and HostBackdropAcrylic. It is very subtle, but is maybe something we should be allowing anyways. It kinda looks like: ![image](https://user-images.githubusercontent.com/18356694/135168469-35d1f55b-58d1-4ee3-a717-76000c2574b9.png) * [x] Fixes #11355 * [x] Regressed in #11180 * [x] I work here

Missed this in #11180. I forgot to init the BG opacity with the renderer on startup, because that matters when you have `"antialiasingMode": "cleartype",`. Repro json ```json { "commandline": "cmd.exe", "guid": "{0caa0dad-35be-5f56-a8ff-afceeeaa6101}", "hidden": false, "opacity": 35, "antialiasingMode": "cleartype", "padding": "0", "name": "Command Prompt" }, ``` * [x] Fixes #11315

In #11180 we made `opacity` independent from `useAcrylic`. We also changed the mouse wheel behavior to only change opacity, and not mess with acrylic. However, on Windows 10, vintage opacity doesn't work at all. So there, we still need to manually enable acrylic when the user requests opacity. * [x] Closes #11285

Missed this in #11180. I forgot to init the BG opacity with the renderer on startup, because that matters when you have `"antialiasingMode": "cleartype",`. Repro json ```json { "commandline": "cmd.exe", "guid": "{0caa0dad-35be-5f56-a8ff-afceeeaa6101}", "hidden": false, "opacity": 35, "antialiasingMode": "cleartype", "padding": "0", "name": "Command Prompt" }, ``` * [x] Fixes #11315

jthoward64 · 2021-10-05T03:23:06Z

So to be clear there are currently no plans to backport this to windows 10? Or is it just waiting for XAML Islands?

zadjii-msft · 2021-10-05T10:03:55Z

So to be clear there are currently no plans to backport this to windows 10? Or is it just waiting for XAML Islands?

To be totally correct:

The API we're using works perfectly well in Windows 10, except in XAML Islands
We're working with the OS team to try and get the fix to XAML Islands backported to Windows 10
We'll likely only be able to service that fix to 10.0.19041.0, see Terminal 1.13+ requires Windows 20H1 or greater #11371

In #11180 we made `opacity` independent from `useAcrylic`. We also changed the mouse wheel behavior to only change opacity, and not mess with acrylic. However, on Windows 10, vintage opacity doesn't work at all. So there, we still need to manually enable acrylic when the user requests opacity. * [x] Closes #11285 SUI changes in action: ![auto-acrylic-win10](https://user-images.githubusercontent.com/18356694/136281935-db9a10f4-e0ad-4422-950b-0a01dc3e12c0.gif)

ghost · 2021-10-20T17:07:22Z

🎉Windows Terminal Preview v1.12.2922.0 has been released which incorporates this pull request.:tada:

Handy links:

This reverts #11372 and #11285, and brings #11180 to everyone, now that MSFT:37879806 has been serviced to everyone in [KB5011831](https://support.microsoft.com/en-gb/topic/april-25-2022-kb5011831-os-builds-19042-1682-19043-1682-and-19044-1682-preview-fe4ff411-d25a-4185-aabb-8bc66e9dbb6c)[1]. I tested this on my home Win10 laptop that's super old and doesn't have a functioning clock, but it does have that update at the very least. I don't think we had an issue tracking this? [1]: I'm pretty sure about this at least

This reverts #11372 and #11285, and brings #11180 to everyone, now that MSFT:37879806 has been serviced to everyone in [KB5011831](https://support.microsoft.com/en-gb/topic/april-25-2022-kb5011831-os-builds-19042-1682-19043-1682-and-19044-1682-preview-fe4ff411-d25a-4185-aabb-8bc66e9dbb6c)[1]. I tested this on my home Win10 laptop that's super old and doesn't have a functioning clock, but it does have that update at the very least. I don't think we had an issue tracking this? [1]: I'm pretty sure about this at least (cherry picked from commit a5c5b8a) Service-Card-Id: 87176746 Service-Version: 1.16

This reverts #11372 and #11285, and brings #11180 to everyone, now that MSFT:37879806 has been serviced to everyone in [KB5011831](https://support.microsoft.com/en-gb/topic/april-25-2022-kb5011831-os-builds-19042-1682-19043-1682-and-19044-1682-preview-fe4ff411-d25a-4185-aabb-8bc66e9dbb6c)[1]. I tested this on my home Win10 laptop that's super old and doesn't have a functioning clock, but it does have that update at the very least. I don't think we had an issue tracking this? [1]: I'm pretty sure about this at least (cherry picked from commit a5c5b8a) Service-Card-Id: 87176745 Service-Version: 1.15

zadjii-msft added 18 commits August 26, 2021 14:58

This is what jevan told me to do, but I don't have the right SDK

40cc30a

Hey this _did_ work!

b2a217e

This did nothing honestly. Just a dead end

4ce85b7

HOLY SHIT IT WORKED

f959507

tiny cleanup

548a00b

Start working on a setting for this, which obviously doesn't work yet

fa64eed

This sorta fixes it on init. Sorta. Defaults to 50% tho?

5adb068

fix some weird windowing issues

ef91af9

fix the actual setting of this valuie

492e22d

This substantially simplifies wheeling opacity

cc91b01

fix pane animations, SUI background

dfa94c9

In retrospect, I hate doing it this way

cb4f58d

Revert "In retrospect, I hate doing it this way"

d16fa55

This reverts commit cb4f58d.

fix the percentage converter, default value

8e14c14

add back to the SUI

c5518d4

I suppose this works for the titlebar in fomo

f97efcc

update schema, actually fix the default values.

6b5d03b

bump package version

5df299c

ghost added Area-User Interface Issues pertaining to the user interface of the Console or Terminal Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. Product-Terminal The new Windows Terminal. labels Sep 8, 2021

wow one typo is a record low for me

16f5c3b

This comment has been minimized.

Sign in to view

DHowett reviewed Sep 8, 2021

View reviewed changes

zadjii-msft added 2 commits September 9, 2021 15:26

These are the PR nits

62ddb32

poop

3f90543

wasker reviewed Sep 9, 2021

View reviewed changes

This was referenced Sep 13, 2021

Investigate: AcrylicBlur always on in an inactive window #7158

Closed

Action for adjusting opacity at runtime #11205

Closed

zadjii-msft self-assigned this Sep 13, 2021

carlos-zamora approved these changes Sep 20, 2021

View reviewed changes

ghost merged commit 74f11b8 into main Sep 20, 2021

ghost deleted the dev/migrie/f/603-it-works-this-time branch September 20, 2021 17:08

DHowett reviewed Sep 20, 2021

View reviewed changes

zadjii-msft mentioned this pull request Sep 20, 2021

[1.12] Ctrl+Shift+Wheel no longer works on Windows 10 #11285

Closed

jthoward64 mentioned this pull request Sep 24, 2021

Proposal: Borderless transparent window background support in apps using WinUI microsoft/microsoft-ui-xaml#1247

Open

zadjii-msft mentioned this pull request Sep 28, 2021

Remove the fallback to 50% opacity when only useAcrylic is set #11363

Merged

3 tasks

zadjii-msft mentioned this pull request Sep 29, 2021

The titlebar is visible when using vintage opacity with a HIGH DPI display #11367

Closed

zadjii-msft mentioned this pull request Sep 29, 2021

Always init the BG opacity with the renderer #11368

Merged

1 task

zadjii-msft mentioned this pull request Sep 29, 2021

When enabling opacity on win10, automatically enable acrylic #11372

Merged

1 task

ghost mentioned this pull request Oct 20, 2021

Feature Request: Standard Opacity options like the traditional console. #603

Closed

This was referenced Oct 24, 2021

Add setting to control Acrylic "Blur" in addition to opacity #1753

Closed

switch acrylic effect to transparency when window is not focused #4413

Closed

DHowett mentioned this pull request Oct 25, 2021

Starting WT momentarily shows a black titlebar #11561

Closed

zadjii-msft mentioned this pull request Nov 11, 2021

Add support for Acrylic and Opacity in "Unfocused Appearance" #11092

Closed

j4james mentioned this pull request Dec 21, 2021

[Settings] Window transparent without applying acrylic #12014

Closed

zadjii-msft mentioned this pull request Dec 2, 2022

Enable vintage opacity on Windows 10 #14481

Merged

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable Vintage Opacity #11180

Enable Vintage Opacity #11180

zadjii-msft commented Sep 8, 2021 •

edited

This comment has been minimized.

DHowett left a comment

wasker Sep 9, 2021

carlos-zamora left a comment

DHowett Sep 20, 2021

DHowett Sep 20, 2021

DHowett Sep 20, 2021

zadjii-msft Sep 20, 2021

DHowett Sep 20, 2021

DHowett Sep 20, 2021

DHowett Sep 20, 2021

zadjii-msft Sep 20, 2021

jthoward64 commented Oct 5, 2021

zadjii-msft commented Oct 5, 2021

ghost commented Oct 20, 2021

Enable Vintage Opacity #11180

Enable Vintage Opacity #11180

Conversation

zadjii-msft commented Sep 8, 2021 • edited

Summary of the Pull Request

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

This comment has been minimized.

DHowett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlos-zamora left a 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

jthoward64 commented Oct 5, 2021

zadjii-msft commented Oct 5, 2021

ghost commented Oct 20, 2021

zadjii-msft commented Sep 8, 2021 •

edited