-
Notifications
You must be signed in to change notification settings - Fork 328
DOCS: New Timing and Latency section (DOCF-1179) #1994
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 14 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
9b6e879
Timing and latency section
duckets b7aac50
Merge branch 'develop' into docf-1179-fixedupdate-vs-update
duckets 824f4db
removed stray escape characters in code samples
duckets c1ca398
Small edits and formatting fixes
duckets 72504b5
Formatting pass
duckets 980e27f
fix broken link
duckets e885d83
minor edits
duckets 30978c8
ongoing corrections from peer review WIP
duckets 343d88f
Merge branch 'develop' into docf-1179-fixedupdate-vs-update
duckets 40ef239
renamed file link fixes
duckets 669e8a5
Merge remote-tracking branch 'origin/docf-1179-fixedupdate-vs-update'…
duckets faa6438
Completed landing page links section
duckets ed28ae2
fixed broken link (xref not working)
duckets 6352eb0
Merge branch 'develop' into docf-1179-fixedupdate-vs-update
duckets f9aa7bb
Update Packages/com.unity.inputsystem/Documentation~/timing-input-eve…
duckets b9b49ca
Update Packages/com.unity.inputsystem/Documentation~/timing-select-mo…
duckets cb59eac
Update Packages/com.unity.inputsystem/Documentation~/timing-select-mo…
duckets e4fdd5e
Update Packages/com.unity.inputsystem/Documentation~/timing-optimize-…
duckets f1a105b
Update Packages/com.unity.inputsystem/Documentation~/timing-optimize-…
duckets 336f3c9
Update Packages/com.unity.inputsystem/Documentation~/timing-mixed-sce…
duckets 2201f7e
Update Packages/com.unity.inputsystem/Documentation~/timing-mixed-sce…
duckets 489ea04
Update Packages/com.unity.inputsystem/Documentation~/timing-select-mo…
duckets b0da146
Update Packages/com.unity.inputsystem/Documentation~/timing-select-mo…
duckets 744411f
Merge branch 'develop' into docf-1179-fixedupdate-vs-update
duckets e088c49
Merge branch 'develop' into docf-1179-fixedupdate-vs-update
AlexTyrer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+19.5 KB
Packages/com.unity.inputsystem/Documentation~/Images/TimingEventGrouping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+51.5 KB
Packages/com.unity.inputsystem/Documentation~/Images/TimingFastFPS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+48.4 KB
Packages/com.unity.inputsystem/Documentation~/Images/TimingInputsPerFrame.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+60.4 KB
Packages/com.unity.inputsystem/Documentation~/Images/TimingSlowFPS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+42 KB
Packages/com.unity.inputsystem/Documentation~/Images/TimingUnprocessedTime.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
Packages/com.unity.inputsystem/Documentation~/timing-and-latency.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
uid: timing-latency | ||
--- | ||
# Timing and Latency | ||
|
||
Input Timing refers to the topic of exactly when the Input System receives and processes input from devices. | ||
|
||
Latency is the amount of time between the user providing some input, and the user receiving a response to that input. For example, the time between a button press and your game’s character moving on-screen. In fast-paced input scenarios such as action games, even tiny delays between the user's input and your game responding can be noticeable and affect the feel of your gameplay. | ||
|
||
In addition to the effects of latency, timing can affect one-off discrete events such as when a button press starts or finishes. Checking for these at the wrong time can result in missed or duplicate events. | ||
|
||
To minimize input latency, and to avoid missed or duplicate events, it helps to understand how the Input System processes events in relation to Unity's frame updates, physics updates, and fixed updates. This will help you make decisions about how to read and respond to input in your game or app. | ||
|
||
| **Topic** | **Description** | | ||
| :------------------------------ | :------------------------------- | | ||
| **[Input events queue](timing-input-events-queue.md)** | Understand how and when the Input System receives and processes input from devices. | | ||
| **[Select an input processing mode](timing-select-mode.md)** | How to select an appropriate **Update Mode** which controls when the Input System processes queued input events. | | ||
| **[Optimize for dynamic update](timing-optimize-dynamic-update.md)** | How to optimize input for use in `Update` calls. | | ||
| **[Optimize for fixed update](timing-optimize-fixed-update.md)** | How to optimize input for use in `FixedUpdate` calls. | | ||
| **[Avoid missed or duplicate events](timing-missed-duplicate-events.md)** | How to avoid missing or duplicated discrete input events like when a button was pressed or released. | | ||
| **[Mixed timing scenarios](timing-mixed-scenarios.md)** | How to optimize and avoid problems when using input in both `Update` and `FixedUpdate` calls. | |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.