starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

[PR #14073] [MERGED] Added experimental.pixelShaderImagePath #29916

New Issue
Open
opened 2026-01-31 09:37:36 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:37:36 +00:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/14073
Author: @mrange
Created: 9/24/2022
Status: ✅ Merged
Merged: 3/8/2024
Merged by: @DHowett

Base: main ← Head: mrange/shader_bitmap

📝 Commits (10+)

  • 5c831b4 Fixing spelling complaints
  • 052d112 Adding git submodule to DirectX ToolKit
  • ee9cc96 Added support for loading pixes shader texture to Atlas.
  • 44a8699 Squashed commit of the following:
  • a0df463 Mike forgot to update spelling
  • 007a71f Merge remote-tracking branch 'origin/main' into mrange/shader_bitmap
  • 60a7889 move to a cgimanifest instead of submodule
  • 47fa12f Rmoving submodules is hard?
  • 0217aba spel
  • de9bb21 Merge remote-tracking branch 'origin/main' into mrange/shader_bitmap

📊 Changes

21 files changed (+250 additions, -61 deletions)

View changed files

➕ samples/PixelShaders/BackgroundImage.hlsl (+23 -0)
📝 src/cascadia/TerminalControl/ControlCore.cpp (+2 -0)
📝 src/cascadia/TerminalControl/IControlAppearance.idl (+1 -0)
📝 src/cascadia/TerminalCore/Terminal.cpp (+1 -1)
📝 src/cascadia/TerminalSettingsModel/IAppearanceConfig.idl (+1 -0)
📝 src/cascadia/TerminalSettingsModel/MTSMSettings.h (+1 -0)
📝 src/cascadia/TerminalSettingsModel/TerminalSettings.cpp (+1 -0)
📝 src/cascadia/TerminalSettingsModel/TerminalSettings.h (+1 -0)
📝 src/cascadia/inc/ControlProperties.h (+2 -1)
📝 src/renderer/atlas/AtlasEngine.api.cpp (+16 -0)
📝 src/renderer/atlas/AtlasEngine.cpp (+1 -1)
📝 src/renderer/atlas/AtlasEngine.h (+2 -0)
📝 src/renderer/atlas/Backend.h (+7 -0)
📝 src/renderer/atlas/BackendD3D.cpp (+26 -6)
📝 src/renderer/atlas/BackendD3D.h (+2 -0)
📝 src/renderer/atlas/atlas.vcxproj (+3 -2)
📝 src/renderer/atlas/common.h (+1 -0)
📝 src/renderer/atlas/pch.h (+1 -0)
➕ src/renderer/atlas/wic.cpp (+153 -0)
📝 src/renderer/atlas/wic.h (+3 -50)

...and 1 more files

📄 Description

I realize I might be one of the few developers that care about custom
shader support in terminal but I thought it's worth proposing it and see
what you think.

This is to support custom shaders with custom textures.

I was thinking of exposing the background image to the shader but that
felt complicated after looking into it.

I have tested exploratively. I think the texture loader is possible to
unit test so that is a possible improvement.

The error reporting (as with other custom pixel shader code) is not very
good. That is also an area that I could improve upon.

I do think the risk of adding this is rather low as the new code is only
executed when experimental.pixelShaderImagePath is set.

Details

Only added to the Atlas engine. Unsure if needs adding in DXEngine?

Instead I load the texture using WIC into a shader resource view. When
binding shader resources I test for presence of custom texture and bind
it to register t1.

The image loading code was found in the D3D Texture documentation.
It's a mouthful but seems rather robust.

Tested setting: "experimental.pixelShaderImagePath"

  1. Tested not specifying it.
  2. Tested setting it.
  3. Tested changing it (the changes are picked up)
  4. Tested invalid path
  5. Tested a custom shader that made use of the custom texture.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/microsoft/terminal/pull/14073 **Author:** [@mrange](https://github.com/mrange) **Created:** 9/24/2022 **Status:** ✅ Merged **Merged:** 3/8/2024 **Merged by:** [@DHowett](https://github.com/DHowett) **Base:** `main` ← **Head:** `mrange/shader_bitmap` --- ### 📝 Commits (10+) - [`5c831b4`](https://github.com/microsoft/terminal/commit/5c831b4deb85c5a7523325bbf685ebf6a3f5df42) Fixing spelling complaints - [`052d112`](https://github.com/microsoft/terminal/commit/052d11242ec0dab3b0a51cff96e88b0266349eaf) Adding git submodule to DirectX ToolKit - [`ee9cc96`](https://github.com/microsoft/terminal/commit/ee9cc96c9e1778faaa633970723a071f2aaa07b7) Added support for loading pixes shader texture to Atlas. - [`44a8699`](https://github.com/microsoft/terminal/commit/44a86995e93196edfb5123a9aecb8aa46c785a84) Squashed commit of the following: - [`a0df463`](https://github.com/microsoft/terminal/commit/a0df4638098b131fc314e9ed46188d498fd45805) Mike forgot to update spelling - [`007a71f`](https://github.com/microsoft/terminal/commit/007a71f8a40a97f12e8baf930041312aab135d81) Merge remote-tracking branch 'origin/main' into mrange/shader_bitmap - [`60a7889`](https://github.com/microsoft/terminal/commit/60a7889f772b22b83790c7bb9784a4a8070561d9) move to a cgimanifest instead of submodule - [`47fa12f`](https://github.com/microsoft/terminal/commit/47fa12f5d350c68d4b6e0f38de6783c7170c4f83) Rmoving submodules is hard? - [`0217aba`](https://github.com/microsoft/terminal/commit/0217aba8ca625cc2961d58517fc002e2577af723) spel - [`de9bb21`](https://github.com/microsoft/terminal/commit/de9bb2170bcccc798fbefb73af99f85169ef80f3) Merge remote-tracking branch 'origin/main' into mrange/shader_bitmap ### 📊 Changes **21 files changed** (+250 additions, -61 deletions) <details> <summary>View changed files</summary> ➕ `samples/PixelShaders/BackgroundImage.hlsl` (+23 -0) 📝 `src/cascadia/TerminalControl/ControlCore.cpp` (+2 -0) 📝 `src/cascadia/TerminalControl/IControlAppearance.idl` (+1 -0) 📝 `src/cascadia/TerminalCore/Terminal.cpp` (+1 -1) 📝 `src/cascadia/TerminalSettingsModel/IAppearanceConfig.idl` (+1 -0) 📝 `src/cascadia/TerminalSettingsModel/MTSMSettings.h` (+1 -0) 📝 `src/cascadia/TerminalSettingsModel/TerminalSettings.cpp` (+1 -0) 📝 `src/cascadia/TerminalSettingsModel/TerminalSettings.h` (+1 -0) 📝 `src/cascadia/inc/ControlProperties.h` (+2 -1) 📝 `src/renderer/atlas/AtlasEngine.api.cpp` (+16 -0) 📝 `src/renderer/atlas/AtlasEngine.cpp` (+1 -1) 📝 `src/renderer/atlas/AtlasEngine.h` (+2 -0) 📝 `src/renderer/atlas/Backend.h` (+7 -0) 📝 `src/renderer/atlas/BackendD3D.cpp` (+26 -6) 📝 `src/renderer/atlas/BackendD3D.h` (+2 -0) 📝 `src/renderer/atlas/atlas.vcxproj` (+3 -2) 📝 `src/renderer/atlas/common.h` (+1 -0) 📝 `src/renderer/atlas/pch.h` (+1 -0) ➕ `src/renderer/atlas/wic.cpp` (+153 -0) 📝 `src/renderer/atlas/wic.h` (+3 -50) _...and 1 more files_ </details> ### 📄 Description I realize I might be one of the few developers that care about custom shader support in terminal but I thought it's worth proposing it and see what you think. This is to support custom shaders with custom textures. I was thinking of exposing the background image to the shader but that felt complicated after looking into it. I have tested exploratively. I think the texture loader is possible to unit test so that is a possible improvement. The error reporting (as with other custom pixel shader code) is not very good. That is also an area that I could improve upon. I do think the risk of adding this is rather low as the new code is only executed when experimental.pixelShaderImagePath is set. ### Details Only added to the Atlas engine. Unsure if needs adding in DXEngine? Instead I load the texture using WIC into a shader resource view. When binding shader resources I test for presence of custom texture and bind it to register t1. The image loading code was found in [the D3D Texture documentation]. It's a mouthful but seems rather robust. Tested setting: "experimental.pixelShaderImagePath" 1. Tested not specifying it. 2. Tested setting it. 3. Tested changing it (the changes are picked up) 4. Tested invalid path 5. Tested a custom shader that made use of the custom texture. 6. [the D3D Texture documentation]: https://learn.microsoft.com/en-us/windows/win32/direct3d11/overviews-direct3d-11-resources-textures-how-to --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-31 09:37:36 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#29916
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?