From d6bcdd18c33b77a625b6e10f8cf1660497d25baf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 7 Jul 2022 22:45:32 +0200 Subject: [PATCH] Input: Re-enable input accumulation disabled by error in 3.4 Input accumulation was implemented and enabled by default in 3.1, and I don't recall major complaints around it (or bugs were fixed). In 3.4, #42220 added input buffering and apparently toggled input accumulation off by mistake. This led to multiple bug reports about degraded performance on Windows, or simply unexpected behavior change (see linked issues in #55037). Fixes #55037. --- doc/classes/Input.xml | 2 +- doc/classes/InputEventMouseMotion.xml | 2 +- main/input_default.cpp | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index e3580025a01a..49f94cc99b72 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -400,7 +400,7 @@ If [code]true[/code], similar input events sent by the operating system are accumulated. 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 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. - [b]Note:[/b] Input accumulation is [i]disabled[/i] by default for backward compatibility reasons. It is however recommended to enable it for games which don't require very reactive input, as this will decrease CPU usage. + [b]Note:[/b] Input accumulation is [i]enabled[/i] by default. It is recommended to keep it enabled for games which don't require very reactive input, as this will decrease CPU usage. diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 93ddf4343a11..5fe922d71a9c 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -5,7 +5,7 @@ Contains mouse and pen motion information. Supports relative, absolute positions and speed. See [method Node._input]. - [b]Note:[/b] By default, this event can be emitted multiple times per frame rendered, allowing for precise input reporting, at the expense of CPU usage. You can set [member Input.use_accumulated_input] to [code]true[/code] to let multiple events merge into a single emitted event per frame. + [b]Note:[/b] The behavior of this event is affected by the value of [member Input.use_accumulated_input]. When set to [code]true[/code] (default), mouse/pen motion events received from the OS will be merged to emit an accumulated event only once per frame rendered at most. When set to [code]false[/code], the events will be emitted as received, which means that they can be emitted multiple times per frame rendered, allowing for precise input reporting at the expense of CPU usage. [b]Note:[/b] If you use InputEventMouseMotion to draw lines, consider implementing [url=https://en.wikipedia.org/wiki/Bresenham%27s_line_algorithm]Bresenham's line algorithm[/url] as well to avoid visible gaps in lines if the user is moving the mouse quickly. diff --git a/main/input_default.cpp b/main/input_default.cpp index d0cae2f63964..2d0e9344ba80 100644 --- a/main/input_default.cpp +++ b/main/input_default.cpp @@ -748,7 +748,7 @@ void InputDefault::release_pressed_events() { InputDefault::InputDefault() { use_input_buffering = false; - use_accumulated_input = false; + use_accumulated_input = true; mouse_button_mask = 0; emulate_touch_from_mouse = false; emulate_mouse_from_touch = false;