Improve Director stepFrame logic (#3221)

Author: halx99

axmol/base/Director.cpp

@@ -424,7 +424,7 @@ void Director::calculateDeltaTime()
     }
     else
     {
-        // delta time may passed by invoke renderFrame(dt)
+        // delta time may passed by invoke stepFrame(dt)
         if (!_deltaTimePassedByCaller)
         {
             auto now    = std::chrono::steady_clock::now();
@@ -1580,7 +1580,7 @@ void Director::performFrameTasks(FrameTaskQueue& frameTasks)
     }
 }
 
-void Director::renderFrame()
+void Director::stepFrame()
 {
     if (_cleanupDirectorInNextLoop)
     {
@@ -1591,18 +1591,19 @@ void Director::renderFrame()
     {
         _restartDirectorInNextLoop = false;
         restartDirector();
+        _renderView->pollEvents();
     }
     else if (!_invalid)
     {
         processFrame();
     }
 }
 
-void Director::renderFrame(float dt)
+void Director::stepFrame(float dt)
 {
     _deltaTime               = dt;
     _deltaTimePassedByCaller = true;
-    renderFrame();
+    stepFrame();
 }
 
 void Director::stopAnimation()

axmol/base/Director.h

@@ -424,12 +424,12 @@ class AX_DLL Director
     void setClearColor(const Color& clearColor);
     const Color& getClearColor() const { return _clearColor; }
 
-    [[internal]] void renderFrame();
-    /** Invoke render frame with delta time. Then `calculateDeltaTime` can just use the delta time directly.
-     * The delta time paseed may include vsync time. See issue #17806
+    [[internal]] void stepFrame();
+    /** Invoke frame step with delta time. Then `calculateDeltaTime` can just use the delta time directly.
+     * The delta time passed may include vsync time. See issue #17806
      * @since 3.16
      */
-    [[internal]] void renderFrame(float dt);
+    [[internal]] void stepFrame(float dt);
 
     /** The size in pixels of the surface. It could be different than the screen size.
      * High-res devices might have a higher surface size than the screen size.
@@ -583,8 +583,9 @@ class AX_DLL Director
      */
     bool isValid() const { return !_invalid; }
 
+protected:
     /**
-     * Advance one frame of the engine loop.
+     * Process one frame of the engine loop.
      *
      * This method is invoked automatically once per frame by the Director.
      * It drives both the game logic update and the rendering pipeline:
@@ -598,7 +599,6 @@ class AX_DLL Director
      */
     [[internal]] void processFrame();
 
-protected:
     static void performFrameTasks(FrameTaskQueue& frameTasks);
 
     void performFrameBoundaryTasks();

axmol/platform/android/java/src/dev/axmol/lib/AxmolPlayer.java

@@ -303,7 +303,7 @@ public void onDrawFrame() {
         /*
          * Render time MUST be counted in, or the FPS will slower than appointed.
          */
-        nativeRenderFrame();
+        nativeStepFrame();
         /*
          * No need to use algorithm in default(60,90,120... FPS) situation,
          * since onDrawFrame() was called by system 60 times per second by default.
@@ -746,7 +746,7 @@ public void onGetContentRect(android.view.ActionMode mode, View view, android.gr
     // Native methods for AxmolPlayer
     // ===========================================================
 
-    public static native void nativeRenderFrame();
+    public static native void nativeStepFrame();
 
     public static native void nativeOnResume();
 

axmol/platform/android/jni/AxmolPlayerJni.cpp

@@ -173,9 +173,9 @@ JNIEXPORT void JNICALL Java_dev_axmol_lib_AxmolPlayer_nativeOnSurfaceChanged(JNI
     }
 }
 
-JNIEXPORT void JNICALL Java_dev_axmol_lib_AxmolPlayer_nativeRenderFrame(JNIEnv*, jclass)
+JNIEXPORT void JNICALL Java_dev_axmol_lib_AxmolPlayer_nativeStepFrame(JNIEnv*, jclass)
 {
-    ax::Director::getInstance()->renderFrame();
+    ax::Director::getInstance()->stepFrame();
 }
 
 JNIEXPORT void JNICALL

axmol/platform/ios/DirectorCaller-ios.mm

@@ -187,7 +187,7 @@ - (void)doCaller:(id)sender
 #endif
         CFTimeInterval dt = ((CADisplayLink*)displayLink).timestamp - lastDisplayTime;
         lastDisplayTime   = ((CADisplayLink*)displayLink).timestamp;
-        director->renderFrame(dt);
+        director->stepFrame(dt);
     }
 }
 

axmol/platform/ios/RenderHostView-ios.mm

@@ -324,7 +324,7 @@ - (void)layoutSubviews
 
     // Avoid flicker. Issue #350
     if ([NSThread isMainThread])
-        director->processFrame();
+        director->stepFrame();
 }
 
 - (void)swapBuffers

axmol/platform/linux/Application-linux.cpp

@@ -71,8 +71,7 @@ int Application::run()
 
         director->performFrameBoundaryTasks();
 
-        director->renderFrame();
-        renderView->pollEvents();
+        director->stepFrame();
 
         auto interval = std::chrono::steady_clock::now() - lastTime;
         if (interval < _animationInterval)
@@ -86,14 +85,14 @@ int Application::run()
         }
     }
     /* Only work on Desktop
-     *  Director::renderFrame is really one frame logic
+     *  Director::stepFrame is really one frame logic
      *  when we want to close the window, we should call Director::end();
-     *  then call Director::renderFrame to do release of internal resources
+     *  then call Director::stepFrame to do release of internal resources
      */
     if (renderView->isGfxContextReady())
     {
         director->end();
-        director->renderFrame();
+        director->stepFrame();
         director = nullptr;
     }
     renderView->release();

axmol/platform/mac/Application-mac.mm

@@ -73,8 +73,7 @@ of this software and associated documentation files (the "Software"), to deal
         lastTime = std::chrono::steady_clock::now();
 
         director->performFrameBoundaryTasks();
-        director->renderFrame();
-        renderView->pollEvents();
+        director->stepFrame();
 
         auto interval     = std::chrono::steady_clock::now() - lastTime;
         auto waitDuration = _animationInterval - interval - _1ms;
@@ -85,14 +84,14 @@ of this software and associated documentation files (the "Software"), to deal
     }
 
     /* Only work on Desktop
-     *  Director::renderFrame is really one frame logic
+     *  Director::stepFrame is really one frame logic
      *  when we want to close the window, we should call Director::end();
-     *  then call Director::renderFrame to do release of internal resources
+     *  then call Director::stepFrame to do release of internal resources
      */
     if (renderView->isGfxContextReady())
     {
         director->end();
-        director->renderFrame();
+        director->stepFrame();
     }
 
     renderView->release();

axmol/platform/wasm/Application-wasm.cpp

@@ -102,7 +102,7 @@ static int s_targetFPS        = 0;    // 0 = follow browser refresh rate
 static double s_lastFrameTime = 0.0;  // ms
 static double s_accumulator   = 0.0;  // ms
 
-static void renderFrame();
+static void stepFrame();
 
 static void updateFrame()
 {
@@ -112,7 +112,7 @@ static void updateFrame()
     // First frame: render immediately
     if (s_lastFrameTime <= 0.0) [[unlikely]]
     {
-        renderFrame();
+        stepFrame();
         s_lastFrameTime = now;
         return;
     }
@@ -124,7 +124,7 @@ static void updateFrame()
     if (delta > 1000.0) [[unlikely]]
     {
         s_accumulator = 0.0;
-        renderFrame();
+        stepFrame();
         return;
     }
 
@@ -133,28 +133,27 @@ static void updateFrame()
     // If targetFPS is 0, follow browser refresh rate directly
     if (s_targetFPS <= 0)
     {
-        renderFrame();
+        stepFrame();
         return;
     }
 
     // Frame skipping logic based on accumulator
     double targetInterval = 1000.0 / s_targetFPS;
     if (s_accumulator >= targetInterval)
     {
-        renderFrame();
+        stepFrame();
         s_accumulator -= targetInterval;
         if (s_accumulator < 0.0) [[unlikely]]  // floating-point safety
             s_accumulator = 0.0;
     }  // else onIdle
 }
 
-static void renderFrame()
+static void stepFrame()
 {
     auto director   = __director;
     auto renderView = director->getRenderView();
 
-    director->renderFrame();
-    renderView->pollEvents();
+    director->stepFrame();
 
     if (renderView->windowShouldClose())
     {
@@ -164,7 +163,7 @@ static void renderFrame()
         if (renderView->isGfxContextReady())
         {
             director->end();
-            director->renderFrame();
+            director->stepFrame();
         }
         renderView->release();
 

axmol/platform/win32/Application-win32.cpp

@@ -111,8 +111,7 @@ int Application::run()
         if (interval >= _animationInterval.QuadPart)
         {
             nLast.QuadPart = nNow.QuadPart;
-            director->renderFrame();
-            renderView->pollEvents();
+            director->stepFrame();
         }
         else
         {
@@ -131,7 +130,7 @@ int Application::run()
     if (renderView->isGfxContextReady())
     {
         director->end();
-        director->renderFrame();
+        director->stepFrame();
         director = nullptr;
     }
     renderView->release();