Merge branch 'xbei/option_type' into 'main'

[REMIX-4107] Introduce layered settings save system (User, Quality, Mod) with runtime updates and config fix

See merge request lightspeedrtx/dxvk-remix-nv!1762

Author: xbei-nv

RtxOptions.md

@@ -505,6 +505,10 @@ Tables below enumerate all the options and their defaults set by RTX Remix. Note
 |rtx.opaqueMaterial.thinFilmThicknessOverride|float|0|||The thin\-film layer's thickness in nanometers for the opaque material when the thin\-film override is enabled\.<br>Should be any value larger than 0, typically within the wavelength of light, but must be less than or equal to OPAQUE\_SURFACE\_MATERIAL\_THIN\_FILM\_MAX\_THICKNESS \(\(1500\.0f\) nm\)\.<br>Should only be used for debugging or development\.|
 |rtx.opaqueOpacityTransmissionLobeSamplingProbabilityZeroThreshold|float|0.01|||The threshold for which to zero opaque opacity probability weight values\.|
 |rtx.opaqueSpecularLobeSamplingProbabilityZeroThreshold|float|0.01|||The threshold for which to zero opaque specular probability weight values\.|
+|rtx.option.optionSavingType|int|0|||Saving type of current runtime changes\.|
+|rtx.option.overwriteConfig|bool|False|||This enables overwriting of the original config file when saving settings\.<br>Disable this option to merge the current settings with the preexisting settings in the config\.|
+|rtx.option.saveToLayerConf|bool|False|||Whether or not to save the layer to original config file\.<br>Disable this to save the layer into rtx\.conf\.<br>Base on overwriteConfig, the config of the layer will be merged or override the rtx\.conf\.|
+|rtx.option.serializeChangedOptionOnly|bool|True||||
 |rtx.orthographicIsUI|bool|True|||When enabled, draw calls that are orthographic will be considered as UI\.|
 |rtx.particleSoftnessFactor|float|0.05|||Multiplier for the view distance that is used to calculate the particle blending range\.|
 |rtx.particles.enable|bool|True|||Enables particle simulation and rendering\.|
@@ -678,7 +682,6 @@ Tables below enumerate all the options and their defaults set by RTX Remix. Note
 |rtx.sceneScale|float|1|||Defines the ratio of rendering unit \(1cm\) to game unit, i\.e\. sceneScale = 1cm / GameUnit\.|
 |rtx.secondaryRayMaxInteractions|int|8|||The maximum number of resolver interactions to use for secondary \(indirect\) rays\.<br>This affects how many Decals, Ray Portals and potentially particles \(if unordered approximations are not enabled\) may be interacted with along a ray at the cost of performance for higher amounts of interactions\.<br>This value is recommended to be set lower than the primary/PSR max ray interactions as secondary ray interactions are less visually relevant relative to the performance cost of resolving them\.|
 |rtx.secondarySpecularFireflyFilteringThreshold|float|1000|||Firefly luminance clamping threshold for secondary specular signal\.|
-|rtx.serializeChangedOptionOnly|bool|True||||
 |rtx.shader.asyncCompilationThrottleMilliseconds|int|33|||Specifies a time in milliseconds to throttle each application frame when async shader compilation is in progress\. Set to 0 to disable, and only takes effect when rtx\.shader\.enableAsyncCompilation is true\.<br>This generally should be set to a value low enough to not impact the application framerate significantly \(especially if non\-ray traced visuals are capable of being displayed by the application while loading, e\.g\. an intro video\), but also high enough to get the desired shader compilation performance \(especially relevant if the application is fairly heavy on the CPU during async shader compilation, or on CPUs with few hardware threads\)\.|
 |rtx.shader.asyncSpirVRecompilation|bool|True|||When set to true runtime shader recompilation will recompile shaders to SPIR\-V asynchronously rather than blocking until complete\.<br>Do note that despite setting this option the actual compilation of the shader from SPIR\-V to the ISA will still be blocking as only the prewarming process can handle this step asynchronously for now\.<br>Generally this option should remain enabled, though disabling it may be useful for CI where deterministic behavior is needed, and may be useful to maximize performance at the cost of blocking \(by not having application running while compiling to SPIR\-V\)\.<br>This option is mainly meant for development use and should not be set for user\-facing operation\.|
 |rtx.shader.enableAsyncCompilation|bool|True|||When set to true shader compilation \(especially that of prewarming\) will be done asynchronously rather than blocking\.<br>Typically shader prewarming with async finalization is done to attempt to compile all required shader variants before they are used, often by overlapping this work with a startup sequence \(e\.g\. a game's loading screen\)\. Often times however this prewarming takes longer than the time available, or an application may not have a startup sequence to begin with and immediately begin using Remix shaders\.<br>To accomodate this, async shader compilation allows for this work to be done asynchronously to avoid blocking the application at the cost of being unable to render anything until the process is complete\.<br>This is typically better choice than blocking however and is recommended to be enabled as on Windows Remix blocking will cause the application to stop responding, making it seem as if the application has crashed if shader compilation takes a long time\. Additionally, when combined with rtx\.shader\.enableAsyncCompilationUI the progress of the compilation process can be shown to the user as a UI, improving user experience\.<br>The main downside to this approach is that when blocking shader compilation is allowed to take up more of the CPU, whereas async shader compilation will have to compete with the application which can make compilation take slightly longer than it would otherwise \(especially true if the application's framerate is uncapped\)\.<br>To mitigate this, Remix can optionally throttle the application during async compilation via rtx\.shader\.asyncCompilationThrottleMilliseconds to ensure enough time is available for compilation\.<br>Finally, a more minor downside is that when async shader compilation is in use Remix currently has no way of keeping the application in a startup sequence \(e\.g\. keeping a game on its loading screen\) while it waits for shaders to compile\.<br>This will mean for instance a game's menu may be active but not be able to render until the compilation is complete, rather than blocking on the loading screen and transitioning to the menu only once all shaders are loaded\. Not blocking the application is typically better for user experience regardless though as long as some sort of progress UI is displayed to indicate what is happening\.|

src/dxvk/dxvk_instance.cpp

@@ -641,7 +641,10 @@ namespace dxvk {
     initConfig<Config::Type_RtxUser>();
     initConfig<Config::Type_RtxMod>();
 
-    RtxOptionImpl::addRtxOptionLayer("user.conf", RtxOptionLayer::s_runtimeOptionLayerPriority, 1.0f, 1.0f);
+    RtxOptionImpl::addRtxOptionLayer("quality.conf", (uint32_t) RtxOptionLayer::SystemLayerPriority::Quality, true, 1.0f, 1.0f);
+    Logger::info("Set quality configs.");
+
+    RtxOptionImpl::addRtxOptionLayer("user.conf", (uint32_t) RtxOptionLayer::SystemLayerPriority::USER, true, 1.0f, 1.0f);
     Logger::info("Set user realtime configs.");
 
     RtxOption<bool>::initializeRtxOptions();
@@ -694,6 +697,7 @@ namespace dxvk {
       const auto baseGameModPath = ModManager::getBaseGameModPath(
         m_config.getOption<std::string>("rtx.baseGameModRegex", "", ""),
         m_config.getOption<std::string>("rtx.baseGameModPathRegex", "", ""));
+
       if (baseGameModPath.empty()) {
         // Skip RtxMod if not present, as it may just pick up a different rtx.mod path
         Logger::info("No base game mod path found. Skipping initialization.");
@@ -710,13 +714,13 @@ namespace dxvk {
       // Set config so that any rtx option initialized later will use the value in that config object
       // The start-up config contains the values from the code and dxvk.conf, only.
       RtxOption<bool>::setStartupConfig(m_config);
-      RtxOptionImpl::addRtxOptionLayer("dxvk.conf", 1, 1.0f, 1.0f, &m_config);
+      RtxOptionImpl::addRtxOptionLayer("dxvk.conf", (uint32_t)RtxOptionLayer::SystemLayerPriority::DxvkConf, true, 1.0f, 1.0f, &m_config);
       Logger::info("Set startup config.");
     } else if constexpr ((type == Config::Type_RtxUser) || (type == Config::Type_RtxMod)) {
       // Set custom config after the RTX user config has been merged into the config and
       // update the RTX options. Contains values from rtx.conf
       RtxOption<bool>::setCustomConfig(m_config);
-      RtxOptionImpl::addRtxOptionLayer("rtx.conf", 2, 1.0f, 1.0f, &m_config);
+      RtxOptionImpl::addRtxOptionLayer("rtx.conf", (uint32_t)RtxOptionLayer::SystemLayerPriority::RtxConf, true, 1.0f, 1.0f, nullptr);
       Logger::info("Set custom config.");
     }
   }

src/dxvk/imgui/dxvk_imgui.cpp

@@ -541,6 +541,16 @@ namespace dxvk {
       {    TerrainMode::AsDecals, "Terrain-as-Decals"},
   });
 
+  ImGui::ComboWithKey<OptionLayerType>::ComboEntries optionSavingModeComboEntries = { {
+      { OptionLayerType::User, "User", "Runtime settings"},
+      { OptionLayerType::Rtx, "Rtx", "RTX settings"},
+      { OptionLayerType::Quality, "Quality", "Graphics quality preset settings"},
+      { OptionLayerType::None, "None", "No settings layer; used for testing or temporary development" },
+  } };
+
+  static auto optionSavingModeCombo = ImGui::ComboWithKey<OptionLayerType>(
+    "Type of setting to save##option", ImGui::ComboWithKey<OptionLayerType>::ComboEntries { optionSavingModeComboEntries });
+
   static auto themeCombo = ImGui::ComboWithKey<ImGUI::Theme>(
     "Mode##theme",
     {
@@ -1099,12 +1109,13 @@ namespace dxvk {
     ImGui::Separator();
     ImGui::Dummy(ImVec2(0, 2));
 
-    ImGui::Checkbox("Save Changed Settings Only", &RtxOptions::serializeChangedOptionOnlyObject());
-    const float buttonWidth = ImGui::GetContentRegionAvail().x / 3 - (ImGui::GetStyle().ItemSpacing.x);
-
-    if (IMGUI_ADD_TOOLTIP(ImGui::Button("Save Settings", ImVec2(buttonWidth, 0)), "Changes are now saved to user.conf. Use the 'Save' button in the rtx.conf layer if you want to store them there for sharing.")) {
+    IMGUI_ADD_TOOLTIP(optionSavingModeCombo.getKey(&RtxOptions::Option::optionSavingTypeObject()), "Setting saving mode");
 
+    ImGui::Checkbox("Save Changed Settings Only", &RtxOptions::Option::serializeChangedOptionOnlyObject());
+    ImGui::Checkbox("Override configs", &RtxOptions::Option::overwriteConfigObject());
 
+    const float buttonWidth = ImGui::GetContentRegionAvail().x / 3 - (ImGui::GetStyle().ItemSpacing.x);
+    if (IMGUI_ADD_TOOLTIP(ImGui::Button("Save Settings", ImVec2(buttonWidth, 0)), "Changes are now saved to selected config file.")) {
       RtxOptions::serialize();
     }
 
@@ -2055,12 +2066,17 @@ namespace dxvk {
           }
         }
 
+        ImGui::Checkbox("Override configs", &RtxOptions::Option::overwriteConfigObject());
+
         uint32_t optionLayerCounter = 1;
         for (auto& [priority, optionLayer] : RtxOptionImpl::getRtxOptionLayerMap()) {
           // Runtime option layer priority is reserved for real-time user changes.
           // These layers should not be modified through the GUI.
           if (priority != RtxOptionLayer::s_runtimeOptionLayerPriority) {
             ImGui::Dummy(ImVec2(0.0f, 5.0f));
+            ImGui::Separator();
+            ImGui::Dummy(ImVec2(0.0f, 5.0f));
+
             const std::string optionLayerName = optionLayer.getName();
 
             // Process the display name
@@ -2081,8 +2097,8 @@ namespace dxvk {
             }
 
             const std::string optionLayerText = std::to_string(optionLayerCounter++) + ". " + displayName;
-            const std::string optionLayerStrengthText = " Strength";
-            const std::string optionLayerThresholdText = " Threshold";
+            const std::string optionLayerStrengthText = " Strength###Strength_" + displayName;
+            const std::string optionLayerThresholdText = " Threshold###Threshold_" + displayName;
 
             // Use pending values for UI display and send requests on change
             bool pendingEnabled = optionLayer.getPendingEnabled();
@@ -2102,11 +2118,22 @@ namespace dxvk {
               optionLayer.requestBlendThreshold(pendingThreshold);
             }
 
-            // Disabled because this blows away the existing settings and replaces it with the current runtime settings.
-            // TODO make this save out the combo of existing settings and runtime settings.
-            // const std::string optionLayerSavingText = "Save realtime changes into layer " + displayName;
-            // if (ImGui::Button(optionLayerSavingText.c_str())) {
-            //   RtxOptions::serializeOptionLayer(optionLayer.getName());
+            // TODO: We need to move these part into a separate saving session
+            // std::string layerType;
+            // if (optionLayerName == "rtx.conf") {
+            //   layerType = "RTX";
+            // } else if (optionLayerName == "quality.conf") {
+            //   layerType = "Quality";
+            // } else if (optionLayerName == "user.conf") {
+            //   layerType = "Runtime";
+            // } else {
+            //   layerType = optionLayerName;
+            // }
+            // const std::string optionLayerSavingText = RtxOptions::Option::saveToLayerConf() || displayName == "rtx.conf"?
+            //   "Save all settings from " + layerType + " layer to " + displayName :
+            //   "Save all settings from " + layerType + " layer to rtx.conf";
+            // if (IMGUI_ADD_TOOLTIP(ImGui::Button(optionLayerSavingText.c_str()), "Save layer to rtx.conf")) {
+            //   RtxOptions::serializeOptionLayer(optionLayer, RtxOptions::Option::saveToLayerConf());
             // }
 
             if (ImGui::CollapsingHeader(("Contents of " + displayName).c_str(), collapsingHeaderClosedFlags)) {

src/dxvk/rtx_render/rtx_option.cpp

@@ -1069,16 +1069,21 @@ Tables below enumerate all the options and their defaults set by RTX Remix. Note
     return s_rtxOptionLayers;
   }
 
-  const RtxOptionLayer* RtxOptionImpl::addRtxOptionLayer(const std::string& configPath, const uint32_t priority, const float blendStrength, const float blendThreshold, const Config* config) {
+  const RtxOptionLayer* RtxOptionImpl::addRtxOptionLayer(
+    const std::string& configPath, const uint32_t priority, const bool isSystemOptionLayer,
+    const float blendStrength, const float blendThreshold, const Config* config) {
+    // Adjust rtx.conf path if env var DXVK_RTX_CONFIG_FILE is set
+    const std::string adjustedConfigPath = configPath == "rtx.conf" ? RtxOptions::getRtxConfPath() : configPath;
+
     // Load config from path if not provided
-    const Config& layerConfig = config ? *config : Config::getOptionLayerConfig(configPath);
+    const Config& layerConfig = config ? *config : Config::getOptionLayerConfig(adjustedConfigPath);
 
     // Apply priority offset for option layers only when loading from path (not for rtx.conf or dxvk.conf)
     uint32_t adjustedPriority = priority;
-    if (!config && priority != RtxOptionLayer::s_runtimeOptionLayerPriority) {
+    if (!isSystemOptionLayer && !config && priority != RtxOptionLayer::s_runtimeOptionLayerPriority) {
       adjustedPriority += RtxOptionLayer::s_userOptionLayerOffset;
     }
-    
+
     // Construct the layer in-place in the map using emplace
     auto result = getRtxOptionLayerMap().emplace(
       std::piecewise_construct,
@@ -1097,7 +1102,7 @@ Tables below enumerate all the options and their defaults set by RTX Remix. Note
     if (!layer.isValid()) {
       // Layer is invalid, remove it from the map
       getRtxOptionLayerMap().erase(result.first);
-      Logger::warn(str::format("[RTX Option]: Failed to load valid config for layer '", configPath, "' with original priority ", priority, " and adjusted priority ", adjustedPriority, "."));
+      Logger::warn(str::format("[RTX Option]: Failed to load valid config for layer '", adjustedConfigPath, "' with original priority ", priority, " and adjusted priority ", adjustedPriority, "."));
       return nullptr;
     }
 

src/dxvk/rtx_render/rtx_option.h

@@ -68,6 +68,13 @@ namespace dxvk {
     Vector4
   };
 
+  enum class OptionLayerType {
+    User,
+    Rtx,
+    Quality,
+    None
+  };
+
   union GenericValue {
     bool b;
     int i;
@@ -103,6 +110,16 @@ namespace dxvk {
       RequestEnabled = 1   // At least one component requested enabled (wins over disabled)
     };
 
+    enum class SystemLayerPriority : uint32_t {
+      Default = 0,
+      DxvkConf = 1,
+      RtxConf = 2,
+      Quality = 3,
+      Mod = 4,
+      NONE = 0xFFFFFFFE,
+      USER = 0xFFFFFFFF
+    };
+
     // Constructor for creating option layers
     // Should not be called directly. Use RtxOptionLayerManager::acquireLayer instead.
     RtxOptionLayer(const Config& config, const std::string& configName, const uint32_t priority, const float blendStrength, const float blendThreshold);
@@ -157,6 +174,10 @@ namespace dxvk {
       m_blendStrengthDirty = dirty;
     }
 
+    void setConfig(const Config& config) {
+      m_config = config;
+    }
+
     const bool isValid() const { return m_config.getOptions().size() > 0; }
     const bool isEnabled() const { return m_enabled; }
     const Config& getConfig() const { return m_config; }
@@ -392,7 +413,9 @@ namespace dxvk {
     // Add an option layer to global option layer map
     // Returns a pointer to the newly created layer, or nullptr if the layer was invalid
     // If config is provided, uses it directly; otherwise loads from configPath
-    static const RtxOptionLayer* addRtxOptionLayer(const std::string& configPath, const uint32_t priority, const float blendStrength, const float blendThreshold, const Config* config = nullptr);
+    static const RtxOptionLayer* addRtxOptionLayer(
+      const std::string& configPath, const uint32_t priority, const bool isSystemOptionLayer,
+      const float blendStrength, const float blendThreshold, const Config* config = nullptr);
     // Remove an option layer from the global option layer map by pointer
     // Returns true if the layer was found and removed
     static bool removeRtxOptionLayer(const RtxOptionLayer* layer);

src/dxvk/rtx_render/rtx_option_layer_manager.cpp

@@ -54,7 +54,7 @@ const RtxOptionLayer* RtxOptionLayerManager::acquireLayer(const std::string& con
   }
 
   // Create new layer
-  const RtxOptionLayer* newLayer = RtxOptionImpl::addRtxOptionLayer(configPath, priority, blendStrength, blendThreshold);
+  const RtxOptionLayer* newLayer = RtxOptionImpl::addRtxOptionLayer(configPath, priority, false, blendStrength, blendThreshold);
 
   if (newLayer == nullptr) {
     Logger::err(str::format("RtxOptionLayerManager: Failed to create layer for '", configPath, "' with priority ", priority, "."));