Merge pull request #176 from Unity-Technologies/siyaoH/1.17/gc

incremental gc

Author: zhuxingwei

README-ZH.md

@@ -202,15 +202,17 @@ UIWidgets也支持Gif！
 #### 七、图片导入设置
 请将图片放入StreamingAssets下，而后用```Image.file```读取
 
-#### 八、自动降低帧率
-目前在默认情况下，为了保证流畅度，项目在各个平台上均会以最高的刷新频率运行。不过您可以通过在代码中设置```SchedulerBinding.MEnableAutoAdjustFramerate = true```的方式来开启自动降帧的功能：该功能开启后，在UI内容不变的情况下我们将降低项目的刷新率来降低耗电。
+#### 八、移动设备优化
+目前在默认情况下，为了保证流畅度，项目在各个平台上均会以最高的刷新频率运行。不过您可以通过在代码中设置```UIWidgetsGlobalConfiguration.EnableAutoAdjustFramerate = true```的方式来开启自动降帧的功能：该功能开启后，在UI内容不变的情况下我们将降低项目的刷新率来降低耗电。
+
+在移动设备上UI绘制的流畅度受到GC影响较大。项目默认会开启OnDemandGC来接管并优化整体GC效果。如果您不需要GC被UIWidgets控制，请在代码中设置```UIWidgetsGlobalConfiguration.EnableIncrementalGC = false```。
 
 
 ## 调试UIWidgets应用程序
 
 在编辑器菜单栏选择```UIWidgets->EnableDebug```
 
-如果想在runtime选择是否debug，请修改文件```com.unity.uiwidgets/com.unity.uiwidgets/Runtime/foundation/debug.cs```中的```static bool debugEnableAtRuntimeInternal```
+如果想在runtime开启debug模式，请在项目代码中设置```UIWidgetsGlobalConfiguration.EnableDebugAtRuntime = true```。在默认情况下debug模式为关闭状态。
 
 ## 使用Window Scope保护外部调用
 如果您在调试时遇到 `AssertionError: Window.instance is null` 或者在调用 `Window.instance` 时得到空指针, 那么您需要

README.md

@@ -213,16 +213,16 @@ want to show the status bar in your App, you can disable```Start in fullscreen``
 #### Image Import Setting
 Please put images under StreamingAssets folder, a and loading it using ```Image.file```.
 
-#### Automatic Framerate Adjustment
-You can enable this feature by setting ```SchedulerBinding.MEnableAutoAdjustFramerate = true``` in your project, which will automatically drop the frame rate of your App to 0 if the UI contents of UIWidgetsPanel is not changed for some time. This will help to prevent battery drain on mobile devices significantly. 
+#### Performance Optimization on Mobile devices
+By setting ```UIWidgetsGlobalConfiguration.EnableAutoAdjustFramerate = true``` in your project, UIWidgets will drop the frame rate of your App to 0 if the UI contents of UIWidgetsPanel is not changed for some time. This will help to prevent battery drain on mobile devices significantly. Note that this feature is disabled by default.
 
-Note that this feature is disabled by default though.
+Long time garbage collection may cause App to stuck frequently. In UIWidgets we enable incremental garbage collection to avoid it. However, you can disable this feature by setting ```UIWidgetsGlobalConfiguration.EnableIncrementalGC = false```.
 
 ## Debug UIWidgets Application
 
 In Unity editor, you can switch debug/release mode by “UIWidgets->EnableDebug”.
 
-If you want to change different mode in runtime, please modify the file “com.unity.uiwidgets/com.unity.uiwidgets/Runtime/foundation/debug.cs” by making “static bool debugEnableAtRuntimeInternal” to true or false. Note that the value is set to false by default.
+You can also enable debug mode in runtime by setting ```UIWidgetsGlobalConfiguration.EnableDebugAtRuntime = true``` in your project. Note that this value is set to false by default.
 
 ## Using Window Scope
 If you see the error `AssertionError: Window.instance is null` or null pointer error of `Window.instance`,

com.unity.uiwidgets/Runtime/engine/UIWidgetsGlobalConfiguration.cs

@@ -0,0 +1,12 @@
+namespace Unity.UIWidgets.engine {
+    public static class UIWidgetsGlobalConfiguration {
+        //disable auto adjust framerate by default
+        public static bool EnableAutoAdjustFramerate = false;
+
+        //enable incremental gc by default
+        public static bool EnableIncrementalGC = true;
+        
+        //disable debug at runtime by default
+        public static bool EnableDebugAtRuntime = false;
+    }
+}

com.unity.uiwidgets/Runtime/engine/UIWidgetsGlobalConfiguration.cs.meta

@@ -3,10 +3,13 @@
 using System.Collections.Generic;
 using Unity.UIWidgets.external.simplejson;
 using Unity.UIWidgets.foundation;
+using Unity.UIWidgets.rendering;
 using Unity.UIWidgets.ui;
 using Unity.UIWidgets.widgets;
 using UnityEngine;
 using UnityEngine.EventSystems;
+using UnityEngine.Profiling;
+using UnityEngine.Scripting;
 using UnityEngine.UI;
 using RawImage = UnityEngine.UI.RawImage;
 
@@ -146,17 +149,63 @@ void _handleViewMetricsChanged(string method, List<JSONNode> args) {
                 Window.instance.onMetricsChanged?.Invoke();
             }
         }
-        
+
         protected virtual void Update() {
             if (!_viewMetricsCallbackRegistered) {
                 _viewMetricsCallbackRegistered = true;
                 UIWidgetsMessageManager.instance?.AddChannelMessageDelegate("ViewportMetricsChanged",
                     _handleViewMetricsChanged);
             }
+            
+#if !UNITY_EDITOR
+            CollectGarbageOnDemand();
+#endif
 
             Input_Update();
         }
 
+        #region OnDemandGC
+#if !UNITY_EDITOR
+        // 8 MB
+        const long kCollectAfterAllocating = 8 * 1024 * 1024;
+        
+        long lastFrameMemory = 0;
+        long nextCollectAt = 0;
+
+        void TryEnableOnDemandGC() 
+        {
+            if (UIWidgetsGlobalConfiguration.EnableIncrementalGC)
+            {
+                GarbageCollector.GCMode = GarbageCollector.Mode.Disabled;
+                Application.lowMemory += GC.Collect;
+            }
+        }
+
+        void CollectGarbageOnDemand() 
+        {
+            if (!UIWidgetsGlobalConfiguration.EnableIncrementalGC)
+            {
+                return;
+            }
+            
+            var mem = Profiler.GetMonoUsedSizeLong();
+            if (mem < lastFrameMemory)
+            {
+                // GC happened.
+                nextCollectAt = mem + kCollectAfterAllocating;
+            }
+            else if (mem >= nextCollectAt)
+            {
+                // Trigger incremental GC
+                GarbageCollector.CollectIncremental(1000);
+                lastFrameMemory = mem + kCollectAfterAllocating;
+            }
+
+            lastFrameMemory = mem;
+        }
+#endif
+        #endregion
+
 #if !UNITY_EDITOR && UNITY_ANDROID
         bool AndroidInitialized = true;
 
@@ -185,6 +234,11 @@ protected void OnEnable() {
             //the hook API cannot be automatically called on IOS, so we need try hook it here
             Hooks.tryHook();
 #endif
+            
+#if !UNITY_EDITOR
+            TryEnableOnDemandGC();
+#endif
+
             base.OnEnable();
 
             D.assert(_wrapper == null);

com.unity.uiwidgets/Runtime/engine/UIWidgetsPanel.cs

@@ -52,8 +52,6 @@ public static class D {
         public static bool debugCheckIntrinsicSizes = false;
 
         public static bool debugPrintMouseHoverEvents = false;
-        
-        static bool debugEnableAtRuntimeInternal = false;
 
         public static HSVColor debugCurrentRepaintColor =
             HSVColor.fromAHSV(0.4f, 60.0f, 1.0f, 1.0f);
@@ -95,7 +93,7 @@ public static bool enableDebug {
             }
         }
 #else
-        public static bool enableDebug => debugEnableAtRuntimeInternal;
+        public static bool enableDebug => UIWidgetsGlobalConfiguration.EnableDebugAtRuntime;
 #endif
 
         public static void _debugDrawDoubleRect(Canvas canvas, Rect outerRect, Rect innerRect, Color color) { 

com.unity.uiwidgets/Runtime/foundation/debug.cs

@@ -440,9 +440,6 @@ public void ensureVisualUpdate() {
         static readonly TimeSpan _coolDownDelay = new TimeSpan(0, 0, 0, 0, 200);
         static Timer frameCoolDownTimer = null;
 
-        //disable auto adjust framerate by default
-        public static bool MEnableAutoAdjustFramerate = false;
-
         public void scheduleFrame() {
             if (hasScheduledFrame || !framesEnabled) {
                 return;
@@ -460,11 +457,14 @@ public void scheduleFrame() {
             Window.instance.scheduleFrame();
             hasScheduledFrame = true;
 
+#if !UNITY_EDITOR
             adjustFrameRate();
+#endif
         }
 
+#if !UNITY_EDITOR
         void adjustFrameRate() {
-            if (!MEnableAutoAdjustFramerate) {
+            if (!UIWidgetsGlobalConfiguration.EnableAutoAdjustFramerate) {
                 return;
             }
 
@@ -488,6 +488,7 @@ void onFrameRateSpeedUp() {
         void onFrameRateCoolDown() {
             OnDemandRendering.renderFrameInterval = defaultMaxRenderFrameInterval;
         }
+#endif
 
         public void scheduleForcedFrame() {
             if (!framesEnabled) {
@@ -510,7 +511,9 @@ public void scheduleForcedFrame() {
             Window.instance.scheduleFrame();
             hasScheduledFrame = true;
 
+#if !UNITY_EDITOR
             adjustFrameRate();
+#endif
         }
 
         public void scheduleWarmUpFrame() {