Documentation for microsoft/terminal#8565

MicrosoftDocs · Dec 15, 2020 · 4dc262a · 4dc262a
1 parent 6b53c67
commit 4dc262a
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 5 deletions.
diff --git a/TerminalDocs/customize-settings/actions.md b/TerminalDocs/customize-settings/actions.md
@@ -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
 
@@ -767,18 +767,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.

diff --git a/TerminalDocs/customize-settings/profile-settings.md b/TerminalDocs/customize-settings/profile-settings.md
@@ -554,12 +554,33 @@ Controls what happens when the application emits a BEL character. When set to `"
 
 ___
 
+## 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+.
+
 ## Retro terminal effects
 
 :::row:::
 :::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