feat(PerformanceMonitor): make tracy profiler integration configurable

MovingBlocks · Jul 14, 2024 · 6fd43e8 · 6fd43e8
1 parent 81dd77a
commit 6fd43e8
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 3 deletions.
diff --git a/engine/src/main/java/org/terasology/engine/config/SystemConfig.java b/engine/src/main/java/org/terasology/engine/config/SystemConfig.java
@@ -68,6 +68,12 @@ public class SystemConfig extends AutoConfig {
             name("${engine:menu#settings-monitoring-enabled}")
     );
 
+    public final Setting<Boolean> tracyProfilerEnabled = setting(
+            type(Boolean.class),
+            defaultValue(false),
+            name("${engine:menu#settings-tracy-profiler-enabled}")
+    );
+
     public final Setting<Boolean> writeSaveGamesEnabled = setting(
             type(Boolean.class),
             defaultValue(true),

diff --git a/engine/src/main/java/org/terasology/engine/monitoring/PerformanceMonitor.java b/engine/src/main/java/org/terasology/engine/monitoring/PerformanceMonitor.java
@@ -19,6 +19,7 @@
  */
 public final class PerformanceMonitor {
     private static PerformanceMonitorInternal instance;
+    private static boolean tracyEnabled;
 
     static {
         instance = new NullPerformanceMonitor();
@@ -127,6 +128,10 @@ public static TObjectDoubleMap<String> getAllocationMean() {
         return instance.getAllocationMean();
     }
 
+    public static void setTracyEnabled(boolean enabled) {
+        tracyEnabled = enabled;
+    }
+
     /**
      * Enables or disables the Performance Monitoring system.
      * <br><br>
@@ -139,7 +144,7 @@ public static void setEnabled(boolean enabled) {
             if (instance != null) {
                 instance.shutdown();
             }
-            instance = new PerformanceMonitorImpl();
+            instance = new PerformanceMonitorImpl(tracyEnabled);
         } else if (!enabled && !(instance instanceof NullPerformanceMonitor)) {
             if (instance != null) {
                 instance.shutdown();

diff --git a/engine/src/main/java/org/terasology/engine/monitoring/impl/PerformanceMonitorImpl.java b/engine/src/main/java/org/terasology/engine/monitoring/impl/PerformanceMonitorImpl.java
@@ -59,7 +59,7 @@ public class PerformanceMonitorImpl implements PerformanceMonitorInternal {
     private final Thread mainThread;
     private final EngineTime timer;
 
-    public PerformanceMonitorImpl() {
+    public PerformanceMonitorImpl(boolean enableTracy) {
         activityStack  = Queues.newArrayDeque();
         executionData  = Lists.newLinkedList();
         allocationData = Lists.newLinkedList();
@@ -81,7 +81,7 @@ public PerformanceMonitorImpl() {
         timer = (EngineTime) CoreRegistry.get(Time.class);
         mainThread = Thread.currentThread();
 
-        if (!tracyEnabled) {
+        if (enableTracy && !tracyEnabled) {
             Tracy.startupProfiler();
             tracyEnabled = true;
         }

diff --git a/...src/main/java/org/terasology/engine/rendering/nui/layers/ingame/metrics/DebugOverlay.java b/...src/main/java/org/terasology/engine/rendering/nui/layers/ingame/metrics/DebugOverlay.java
@@ -271,6 +271,7 @@ protected boolean isEscapeToCloseAllowed() {
      */
     public void toggleMetricsMode() {
         MetricsMode mode = debugMetricsSystem.toggle();
+        PerformanceMonitor.setTracyEnabled(systemConfig.tracyProfilerEnabled.get());
         PerformanceMonitor.setEnabled(mode.isPerformanceManagerMode());
     }
 }
diff --git a/engine/src/main/resources/org/terasology/engine/assets/i18n/menu.lang b/engine/src/main/resources/org/terasology/engine/assets/i18n/menu.lang
@@ -340,6 +340,7 @@
     "settings-debug-mode": "settings-debug-mode",
     "settings-language": "settings-language",
     "settings-monitoring-enabled": "settings-monitoring-enabled",
+    "settings-tracy-profiler-enabled": "settings-tracy-profiler-enabled",
     "settings-saves-enabled": "settings-saves-enabled",
     "settings-seconds-between-saves": "settings-seconds-between-saves",
     "settings-title": "settings-title",

diff --git a/engine/src/main/resources/org/terasology/engine/assets/i18n/menu_en.lang b/engine/src/main/resources/org/terasology/engine/assets/i18n/menu_en.lang
@@ -350,6 +350,7 @@
     "settings-debug-mode": "Debug mode",
     "settings-language": "Language",
     "settings-monitoring-enabled": "Monitoring",
+    "settings-tracy-profiler-enabled": "Tracy Profiler",
     "settings-saves-enabled": "Game saves",
     "settings-seconds-between-saves": "Seconds between saves",
     "settings-title": "Settings",