Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation for pixel shader changes #210

Merged
merged 3 commits into from
Jan 25, 2021
Merged

Documentation for pixel shader changes #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4dc262a
Documentation for microsoft/terminal#8565
zadjii-msft Dec 15, 2020
befc141
fix merge conflicts
cinnamon-msft Jan 25, 2021
7d74eb3
fix warning
cinnamon-msft Jan 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions TerminalDocs/customize-settings/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ ___
`ctrl+`, `shift+`, `alt+`

> [!NOTE]
> The `Windows` key is not supported as a modifier.
> The `Windows` key is not supported as a modifier.

### Modifier keys

Expand All @@ -136,7 +136,7 @@ ___

:::row:::
:::column span="":::
This closes the current window and all tabs within it. If `confirmCloseAllTabs` is set to `true`, a confirmation dialog will appear to ensure you'd like to close all your tabs. More information on this setting can be found on the [Global settings page](./global-settings.md#hide-close-all-tabs-popup).
This closes the current window and all tabs within it. If `confirmCloseAllTabs` is set to `true`, a confirmation dialog will appear to ensure you'd like to close all your tabs. More information on this setting can be found on the [Appearance settings page](./appearance.md#show-close-all-tabs-popup).

**Command name:** `closeWindow`

Expand Down Expand Up @@ -794,18 +794,21 @@ This resets the text size to the default value.
{ "command": "resetFontSize", "keys": "ctrl+0" }
```

### Toggle retro terminal effects
### Toggle pixel shader effects

This toggles the "retro terminal effect", which is enabled with the profile setting `experimental.retroTerminalEffect`.
This toggles any pixel shader effects enabled on the Terminal. If the user specified a valid shader with `experimental.pixelShaderPath`, this action will toggle that shader on/off. This will also toggle the "retro terminal effect", which is enabled with the profile setting `experimental.retroTerminalEffect`.

**Command name:** `toggleRetroEffect`
**Command name:** `toggleShaderEffects`

**Default binding:**

```json
{ "command": "toggleRetroEffect" }
{ "command": "toggleShaderEffects" }
```

> [!IMPORTANT]
> This action was renamed in [Windows Terminal Preview](https://aka.ms/terminal-preview) version 1.6. In previous versions, this was `toggleRetroEffect`.

### Set the color scheme

Changes the active color scheme.
Expand Down
25 changes: 25 additions & 0 deletions TerminalDocs/customize-settings/appearance-profile-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ This sets the weight (lightness or heaviness of the strokes) for the profile's f
:::column span="":::
When this is set to `true`, the terminal will emulate a classic CRT display with scan lines and blurry text edges. This is an experimental feature and its continued existence is not guaranteed.

If `experimental.pixelShaderPath` is set, it will override this setting.

**Property name:** `experimental.retroTerminalEffect`

**Necessity:** Optional
Expand Down Expand Up @@ -343,3 +345,26 @@ This sets the cursor color of the profile. This will override the `cursorColor`
**Necessity:** Optional

**Accepts:** Color as a string in hex format: `"#rgb"` or `"#rrggbb"`

<br />

___

## Pixel Shader Effects

:::row:::
:::column span="":::
This setting allows a user to specify the path to a custom pixel shader to use with the Terminal content. This is an experimental feature and its continued existence is not guaranteed. For more details on authoring custom pixel shaders for the Terminal, see [this documentation](https://github.com/microsoft/terminal/blob/main/samples/PixelShaders/README.md).

If set, this will override the `experimental.retroTerminalEffect` setting.

**Property name:** `experimental.pixelShaderPath`

**Necessity:** Optional

**Accepts:** A path to an `.hlsl` shader file, as a string.

**Default value:** `(unset)`

> [!IMPORTANT]
> This feature is only available in [Windows Terminal Preview](https://aka.ms/terminal-preview/), 1.6+.