Add support for VK_EXT_depth_clip_control. (#5027)

* Add support for VK_EXT_depth_clip_control.

* Code review feedback

Minor formatting

Co-authored-by: gdkchan <gab.dark.100@gmail.com>

* Check .DepthClipControl to make sure the host actually supports the feature.

* Review feedback: remove Vulkan platform switch, relying on QueryHostSupportsDepthClipControl to drive the behaviour - OpenGL returns true, and any future platforms that don't support the [-1, 1] depth mode can return false for the transformation.

---------

Co-authored-by: gdkchan <gab.dark.100@gmail.com>

Directory.Packages.props

@@ -3,11 +3,11 @@
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
   </PropertyGroup>
   <ItemGroup>
-    <PackageVersion Include="Avalonia" Version="0.10.19" />
-    <PackageVersion Include="Avalonia.Controls.DataGrid" Version="0.10.19" />
-    <PackageVersion Include="Avalonia.Desktop" Version="0.10.19" />
-    <PackageVersion Include="Avalonia.Diagnostics" Version="0.10.19" />
-    <PackageVersion Include="Avalonia.Markup.Xaml.Loader" Version="0.10.19" />
+    <PackageVersion Include="Avalonia" Version="0.10.21" />
+    <PackageVersion Include="Avalonia.Controls.DataGrid" Version="0.10.21" />
+    <PackageVersion Include="Avalonia.Desktop" Version="0.10.21" />
+    <PackageVersion Include="Avalonia.Diagnostics" Version="0.10.21" />
+    <PackageVersion Include="Avalonia.Markup.Xaml.Loader" Version="0.10.21" />
     <PackageVersion Include="Avalonia.Svg" Version="0.10.18" />
     <PackageVersion Include="Avalonia.Svg.Skia" Version="0.10.18" />
     <PackageVersion Include="CommandLineParser" Version="2.9.1" />

distribution/macos/updater.sh

@@ -25,14 +25,27 @@ error_handler() {
     exit 1
 }
 
-# Wait for Ryujinx to exit
-# NOTE: in case no fds are open, lsof could be returning with a process still living.
-# We wait 1s and assume the process stopped after that
-lsof -p $APP_PID +r 1 &>/dev/null
-sleep 1
-
 trap 'error_handler ${LINENO}' ERR
 
+# Wait for Ryujinx to exit.
+# If the main process is still acitve, we wait for 1 second and check it again.
+# After the fifth time checking, this script exits with status 1.
+
+attempt=0
+while true; do
+    if lsof -p $APP_PID +r 1 &>/dev/null || ps -p "$APP_PID" &>/dev/null; then
+        if [ "$attempt" -eq 4 ]; then
+            exit 1
+        fi
+        sleep 1
+    else
+        break
+    fi
+    (( attempt++ ))
+done
+
+sleep 1
+
 # Now replace and reopen.
 rm -rf "$INSTALL_DIRECTORY"
 mv "$NEW_APP_DIRECTORY" "$INSTALL_DIRECTORY"

src/Ryujinx.Ava/AppHost.cs

@@ -270,7 +270,7 @@ namespace Ryujinx.Ava
 
                         string directory = AppDataManager.Mode switch
                         {
-                            AppDataManager.LaunchMode.Portable => Path.Combine(AppDataManager.BaseDirPath, "screenshots"),
+                            AppDataManager.LaunchMode.Portable or AppDataManager.LaunchMode.Custom => Path.Combine(AppDataManager.BaseDirPath, "screenshots"),
                             _                                  => Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyPictures), "Ryujinx")
                         };
 

src/Ryujinx.Ava/Assets/Locales/en_US.json

@@ -637,5 +637,7 @@
   "SettingsTabNetworkInterface": "Network Interface:",
   "NetworkInterfaceTooltip": "The network interface used for LAN features",
   "NetworkInterfaceDefault": "Default",
-  "PackagingShaders": "Packaging Shaders"
+  "PackagingShaders": "Packaging Shaders",
+  "AboutChangelogButton": "View Changelog on GitHub",
+  "AboutChangelogButtonTooltipMessage": "Click to open the changelog for this version in your default browser."
 }

src/Ryujinx.Ava/UI/ViewModels/MainWindowViewModel.cs

@@ -1529,6 +1529,8 @@ namespace Ryujinx.Ava.UI.ViewModels
                     double sessionTimePlayed = DateTime.UtcNow.Subtract(appMetadata.LastPlayed.Value).TotalSeconds;
                     appMetadata.TimePlayed += Math.Round(sessionTimePlayed, MidpointRounding.AwayFromZero);
                 }
+
+                appMetadata.LastPlayed = DateTime.UtcNow;
             });
         }
 

src/Ryujinx.Ava/UI/Windows/AboutWindow.axaml

@@ -72,6 +72,18 @@
                     LineHeight="12"
                     Text="{Binding Version}"
                     TextAlignment="Center" />
+                <Button
+                    Padding="5"
+                    HorizontalAlignment="Center"
+                    Background="Transparent"
+                    Click="Button_OnClick"
+                    Tag="https://github.com/Ryujinx/Ryujinx/wiki/Changelog#ryujinx-changelog">
+                    <TextBlock
+                        FontSize="10"
+                        Text="{locale:Locale AboutChangelogButton}"
+                        TextAlignment="Center"
+                        ToolTip.Tip="{locale:Locale AboutChangelogButtonTooltipMessage}" />
+                </Button>
             </StackPanel>
             <StackPanel
                 Grid.Row="2"

src/Ryujinx.Graphics.GAL/Capabilities.cs

@@ -39,6 +39,7 @@ namespace Ryujinx.Graphics.GAL
         public readonly bool SupportsViewportMask;
         public readonly bool SupportsViewportSwizzle;
         public readonly bool SupportsIndirectParameters;
+        public readonly bool SupportsDepthClipControl;
 
         public readonly uint MaximumUniformBuffersPerStage;
         public readonly uint MaximumStorageBuffersPerStage;
@@ -85,6 +86,7 @@ namespace Ryujinx.Graphics.GAL
             bool supportsViewportMask,
             bool supportsViewportSwizzle,
             bool supportsIndirectParameters,
+            bool supportsDepthClipControl,
             uint maximumUniformBuffersPerStage,
             uint maximumStorageBuffersPerStage,
             uint maximumTexturesPerStage,
@@ -127,6 +129,7 @@ namespace Ryujinx.Graphics.GAL
             SupportsViewportMask = supportsViewportMask;
             SupportsViewportSwizzle = supportsViewportSwizzle;
             SupportsIndirectParameters = supportsIndirectParameters;
+            SupportsDepthClipControl = supportsDepthClipControl;
             MaximumUniformBuffersPerStage = maximumUniformBuffersPerStage;
             MaximumStorageBuffersPerStage = maximumStorageBuffersPerStage;
             MaximumTexturesPerStage = maximumTexturesPerStage;

src/Ryujinx.Graphics.Gpu/Shader/DiskCache/DiskCacheHostStorage.cs

@@ -22,7 +22,7 @@ namespace Ryujinx.Graphics.Gpu.Shader.DiskCache
         private const ushort FileFormatVersionMajor = 1;
         private const ushort FileFormatVersionMinor = 2;
         private const uint FileFormatVersionPacked = ((uint)FileFormatVersionMajor << 16) | FileFormatVersionMinor;
-        private const uint CodeGenVersion = 5110;
+        private const uint CodeGenVersion = 5027;
 
         private const string SharedTocFileName = "shared.toc";
         private const string SharedDataFileName = "shared.data";

src/Ryujinx.Graphics.Gpu/Shader/GpuAccessorBase.cs

@@ -165,6 +165,8 @@ namespace Ryujinx.Graphics.Gpu.Shader
 
         public bool QueryHostSupportsViewportMask() => _context.Capabilities.SupportsViewportMask;
 
+        public bool QueryHostSupportsDepthClipControl() => _context.Capabilities.SupportsDepthClipControl;
+
         /// <summary>
         /// Converts a packed Maxwell texture format to the shader translator texture format.
         /// </summary>

src/Ryujinx.Graphics.OpenGL/OpenGLRenderer.cs

@@ -163,6 +163,7 @@ namespace Ryujinx.Graphics.OpenGL
                 supportsViewportMask: HwCapabilities.SupportsViewportArray2,
                 supportsViewportSwizzle: HwCapabilities.SupportsViewportSwizzle,
                 supportsIndirectParameters: HwCapabilities.SupportsIndirectParameters,
+                supportsDepthClipControl: true,
                 maximumUniformBuffersPerStage: 13, // TODO: Avoid hardcoding those limits here and get from driver?
                 maximumStorageBuffersPerStage: 16,
                 maximumTexturesPerStage: 32,

src/Ryujinx.Graphics.Shader/IGpuAccessor.cs

@@ -367,6 +367,15 @@ namespace Ryujinx.Graphics.Shader
             return true;
         }
 
+        /// <summary>
+        /// Queries whether the host supports depth clip control.
+        /// </summary>
+        /// <returns>True if the GPU and driver supports depth clip control, false otherwise</returns>
+        bool QueryHostSupportsDepthClipControl()
+        {
+            return true;
+        }
+
         /// <summary>
         /// Queries the point size from the GPU state, used when it is not explicitly set on the shader.
         /// </summary>

src/Ryujinx.Graphics.Shader/Translation/EmitterContext.cs

@@ -246,7 +246,7 @@ namespace Ryujinx.Graphics.Shader.Translation
                 this.Store(StorageKind.Output, IoVariable.Position, null, Const(1), this.FPFusedMultiplyAdd(y, yScale, negativeOne));
             }
 
-            if (Config.Options.TargetApi == TargetApi.Vulkan && Config.GpuAccessor.QueryTransformDepthMinusOneToOne())
+            if (Config.GpuAccessor.QueryTransformDepthMinusOneToOne() && !Config.GpuAccessor.QueryHostSupportsDepthClipControl())
             {
                 Operand z = this.Load(StorageKind.Output, IoVariable.Position, null, Const(2));
                 Operand w = this.Load(StorageKind.Output, IoVariable.Position, null, Const(3));
@@ -283,7 +283,7 @@ namespace Ryujinx.Graphics.Shader.Translation
                 oldYLocal = null;
             }
 
-            if (Config.Options.TargetApi == TargetApi.Vulkan && Config.GpuAccessor.QueryTransformDepthMinusOneToOne())
+            if (Config.GpuAccessor.QueryTransformDepthMinusOneToOne() && !Config.GpuAccessor.QueryHostSupportsDepthClipControl())
             {
                 oldZLocal = Local();
                 this.Copy(oldZLocal, this.Load(StorageKind.Output, IoVariable.Position, null, Const(2)));

src/Ryujinx.Graphics.Vulkan/HardwareCapabilities.cs

@@ -43,6 +43,7 @@ namespace Ryujinx.Graphics.Vulkan
         public readonly bool SupportsGeometryShader;
         public readonly bool SupportsViewportArray2;
         public readonly bool SupportsHostImportedMemory;
+        public readonly bool SupportsDepthClipControl;
         public readonly uint MinSubgroupSize;
         public readonly uint MaxSubgroupSize;
         public readonly ShaderStageFlags RequiredSubgroupSizeStages;
@@ -79,6 +80,7 @@ namespace Ryujinx.Graphics.Vulkan
             bool supportsGeometryShader,
             bool supportsViewportArray2,
             bool supportsHostImportedMemory,
+            bool supportsDepthClipControl,
             uint minSubgroupSize,
             uint maxSubgroupSize,
             ShaderStageFlags requiredSubgroupSizeStages,
@@ -114,6 +116,7 @@ namespace Ryujinx.Graphics.Vulkan
             SupportsGeometryShader = supportsGeometryShader;
             SupportsViewportArray2 = supportsViewportArray2;
             SupportsHostImportedMemory = supportsHostImportedMemory;
+            SupportsDepthClipControl = supportsDepthClipControl;
             MinSubgroupSize = minSubgroupSize;
             MaxSubgroupSize = maxSubgroupSize;
             RequiredSubgroupSizeStages = requiredSubgroupSizeStages;

src/Ryujinx.Graphics.Vulkan/PipelineBase.cs

@@ -813,8 +813,12 @@ namespace Ryujinx.Graphics.Vulkan
 
         public void SetDepthMode(DepthMode mode)
         {
-            // Currently this is emulated on the shader, because Vulkan had no support for changing the depth mode.
-            // In the future, we may want to use the VK_EXT_depth_clip_control extension to change it here.
+            bool oldMode = _newState.DepthMode;
+            _newState.DepthMode = mode == DepthMode.MinusOneToOne;
+            if (_newState.DepthMode != oldMode)
+            {
+                SignalStateChange();
+            }
         }
 
         public void SetDepthTest(DepthTestDescriptor depthTest)

src/Ryujinx.Graphics.Vulkan/PipelineState.cs

@@ -304,6 +304,12 @@ namespace Ryujinx.Graphics.Vulkan
             set => Internal.Id9 = (Internal.Id9 & 0xFFFFFFFFFFFFFFCF) | ((ulong)value << 4);
         }
 
+        public bool DepthMode
+        {
+            get => ((Internal.Id9 >> 6) & 0x1) != 0UL;
+            set => Internal.Id9 = (Internal.Id9 & 0xFFFFFFFFFFFFFFBF) | ((value ? 1UL : 0UL) << 6);
+        }
+
         public NativeArray<PipelineShaderStageCreateInfo> Stages;
         public NativeArray<PipelineShaderStageRequiredSubgroupSizeCreateInfoEXT> StageRequiredSubgroupSizes;
         public PipelineLayout PipelineLayout;
@@ -331,6 +337,7 @@ namespace Ryujinx.Graphics.Vulkan
 
             LineWidth = 1f;
             SamplesCount = 1;
+            DepthMode = true;
         }
 
         public unsafe Auto<DisposablePipeline> CreateComputePipeline(
@@ -482,6 +489,17 @@ namespace Ryujinx.Graphics.Vulkan
                     PScissors = pScissors
                 };
 
+                if (gd.Capabilities.SupportsDepthClipControl)
+                {
+                    var viewportDepthClipControlState = new PipelineViewportDepthClipControlCreateInfoEXT()
+                    {
+                        SType = StructureType.PipelineViewportDepthClipControlCreateInfoExt,
+                        NegativeOneToOne = DepthMode
+                    };
+
+                    viewportState.PNext = &viewportDepthClipControlState;
+                }
+
                 var multisampleState = new PipelineMultisampleStateCreateInfo
                 {
                     SType = StructureType.PipelineMultisampleStateCreateInfo,

src/Ryujinx.Graphics.Vulkan/VulkanInitialization.cs

@@ -41,6 +41,7 @@ namespace Ryujinx.Graphics.Vulkan
             "VK_EXT_subgroup_size_control",
             "VK_NV_geometry_shader_passthrough",
             "VK_NV_viewport_array2",
+            "VK_EXT_depth_clip_control",
             "VK_KHR_portability_subset" // As per spec, we should enable this if present.
         };
 
@@ -345,6 +346,17 @@ namespace Ryujinx.Graphics.Vulkan
                 features2.PNext = &supportedFeaturesRobustness2;
             }
 
+            PhysicalDeviceDepthClipControlFeaturesEXT supportedFeaturesDepthClipControl = new PhysicalDeviceDepthClipControlFeaturesEXT()
+            {
+                SType = StructureType.PhysicalDeviceDepthClipControlFeaturesExt,
+                PNext = features2.PNext
+            };
+
+            if (physicalDevice.IsDeviceExtensionPresent("VK_EXT_depth_clip_control"))
+            {
+                features2.PNext = &supportedFeaturesDepthClipControl;
+            }
+
             api.GetPhysicalDeviceFeatures2(physicalDevice.PhysicalDevice, &features2);
 
             var supportedFeatures = features2.Features;
@@ -507,6 +519,21 @@ namespace Ryujinx.Graphics.Vulkan
                 pExtendedFeatures = &featuresCustomBorderColor;
             }
 
+            PhysicalDeviceDepthClipControlFeaturesEXT featuresDepthClipControl;
+
+            if (physicalDevice.IsDeviceExtensionPresent("VK_EXT_depth_clip_control") &&
+                supportedFeaturesDepthClipControl.DepthClipControl)
+            {
+                featuresDepthClipControl = new PhysicalDeviceDepthClipControlFeaturesEXT()
+                {
+                    SType = StructureType.PhysicalDeviceDepthClipControlFeaturesExt,
+                    PNext = pExtendedFeatures,
+                    DepthClipControl = true
+                };
+
+                pExtendedFeatures = &featuresDepthClipControl;
+            }
+
             var enabledExtensions = _requiredExtensions.Union(_desirableExtensions.Intersect(physicalDevice.DeviceExtensions)).ToArray();
 
             IntPtr* ppEnabledExtensions = stackalloc IntPtr[enabledExtensions.Length];

src/Ryujinx.Graphics.Vulkan/VulkanRenderer.cs

@@ -216,6 +216,11 @@ namespace Ryujinx.Graphics.Vulkan
                 SType = StructureType.PhysicalDeviceCustomBorderColorFeaturesExt
             };
 
+            PhysicalDeviceDepthClipControlFeaturesEXT featuresDepthClipControl = new PhysicalDeviceDepthClipControlFeaturesEXT()
+            {
+                SType = StructureType.PhysicalDeviceDepthClipControlFeaturesExt
+            };
+
             PhysicalDevicePortabilitySubsetFeaturesKHR featuresPortabilitySubset = new PhysicalDevicePortabilitySubsetFeaturesKHR()
             {
                 SType = StructureType.PhysicalDevicePortabilitySubsetFeaturesKhr
@@ -244,6 +249,14 @@ namespace Ryujinx.Graphics.Vulkan
                 features2.PNext = &featuresCustomBorderColor;
             }
 
+            bool supportsDepthClipControl = _physicalDevice.IsDeviceExtensionPresent("VK_EXT_depth_clip_control");
+
+            if (supportsDepthClipControl)
+            {
+                featuresDepthClipControl.PNext = features2.PNext;
+                features2.PNext = &featuresDepthClipControl;
+            }
+
             bool usePortability = _physicalDevice.IsDeviceExtensionPresent("VK_KHR_portability_subset");
 
             if (usePortability)
@@ -310,6 +323,7 @@ namespace Ryujinx.Graphics.Vulkan
                 _physicalDevice.PhysicalDeviceFeatures.GeometryShader,
                 _physicalDevice.IsDeviceExtensionPresent("VK_NV_viewport_array2"),
                 _physicalDevice.IsDeviceExtensionPresent(ExtExternalMemoryHost.ExtensionName),
+                supportsDepthClipControl && featuresDepthClipControl.DepthClipControl,
                 propertiesSubgroupSizeControl.MinSubgroupSize,
                 propertiesSubgroupSizeControl.MaxSubgroupSize,
                 propertiesSubgroupSizeControl.RequiredSubgroupSizeStages,
@@ -585,6 +599,7 @@ namespace Ryujinx.Graphics.Vulkan
                 supportsViewportMask: Capabilities.SupportsViewportArray2,
                 supportsViewportSwizzle: false,
                 supportsIndirectParameters: true,
+                supportsDepthClipControl: Capabilities.SupportsDepthClipControl,
                 maximumUniformBuffersPerStage: Constants.MaxUniformBuffersPerStage,
                 maximumStorageBuffersPerStage: Constants.MaxStorageBuffersPerStage,
                 maximumTexturesPerStage: Constants.MaxTexturesPerStage,

src/Ryujinx/Ui/MainWindow.cs

@@ -1024,6 +1024,8 @@ namespace Ryujinx.Ui
                         double sessionTimePlayed = DateTime.UtcNow.Subtract(appMetadata.LastPlayed.Value).TotalSeconds;
                         appMetadata.TimePlayed += Math.Round(sessionTimePlayed, MidpointRounding.AwayFromZero);
                     }
+
+                    appMetadata.LastPlayed = DateTime.UtcNow;
                 });
             }
         }

src/Ryujinx/Ui/RendererWidgetBase.cs

@@ -381,7 +381,7 @@ namespace Ryujinx.Ui
                         string filename    = $"ryujinx_capture_{currentTime.Year}-{currentTime.Month:D2}-{currentTime.Day:D2}_{currentTime.Hour:D2}-{currentTime.Minute:D2}-{currentTime.Second:D2}.png";
                         string directory   = AppDataManager.Mode switch
                         {
-                            AppDataManager.LaunchMode.Portable => System.IO.Path.Combine(AppDataManager.BaseDirPath, "screenshots"),
+                            AppDataManager.LaunchMode.Portable or AppDataManager.LaunchMode.Custom => System.IO.Path.Combine(AppDataManager.BaseDirPath, "screenshots"),
                             _ => System.IO.Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyPictures), "Ryujinx")
                         };
 

src/Ryujinx/Ui/Windows/AboutWindow.Designer.cs

@@ -48,6 +48,8 @@ namespace Ryujinx.Ui.Windows
         private Label          _patreonNamesLabel;
         private ScrolledWindow _patreonNamesScrolled;
         private TextView       _patreonNamesText;
+        private EventBox       _changelogEventBox;
+        private Label          _changelogLinkLabel;
 
         private void InitializeComponent()
         {
@@ -148,6 +150,23 @@ namespace Ryujinx.Ui.Windows
                 Margin  = 5
             };
 
+            //
+            // _changelogEventBox
+            //
+            _changelogEventBox = new EventBox();
+            _changelogEventBox.ButtonPressEvent += ChangelogButton_Pressed;
+
+            //
+            // _changelogLinkLabel
+            //
+            _changelogLinkLabel = new Label("View Changelog on GitHub")
+            {
+                TooltipText = "Click to open the changelog for this version in your default browser.",
+                Justify = Justification.Center,
+                Attributes  = new AttrList()
+            };
+            _changelogLinkLabel.Attributes.Insert(new Pango.AttrUnderline(Underline.Single));
+
             //
             // _disclaimerLabel
             //
@@ -464,8 +483,11 @@ namespace Ryujinx.Ui.Windows
             _socialBox.Add(_discordEventBox);
             _socialBox.Add(_twitterEventBox);
 
+            _changelogEventBox.Add(_changelogLinkLabel);
+
             _leftBox.Add(_logoBox);
             _leftBox.Add(_versionLabel);
+            _leftBox.Add(_changelogEventBox);
             _leftBox.Add(_disclaimerLabel);
             _leftBox.Add(_amiiboApiLink);
             _leftBox.Add(_socialBox);

src/Ryujinx/Ui/Windows/AboutWindow.cs

@@ -76,5 +76,10 @@ namespace Ryujinx.Ui.Windows
         {
             OpenHelper.OpenUrl("https://github.com/Ryujinx/Ryujinx/graphs/contributors?type=a");
         }
+
+        private void ChangelogButton_Pressed(object sender, ButtonPressEventArgs args)
+        {
+            OpenHelper.OpenUrl("https://github.com/Ryujinx/Ryujinx/wiki/Changelog#ryujinx-changelog");
+        }
     }
 }