Changed naming from RenderingFrame to DynamicUpdate

Author: ritamerkl

Assets/Samples/UIvsGameInput/UIvsGameInputHandler.cs

@@ -137,7 +137,7 @@ public void Update()
                     transform.rotation = default;
 
                 // When using a pointer-based control scheme, we engage camera look explicitly.
-                if (m_ControlStyle != ControlStyle.GamepadJoystick && m_LookEngageAction.WasPressedThisRenderingFrame() && IsPointerInsideScreen())
+                if (m_ControlStyle != ControlStyle.GamepadJoystick && m_LookEngageAction.WasPressedThisDynamicUpdate() && IsPointerInsideScreen())
                     EngageCameraControl();
 
                 // With gamepad/joystick, we can freely rotate the camera at any time.
@@ -166,14 +166,14 @@ public void Update()
                 if (m_Mouse != null)
                     m_MousePositionToWarpToAfterCursorUnlock = m_MousePositionToWarpToAfterCursorUnlock.Value + m_Mouse.delta.ReadValue();
 
-                if (m_CancelAction.WasPressedThisRenderingFrame() || !m_LookEngageAction.IsPressed())
+                if (m_CancelAction.WasPressedThisDynamicUpdate() || !m_LookEngageAction.IsPressed())
                     DisengageCameraControl();
 
                 break;
 
             case State.InMenu:
 
-                if (m_CancelAction.WasPressedThisRenderingFrame())
+                if (m_CancelAction.WasPressedThisDynamicUpdate())
                     OnContinueClicked();
 
                 break;

Assets/Tests/InputSystem/CoreTests_Actions.cs

@@ -69,24 +69,24 @@ public IEnumerator Actions_WasStateReachedThisRenderingFrameOperatesIndependentl
         var simpleAction = new InputAction(binding: "<Gamepad>/buttonSouth");
         simpleAction.Enable();
 
-        Assert.That(simpleAction.WasPerformedThisRenderingFrame(), Is.False);
-        Assert.That(simpleAction.WasPressedThisRenderingFrame(), Is.False);
-        Assert.That(simpleAction.WasReleasedThisRenderingFrame(), Is.False);
-        Assert.That(simpleAction.WasCompletedThisRenderingFrame(), Is.False);
+        Assert.That(simpleAction.WasPerformedThisDynamicUpdate(), Is.False);
+        Assert.That(simpleAction.WasPressedThisDynamicUpdate(), Is.False);
+        Assert.That(simpleAction.WasReleasedThisDynamicUpdate(), Is.False);
+        Assert.That(simpleAction.WasCompletedThisDynamicUpdate(), Is.False);
 
         PressAndRelease(gamepad.buttonSouth);
 
         yield return null; // InputSystem.Update is called and the action state chenges
 
-        Assert.That(simpleAction.WasPerformedThisRenderingFrame(), Is.True);
-        Assert.That(simpleAction.WasPressedThisRenderingFrame(), Is.True);
-        Assert.That(simpleAction.WasReleasedThisRenderingFrame(), Is.True);
+        Assert.That(simpleAction.WasPerformedThisDynamicUpdate(), Is.True);
+        Assert.That(simpleAction.WasPressedThisDynamicUpdate(), Is.True);
+        Assert.That(simpleAction.WasReleasedThisDynamicUpdate(), Is.True);
 
         InputSystem.Update(); // a manual update happens between two frames, that does not affect the output of the WasPerformedThisRenderingFrame
 
-        Assert.That(simpleAction.WasPerformedThisRenderingFrame(), Is.True);
-        Assert.That(simpleAction.WasPressedThisRenderingFrame(), Is.True);
-        Assert.That(simpleAction.WasReleasedThisRenderingFrame(), Is.True);
+        Assert.That(simpleAction.WasPerformedThisDynamicUpdate(), Is.True);
+        Assert.That(simpleAction.WasPressedThisDynamicUpdate(), Is.True);
+        Assert.That(simpleAction.WasReleasedThisDynamicUpdate(), Is.True);
 
         //Reset State
         InputSystem.settings.updateMode = updateMode;
@@ -160,13 +160,13 @@ public IEnumerator Actions_WasStateReachedThisFrameAndWasStateReachedThisRenderi
 
         yield return null;
 
-        Assert.That(simpleAction.WasPerformedThisRenderingFrame(), Is.True);
-        Assert.That(simpleAction.WasPressedThisRenderingFrame(), Is.True);
-        Assert.That(simpleAction.WasReleasedThisRenderingFrame(), Is.True);
+        Assert.That(simpleAction.WasPerformedThisDynamicUpdate(), Is.True);
+        Assert.That(simpleAction.WasPressedThisDynamicUpdate(), Is.True);
+        Assert.That(simpleAction.WasReleasedThisDynamicUpdate(), Is.True);
 
         yield return null;
 
-        Assert.That(simpleAction.WasCompletedThisRenderingFrame(), Is.False);
+        Assert.That(simpleAction.WasCompletedThisDynamicUpdate(), Is.False);
 
         //Reset State
         InputSystem.settings.updateMode = updateMode;

Packages/com.unity.inputsystem/InputSystem/Actions/InputAction.cs

@@ -1249,10 +1249,10 @@ private int ExpectedFrame()
         /// true for the duration of the frame even if the action was subsequently disabled in the frame.
         ///
         /// NOTE: If the <see cref="InputSettings.updateMode"/> is set to <see cref="InputSettings.UpdateMode.ProcessEventsInFixedUpdate"/> or <see cref="InputSettings.UpdateMode.ProcessEventsManually"/> and InputSystem.Update() is not called in
-        /// the dynamic Update, use <see cref="WasPressedThisRenderingFrame"/> during dynamic Update instead.
+        /// the dynamic Update, use <see cref="WasPressedThisDynamicUpdate"/> during dynamic Update instead.
         /// </remarks>
         /// <seealso cref="IsPressed"/>
-        /// <seealso cref="WasPressedThisRenderingFrame"/>
+        /// <seealso cref="WasPressedThisDynamicUpdate"/>
         /// <seealso cref="WasReleasedThisFrame"/>
         /// <seealso cref="CallbackContext.ReadValueAsButton"/>
         /// <seealso cref="WasPerformedThisFrame"/>
@@ -1293,7 +1293,7 @@ public unsafe bool WasPressedThisFrame()
         /// <seealso cref="WasReleasedThisFrame"/>
         /// <seealso cref="WasPerformedThisFrame"/>
         /// <seealso cref="InputSettings.updateMode"/>
-        public unsafe bool WasPressedThisRenderingFrame()
+        public unsafe bool WasPressedThisDynamicUpdate()
         {
             var state = GetOrCreateActionMap().m_State;
             if (state != null)
@@ -1335,10 +1335,10 @@ public unsafe bool WasPressedThisRenderingFrame()
         /// true for the duration of the frame even if the action was subsequently disabled in the frame.
         ///
         /// NOTE: If the <see cref="InputSettings.updateMode"/> is set to <see cref="InputSettings.UpdateMode.ProcessEventsInFixedUpdate"/> or <see cref="InputSettings.UpdateMode.ProcessEventsManually"/> and InputSystem.Update() is not called in
-        /// the dynamic Update, use <see cref="WasReleasedThisRenderingFrame"/> during dynamic Update instead.
+        /// the dynamic Update, use <see cref="WasReleasedThisDynamicUpdate"/> during dynamic Update instead.
         /// </remarks>
         /// <seealso cref="IsPressed"/>
-        /// <seealso cref="WasReleasedThisRenderingFrame"/>
+        /// <seealso cref="WasReleasedThisDynamicUpdate"/>
         /// <seealso cref="WasPressedThisFrame"/>
         /// <seealso cref="CallbackContext.ReadValueAsButton"/>
         /// <seealso cref="WasCompletedThisFrame"/>
@@ -1380,7 +1380,7 @@ public unsafe bool WasReleasedThisFrame()
         /// <seealso cref="CallbackContext.ReadValueAsButton"/>
         /// <seealso cref="WasCompletedThisFrame"/>
         /// <seealso cref="InputSettings.updateMode"/>
-        public unsafe bool WasReleasedThisRenderingFrame()
+        public unsafe bool WasReleasedThisDynamicUpdate()
         {
             var state = GetOrCreateActionMap().m_State;
             if (state != null)
@@ -1432,9 +1432,9 @@ public unsafe bool WasReleasedThisRenderingFrame()
         /// true for the duration of the frame even if the action was subsequently disabled in the frame.
         ///
         /// NOTE: If the <see cref="InputSettings.updateMode"/> is set to <see cref="InputSettings.UpdateMode.ProcessEventsInFixedUpdate"/> or <see cref="InputSettings.UpdateMode.ProcessEventsManually"/> and InputSystem.Update() is not called in
-        /// the dynamic Update, use <see cref="WasPerformedThisRenderingFrame"/> when trying to access in dynamic Update instead.
+        /// the dynamic Update, use <see cref="WasPerformedThisDynamicUpdate"/> when trying to access in dynamic Update instead.
         /// </remarks>
-        /// <seealso cref="WasPerformedThisRenderingFrame"/>
+        /// <seealso cref="WasPerformedThisDynamicUpdate"/>
         /// <seealso cref="WasCompletedThisFrame"/>
         /// <seealso cref="WasPressedThisFrame"/>
         /// <seealso cref="phase"/>
@@ -1474,7 +1474,7 @@ public unsafe bool WasPerformedThisFrame()
         /// <seealso cref="WasPressedThisFrame"/>
         /// <seealso cref="phase"/>
         /// <seealso cref="InputSettings.updateMode"/>
-        public unsafe bool WasPerformedThisRenderingFrame()
+        public unsafe bool WasPerformedThisDynamicUpdate()
         {
             var state = GetOrCreateActionMap().m_State;
 
@@ -1538,7 +1538,7 @@ public unsafe bool WasPerformedThisRenderingFrame()
         /// </para>
         /// <para>
         /// NOTE: If the <see cref="InputSettings.updateMode"/> is set to <see cref="InputSettings.UpdateMode.ProcessEventsInFixedUpdate"/> or <see cref="InputSettings.UpdateMode.ProcessEventsManually"/> and InputSystem.Update() is not called in
-        /// the dynamic Update, use <see cref="WasCompletedThisRenderingFrame"/> to access this during dynamic Update instead.
+        /// the dynamic Update, use <see cref="WasCompletedThisDynamicUpdate"/> to access this during dynamic Update instead.
         /// </para>
         /// </remarks>
         /// <example>
@@ -1550,7 +1550,7 @@ public unsafe bool WasPerformedThisRenderingFrame()
         ///     StopTeleport();
         /// </code>
         /// </example>
-        /// <seealso cref="WasCompletedThisRenderingFrame"/>
+        /// <seealso cref="WasCompletedThisDynamicUpdate"/>
         /// <seealso cref="WasPerformedThisFrame"/>
         /// <seealso cref="WasReleasedThisFrame"/>
         /// <seealso cref="phase"/>
@@ -1590,7 +1590,7 @@ public unsafe bool WasCompletedThisFrame()
         /// <seealso cref="WasPressedThisFrame"/>
         /// <seealso cref="phase"/>
         /// <seealso cref="InputSettings.updateMode"/>
-        public unsafe bool WasCompletedThisRenderingFrame()
+        public unsafe bool WasCompletedThisDynamicUpdate()
         {
             var state = GetOrCreateActionMap().m_State;
 

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

@@ -914,9 +914,9 @@ internal void ProcessNavigation(ref NavigationModel navigationState)
 
                 data.device = m_SubmitCancelState.device;
 
-                if (cancelAction != null && cancelAction.WasPerformedThisRenderingFrame())
+                if (cancelAction != null && cancelAction.WasPerformedThisDynamicUpdate())
                     ExecuteEvents.Execute(eventSystem.currentSelectedGameObject, data, ExecuteEvents.cancelHandler);
-                if (!data.used && submitAction != null && submitAction.WasPerformedThisRenderingFrame())
+                if (!data.used && submitAction != null && submitAction.WasPerformedThisDynamicUpdate())
                     ExecuteEvents.Execute(eventSystem.currentSelectedGameObject, data, ExecuteEvents.submitHandler);
             }
         }