瀏覽代碼

Improve the `Input.set_use_accumulated_input()` documentation

(cherry picked from commit 30961c60ab84e3234d9eb1d92b70ec2634bb6b6c)
Hugo Locurcio 5 年之前
父節點
當前提交
b5f1f7dfde
共有 1 個文件被更改,包括 2 次插入1 次删除
  1. 2 1
      doc/classes/Input.xml

+ 2 - 1
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">