diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-03-12 22:23:13 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-12 22:23:13 +0100 |
| commit | 474b15f811ed92326f97b8f29c8dbc409613fb5d (patch) | |
| tree | 2a1133a9ce71b6343217dd07bf1e35c85097e9a8 /doc | |
| parent | 36a414eb03608dcef1444230e1c29790bde9c949 (diff) | |
| parent | 30961c60ab84e3234d9eb1d92b70ec2634bb6b6c (diff) | |
Merge pull request #37006 from Calinou/doc-improve-input-accumulation
Improve the `Input.set_use_accumulated_input()` documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Input.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 557a63b1cc..0f212e7498 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -349,7 +349,8 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Whether to accumulate similar input events sent by the operating system. Enabled by default. + Enables or disables the accumulation of similar input events sent by the operating system. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS. + Input accumulation is enabled by default. It can be disabled to get slightly more precise/reactive input at the cost of increased CPU usage. In applications where drawing freehand lines is required, input accumulation should generally be disabled while the user is drawing the line to get results that closely follow the actual input. </description> </method> <method name="start_joy_vibration"> |