AtlasEngine: Make Direct2D/3D and Present1 configurable #16939
Conversation
|
This is what the Rendering page now looks like: |
lhecker
added
Issue-Bug
| @@ -397,8 +397,6 @@ namespace winrt::Microsoft::Terminal::Control::implementation | |||
| // GH#11315: Always do this, even if they don't have acrylic on. | |||
| _renderEngine->EnableTransparentBackground(_isBackgroundTransparent()); | |||
|
|
|||
| THROW_IF_FAILED(_renderEngine->Enable()); | |||
There was a problem hiding this comment.
It wasn't implemented by AtlasEngine! It initializes itself lazily.
| @@ -9,7 +9,6 @@ | |||
| <Import Project="..\common.openconsole.props" Condition="'$(OpenConsoleDir)'==''" /> | |||
|
|
|||
| <PropertyGroup Label="Globals"> | |||
| <CppWinRTHeapEnforcement>AnyValueHereWillDisableTheOptOut</CppWinRTHeapEnforcement> | |||
There was a problem hiding this comment.
Oh I wanted to commit this in a separate PR but forgot to split it off first.
I believe we added this to work around a bug in the XAML compiler (no surprises there I'm sure) because it used std::shared_ptr instead of winrt::com_ptr on a WinRT object. This bug seems to have been fixed a while ago so there doesn't seem to be any reason for us to still opt out of these safety checks.
| } | ||
| } | ||
| else | ||
|
|
||
| auto hr = _p.swapChain.swapChain->Present1(1, 0, ¶ms); |
There was a problem hiding this comment.
so wait, how does this disable present1?
There was a problem hiding this comment.
By leaving params.DirtyRectsCount at 0. That way the Present1 call is identical to a Present call. In fact calling Present nowadays simply calls Present1 with an empty DXGI_PRESENT_PARAMETERS.
Co-authored-by: Dustin L. Howett <[email protected]>
|
|
| X(bool, ForceFullRepaintRendering, "experimental.rendering.forceFullRepaint", false) \ | ||
| X(bool, SoftwareRendering, "experimental.rendering.software", false) \ | ||
| X(winrt::Microsoft::Terminal::Control::GraphicsAPI, GraphicsAPI, "rendering.graphicsAPI") \ | ||
| X(bool, DisablePartialInvalidation, "rendering.disablePartialInvalidation", false) \ |
There was a problem hiding this comment.
meh, IMO "forceFullRepaint" kinda sounded more straightforward IMO, but since it's in the SUI, i'm not sure it really matters
There was a problem hiding this comment.
"Partial invalidation" is a more common technical term for Present1 and so I felt it's more fitting. Another one is "dirty rectangles", i.e. disableDirtyRectangles but I wasn't sure whether that's better.
| { | ||
| // These experimental options should be removed from the settings file if they're at their default value. |
There was a problem hiding this comment.
this is actually... really clever
| @@ -24,8 +24,9 @@ Author(s): | |||
| X(hstring, WordDelimiters, "wordDelimiters", DEFAULT_WORD_DELIMITERS) \ | |||
| X(bool, CopyOnSelect, "copyOnSelect", false) \ | |||
| X(bool, FocusFollowMouse, "focusFollowMouse", false) \ | |||
| X(bool, ForceFullRepaintRendering, "experimental.rendering.forceFullRepaint", false) \ | |||
| X(bool, SoftwareRendering, "experimental.rendering.software", false) \ | |||
There was a problem hiding this comment.
i think there are some folks that were using these in the past. Should we be migrating them to the roughly equivalent new settings?
There was a problem hiding this comment.
People who have been using ForceFullRepaintRendering likely have been doing something wrong or accidentally clicked it. SoftwareRendering did have its uses, but I believe that everyone who used it should try the new AtlasEngine again or migrate to using Direct2D. The exact choice here depends on their exact issues.
|
|
||
| [[nodiscard]] std::wstring_view AtlasEngine::GetPixelShaderPath() noexcept | ||
| { | ||
| return _api.s->misc->customPixelShaderPath; | ||
| } | ||
|
|
||
| [[nodiscard]] std::wstring_view AtlasEngine::GetPixelShaderImagePath() noexcept |
There was a problem hiding this comment.
Did this just entirely disappear?
There was a problem hiding this comment.
oh I see, it did. But no one was using it. gotcha.
There was a problem hiding this comment.
Yup there's another one, related to DPI, which was used but only in a single place so I just inlined it there.
This implements
SetForceFullRepaintRenderingand adds a newSetGraphicsAPIfunction. The former togglesPresent1on and offand the latter allows users to explicitly request Direct2D/3D.
On top of these changes I did a minor cleanup of the interface,
because now that DxRenderer is gone we don't need all that anymore.
Closes #14254
Closes #16747
Validation Steps Performed