Merge branch 'REMIX-4605-graphics-preset-fix' into 'main'

[REMIX-4605] fix graphics preset dropdown to apply the correct preset

Closes REMIX-4605

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

Author: MarkEHenderson

src/dxvk/imgui/dxvk_imgui.cpp

@@ -1405,22 +1405,14 @@ namespace dxvk {
 
     ImGui::TextSeparator("Preset Settings");
 
-    const auto graphicsPresetChanged = graphicsPresetCombo.getKey(&RtxOptions::graphicsPresetObject());
-
-    m_userGraphicsSettingChanged |= graphicsPresetChanged;
+    m_userGraphicsSettingChanged |= graphicsPresetCombo.getKey(&RtxOptions::graphicsPresetObject());
 
     // Map settings to indirect particle level
     int indirectLightParticlesLevel = 0;
     if (RtxOptions::enableUnorderedResolveInIndirectRays()) {
       indirectLightParticlesLevel = RtxOptions::enableUnorderedEmissiveParticlesInIndirectRays() ? 2 : 1;
     }
 
-    // Map presets to options
-
-    if (graphicsPresetChanged) {
-      RtxOptions::updateGraphicsPresets(ctx->getDevice().ptr());
-    }
-
     // Path Tracing Settings
 
     ImGui::TextSeparator("Path Tracing Settings");

src/dxvk/rtx_render/rtx_context.cpp

@@ -694,7 +694,7 @@ namespace dxvk {
     getSceneManager().clearFogState();
 
     // apply changes to RtxOptions after the frame has ended
-    RtxOption<bool>::applyPendingValues();
+    RtxOption<bool>::applyPendingValues(m_device.ptr());
 
     // Update stats
     updateMetrics(gpuIdleTimeMilliseconds);

src/dxvk/rtx_render/rtx_debug_view.cpp

@@ -1674,13 +1674,13 @@ namespace dxvk {
       RtxOptions::useDenoiserReferenceMode();
   }
 
-  void DebugView::maxValueOnChange() {
+  void DebugView::maxValueOnChange(DxvkDevice* device) {
     // If the max value is negative, we want the min value to be further away from 0.
     const float factor = maxValue() > 0 ? 0.99999f : 1.00001f;
     minValueObject().setMaxValue(maxValue() * factor);
   }
 
-  void DebugView::minValueOnChange() {
+  void DebugView::minValueOnChange(DxvkDevice* device) {
     // If the min value is negative, we want the max value to be closer to 0.
     const float factor = minValue() > 0 ? 1.00001f : 0.99999f;
     maxValueObject().setMinValue(minValue() * factor);

src/dxvk/rtx_render/rtx_debug_view.h

@@ -164,13 +164,13 @@ namespace dxvk {
     bool m_enableAlphaChannel = false;
     float m_scale = 1.f;
 
-    public: static void maxValueOnChange();
+    public: static void maxValueOnChange(DxvkDevice* device);
     RTX_OPTION_ARGS("rtx.debugView", float, minValue, 0.f,
       "The minimum debug view input value to map to 0 in the output when the standard debug display is in use. Values below this value in the input will be clamped to 0 in the output.",
       args.environment = "DXVK_RTX_DEBUG_VIEW_MIN_VALUE",
       args.onChangeCallback = &maxValueOnChange);
 
-    public: static void minValueOnChange();
+    public: static void minValueOnChange(DxvkDevice* device);
     RTX_OPTION_ARGS("rtx.debugView", float, maxValue, 1.f,
       "The maximum debug view input value to map to 1 in the output when the standard debug display is in use. Values above this value in the input will be clamped to 1 in the output.",
       args.environment = "DXVK_RTX_DEBUG_VIEW_MAX_VALUE",

src/dxvk/rtx_render/rtx_initializer.cpp

@@ -84,7 +84,7 @@ namespace dxvk {
     ShaderManager::getInstance()->addGlobalExtraLayout(pCommon->getSceneManager().getBindlessResourceManager().getGlobalBindlessTableLayout(BindlessResourceManager::Samplers));
 
     // Need to promote all of the hardware support Options before prewarming shaders.
-    RtxOption<bool>::applyPendingValues();
+    RtxOption<bool>::applyPendingValues(m_device);
 
     // Kick off shader prewarming
     startPrewarmShaders();

src/dxvk/rtx_render/rtx_neural_radiance_cache.cpp

@@ -132,7 +132,7 @@ namespace dxvk {
     PREWARM_SHADER_PIPELINE(NrcResolveShader);
   }
 
-  void NeuralRadianceCache::NrcOptions::onMaxNumTrainingIterationsChanged() {
+  void NeuralRadianceCache::NrcOptions::onMaxNumTrainingIterationsChanged(DxvkDevice* device) {
     targetNumTrainingIterations.setMaxValue(maxNumTrainingIterations());
   }
 
@@ -316,7 +316,7 @@ namespace dxvk {
     return NrcContext::checkIsSupported(device);
   }
 
-  void NeuralRadianceCache::NrcOptions::onQualityPresetChanged() {
+  void NeuralRadianceCache::NrcOptions::onQualityPresetChanged(DxvkDevice* device) {
     // Note: This function is called during onChange handler for quality preset option and 
     // all the NRC calls have been issued, so it's safe to set the new settings using immediately.
     // In addition, this ensures the settings being applied immediately on start, rather than being delayed to the next frame

src/dxvk/rtx_render/rtx_neural_radiance_cache.h

@@ -61,7 +61,7 @@ namespace dxvk {
                  "Each training batch contains 16K training records derived from path segments\n"
                  "in the the NRC update path tracing pass. For example, 4 training iterations results in 64K training records.\n"
                  "Higher number results in more responsive NRC cache at the cost of increased workload.\n");
-      public: static void onMaxNumTrainingIterationsChanged();
+      public: static void onMaxNumTrainingIterationsChanged(DxvkDevice* device);
       RTX_OPTION_ARGS("rtx.neuralRadianceCache", uint32_t, maxNumTrainingIterations, 16,
                  "This controls the max number of training iterations to perform in a frame.\n"
                  "When the pathtracer generates more training records than the ideal number of training records\n"
@@ -122,7 +122,7 @@ namespace dxvk {
       RTX_OPTION("rtx.neuralRadianceCache", bool, enableCalculateTrainingLoss, false, "Enables calculation of a training loss. Imposes a performance penalty.");
       RTX_OPTION("rtx.neuralRadianceCache", bool, enableAdaptiveTrainingDimensions, true, "Enables adaptive training dimensions that scale based off pathtracer's execution behavior on a given scene.");
 
-      static void onQualityPresetChanged();
+      static void onQualityPresetChanged(DxvkDevice* device);
       RTX_OPTION_ARGS("rtx.neuralRadianceCache", QualityPreset, qualityPreset, QualityPreset::Ultra,
                       "Quality Preset: Medium (0), High (1), Ultra (2).\n"
                       "Adjusts quality of RTX Neural Radiance Cache (NRC):\n"

src/dxvk/rtx_render/rtx_option.cpp

@@ -189,9 +189,9 @@ namespace dxvk {
     }
   }
 
-  void RtxOptionImpl::invokeOnChangeCallback() const {
+  void RtxOptionImpl::invokeOnChangeCallback(DxvkDevice* device) const {
     if (onChangeCallback) {
-      onChangeCallback();
+      onChangeCallback(device);
     }
   }
 

src/dxvk/rtx_render/rtx_option.h

@@ -40,6 +40,8 @@
 #endif
 
 namespace dxvk {
+  class DxvkDevice;
+  
   // RtxOption refers to a serializable option, which can be of a basic type (i.e. int) or a class type (i.e. vector hash value)
   // On initialization, it retrieves a value from a Config object and add itself to a global list so that all options can be serialized 
   // into a file when requested.
@@ -100,7 +102,7 @@ namespace dxvk {
     std::optional<GenericValue> minValue;
     std::optional<GenericValue> maxValue;
     uint32_t flags = 0;
-    std::function<void()> onChangeCallback;
+    std::function<void(DxvkDevice* device)> onChangeCallback;
 
     RtxOptionImpl(XXH64_hash_t hash, const char* optionName, const char* optionCategory, OptionType optionType, const char* optionDescription) :
       hash(hash),
@@ -132,7 +134,7 @@ namespace dxvk {
       getDirtyRtxOptionMap()[hash] = this;
     }
 
-    void invokeOnChangeCallback() const;
+    void invokeOnChangeCallback(DxvkDevice* device) const;
 
     // Returns true if the value was changed
     bool clampValue(ValueType type);
@@ -173,7 +175,9 @@ namespace dxvk {
     std::optional<T> minValue;
     std::optional<T> maxValue;
 
-    typedef void (*RtxOptionOnChangeCallback)();
+    // NOTE: onChange handlers can be invoked before the DxvkDevice is created,
+    // so these callbacks need to null check the device.
+    typedef void (*RtxOptionOnChangeCallback)(DxvkDevice* device);
     RtxOptionOnChangeCallback onChangeCallback = nullptr;
   };
 
@@ -321,7 +325,7 @@ namespace dxvk {
     // This should be called at the very end of the frame in the dxvk-cs thread.
     // Before the first frame is rendered, it also needs to be called at least once during initialization.
     // It's currently called twice during init, due to multiple sections that set many Options then immediately use them.
-    static void applyPendingValues() {
+    static void applyPendingValues(DxvkDevice* device) {
       std::unique_lock<std::mutex> lock(RtxOptionImpl::s_updateMutex);
 
       auto& dirtyOptions = RtxOptionImpl::getDirtyRtxOptionMap();
@@ -339,7 +343,7 @@ namespace dxvk {
 
       // Invoke onChange callbacks after promoting all the values, so that newly set values will be updated at the end of the next frame
       for (RtxOptionImpl* rtxOption : dirtyOptionsVector) {
-        rtxOption->invokeOnChangeCallback();
+        rtxOption->invokeOnChangeCallback(device);
       }
     }
 
@@ -397,6 +401,7 @@ namespace dxvk {
           pImpl->valueList[i].value = 0;
           *reinterpret_cast<BasicType*>(&pImpl->valueList[i].value) = value;
         }
+        initializeClamping(args);
       }
     }
 
@@ -408,6 +413,7 @@ namespace dxvk {
         for (int i = 0; i < (int)RtxOptionImpl::ValueType::Count; i++) {
           pImpl->valueList[i].pointer = new ClassType(value);
         }
+        initializeClamping(args);
       }
     }
 
@@ -457,17 +463,6 @@ namespace dxvk {
         pImpl->flags = args.flags;
         // Need to wrap this so we can cast it to the correct type
         pImpl->onChangeCallback = args.onChangeCallback;
-        if constexpr (isClampable()) {
-          if (args.minValue.has_value()) {
-            setMinValue(args.minValue.value());
-          }
-          if (args.maxValue.has_value()) {
-            setMaxValue(args.maxValue.value());
-          }
-        } else if (args.minValue.has_value() || args.maxValue.has_value()) {
-          // If this happens on an option that should be clampable, the type probably needs to be added to isClampable(), and supported in the clampValue() method.
-          assert(false && "RtxOption - args.minValue and args.maxValue are not supported for types not included in isClampable().");
-        }
         globalRtxOptions[optionHash] = pImpl;
         return true;
       } else {
@@ -478,6 +473,21 @@ namespace dxvk {
       }
     }
 
+    // This needs to be done after the valueList is initialized in the constructor.
+    void initializeClamping(RtxOptionArgs<T> args) {
+      if constexpr (isClampable()) {
+        if (args.minValue.has_value()) {
+          setMinValue(args.minValue.value());
+        }
+        if (args.maxValue.has_value()) {
+          setMaxValue(args.maxValue.value());
+        }
+      } else if (args.minValue.has_value() || args.maxValue.has_value()) {
+        // If this happens on an option that should be clampable, the type probably needs to be added to isClampable(), and supported in the clampValue() method.
+        assert(false && "RtxOption - args.minValue and args.maxValue are not supported for types not included in isClampable().");
+      }
+    }
+
     // Get pointer to basic types
     template <typename BasicType, std::enable_if_t<std::is_pod_v<BasicType>, bool> = true>
     BasicType* getValuePtr(RtxOptionImpl::ValueType type) const {
@@ -505,7 +515,7 @@ namespace dxvk {
       } else {
         // For non-POD types (vectors, etc.), store as pointer
         if (!targetValue.has_value()) {
-          targetValue = std::optional<GenericValue>();
+          targetValue = std::optional<GenericValue>(GenericValue{});
           // Note: This is a `new` with no matching `delete`. This is safe because the
           // RtxOptionImpl object is never destroyed, and follows the pattern used in the constructor.
           targetValue.value().pointer = new T();

src/dxvk/rtx_render/rtx_options.cpp

@@ -39,15 +39,29 @@
 
 namespace dxvk {
   std::unique_ptr<RtxOptions> RtxOptions::m_instance = nullptr;
+  
+  void RtxOptions::graphicsPresetOnChange(DxvkDevice* device) {
+    // device will be nullptr during initial config loading.
+    if (device == nullptr) {
+      return;
+    }
+
+    // TODO[REMIX-1482]: Currently tests expect to skip applying the graphics preset, so this needs to be skipped in test runs.
+    // When we fix tests to actually use the preset, the if statement should be removed.
+    if (env::getEnvVar("DXVK_TERMINATE_APP_FRAME") == "" ||
+        env::getEnvVar("DXVK_GRAPHICS_PRESET_TYPE") != "0") {
+      RtxOptions::updateGraphicsPresets(device);
+    }
+  }
 
-  void RtxOptions::showUICursorOnChange() {
+  void RtxOptions::showUICursorOnChange(DxvkDevice* device) {
     if (ImGui::GetCurrentContext() != nullptr) {
       auto& io = ImGui::GetIO();
       io.MouseDrawCursor = RtxOptions::showUICursor() && RtxOptions::showUI() != UIType::None;
     }
   }
 
-  void RtxOptions::blockInputToGameInUIOnChange() {
+  void RtxOptions::blockInputToGameInUIOnChange(DxvkDevice* device) {
     const bool doBlock = RtxOptions::blockInputToGameInUI() && RtxOptions::showUI() != UIType::None;
 
     BridgeMessageChannel::get().send("UWM_REMIX_UIACTIVE_MSG", doBlock ? 1 : 0, 0);