Merge pull request #25 from Cysharp/feature/CurrentFrameProperty

Add ILogicLooper.CurrentFrame property

src/LogicLooper/ILogicLooper.cs

@@ -11,7 +11,7 @@ public interface ILogicLooper : IDisposable
     int Id { get; }
 
     /// <summary>
-    /// Gets an approximately count of running actions.
+    /// Gets an approximate count of running actions.
     /// </summary>
     int ApproximatelyRunningActions { get; }
 
@@ -25,6 +25,11 @@ public interface ILogicLooper : IDisposable
     /// </summary>
     double TargetFrameRate { get; }
 
+    /// <summary>
+    /// Gets a current frame that elapsed since beginning the looper is started.
+    /// </summary>
+    long CurrentFrame { get; }
+
     /// <summary>
     /// Registers a loop-frame action to the looper and returns <see cref="Task"/> to wait for completion.
     /// </summary>

src/LogicLooper/LogicLooper.cs

@@ -48,31 +48,26 @@ public sealed class LogicLooper : ILogicLooper, IDisposable
     private int _isShuttingDown = 0;
     private long _frame = 0;
 
-    /// <summary>
-    /// Gets a unique identifier of the looper.
-    /// </summary>
+    /// <inheritdoc/>
     public int Id => _looperId;
 
-    /// <summary>
-    /// Gets an approximately count of running actions.
-    /// </summary>
+    /// <inheritdoc/>
     public int ApproximatelyRunningActions => _tail;
 
-    /// <summary>
-    /// Gets a duration of the last processed frame.
-    /// </summary>
+    /// <inheritdoc/>
     public TimeSpan LastProcessingDuration => TimeSpan.FromMilliseconds(_lastProcessingDuration);
 
-    /// <summary>
-    /// Gets a target frame rate of the looper.
-    /// </summary>
+    /// <inheritdoc/>
     public double TargetFrameRate => _targetFrameRate;
 
     /// <summary>
     /// Gets a unique identifier of the managed thread.
     /// </summary>
     internal int ThreadId => _runLoopThread.ManagedThreadId;
 
+    /// <inheritdoc/>
+    public long CurrentFrame => _frame;
+
     public LogicLooper(int targetFrameRate, int initialActionsCapacity = 16)
         : this(TimeSpan.FromMilliseconds(1000 / (double)targetFrameRate), initialActionsCapacity)
     {

src/LogicLooper/ManualLogicLooper.cs

@@ -23,6 +23,9 @@ public sealed class ManualLogicLooper : ILogicLooper
     /// <inheritdoc />
     public double TargetFrameRate { get; }
 
+    /// <inheritdoc />
+    public long CurrentFrame => _frame;
+
     public ManualLogicLooper(double targetFrameRate)
     {
         if (targetFrameRate == 0) throw new ArgumentOutOfRangeException(nameof(targetFrameRate), "TargetFrameRate must be greater than 0.");

test/LogicLooper.Test/ManualLogicLooperTest.cs

@@ -53,12 +53,16 @@ public void Tick()
         looper.ApproximatelyRunningActions.Should().Be(1);
 
         count.Should().Be(0);
+        looper.CurrentFrame.Should().Be(0);
         looper.Tick().Should().BeTrue();
         count.Should().Be(1);
+        looper.CurrentFrame.Should().Be(1);
         looper.Tick().Should().BeTrue();
         count.Should().Be(2);
+        looper.CurrentFrame.Should().Be(2);
         looper.Tick().Should().BeFalse();
         count.Should().Be(3);
+        looper.CurrentFrame.Should().Be(3);
 
         looper.ApproximatelyRunningActions.Should().Be(0);
         t1.IsCompletedSuccessfully.Should().BeTrue();