Skip to content

Commit

Permalink
Opacity docs (#416)
Browse files Browse the repository at this point in the history
  • Loading branch information
zadjii-msft committed Oct 8, 2021
1 parent db6094f commit 794eee6
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 14 deletions.
35 changes: 22 additions & 13 deletions TerminalDocs/customize-settings/profile-appearance.md
Expand Up @@ -294,46 +294,55 @@ This sets the transparency of the background image.

___

## Acrylic
## Transparency

### Enable acrylic
### Opacity

:::row:::
:::column span="":::
When this is set to `true`, the window will have an acrylic background. When it's set to `false`, the window will have a plain, untextured background. The transparency only applies to focused windows due to OS limitations.

**Property name:** `useAcrylic`
This sets the transparency of the window for the profile. This accepts an integer value from 0-100, representing a "percent opaque". `100` is "fully opaque", `50` is semi-transparent, and `0` is fully transparent.

When `useAcrylic` is set to `true`, the window will use Acrylic to create a blurred background for the Terminal. When `useAcrylic` is set to false, the Terminal will use a unblurred opacity.

**Property name:** `opacity`

**Necessity:** Optional

**Accepts:** `true`, `false`
**Accepts:** Number as a integer value from 0-100

**Default value:** `false`
**Default value:** `100` when `useAcrylic` is false, `50` when `useAcrylic` is true.

:::column-end:::
:::column span="":::
![Windows Terminal acrylic](./../images/acrylic.gif)
![Windows Terminal acrylic opacity](./../images/acrylic-opacity.gif)

:::column-end:::
:::row-end:::

### Acrylic opacity
> [!IMPORTANT]
> Prior to Windows Terminal version 1.12, this setting was `acrylicOpacity`, was a float that accepted 0.0-1.0 which defaulted to 0.5, and the opacity would only apply if `useAcrylic` was set to true. On 1.12+, `acrylicOpacity` will gracefully continue to work as the equivalent `opacity` value.
> [!IMPORTANT]
> Unblurred opacity (`"useAcrylic": false`) only works on Windows 11 or above.
### Enable acrylic

:::row:::
:::column span="":::
When `useAcrylic` is set to `true`, this sets the transparency of the window for the profile. This accepts floating point values from 0-1.
When this is set to `true`, the window will have an acrylic background. When it's set to `false`, the window will have a plain, untextured background. The transparency only applies to focused windows due to OS limitations.

**Property name:** `acrylicOpacity`
**Property name:** `useAcrylic`

**Necessity:** Optional

**Accepts:** Number as a floating point value from 0-1
**Accepts:** `true`, `false`

**Default value:** `0.5`
**Default value:** `false`

:::column-end:::
:::column span="":::
![Windows Terminal acrylic opacity](./../images/acrylic-opacity.gif)
![Windows Terminal acrylic](./../images/acrylic.gif)

:::column-end:::
:::row-end:::
Expand Down
5 changes: 4 additions & 1 deletion TerminalDocs/tips-and-tricks.md
Expand Up @@ -38,7 +38,10 @@ You can zoom the text window of Windows Terminal (making the text size larger or

### Adjust background opacity with the mouse

You can adjust the opacity of the background by holding <kbd>ctrl+shift</kbd> and scrolling. The opacity will persist for that terminal session. If you want to change your acrylic opacity for a profile, you can learn more about acrylic background effects on the [Profile - Appearance page](./customize-settings/profile-appearance.md#acrylic).
You can adjust the opacity of the background by holding <kbd>ctrl+shift</kbd> and scrolling. The opacity will persist for that terminal session. If you want to change your acrylic opacity for a profile, you can learn more about acrylic background effects on the [Profile - Appearance page](./customize-settings/profile-appearance.md#opacity).

> [!NOTE]
> In [Windows Terminal Preview](https://aka.ms/terminal-preview) version 1.12, changing the background opacity with the mouse wheel will use vintage-style opacity by default, unless `useAcrylic` is set to true in your settings. Prior to 1.12, the Terminal would always use acrylic for transparency.
### Open a hyperlink

Expand Down

0 comments on commit 794eee6

Please sign in to comment.