Update docs from Cryville.Input.

This commit is contained in:
2023-05-09 11:17:49 +08:00
parent f5f1a5de67
commit d275f61602
2 changed files with 26 additions and 2 deletions

View File

@@ -50,11 +50,18 @@
<summary>
Occurs when a new input frame is sent.
</summary>
<remarks>
<para>There is no guarantee that frames are sent in the time order.</para>
</remarks>
</member>
<member name="E:Cryville.Input.InputHandler.OnBatch">
<summary>
Occurs when an input batch is finished sending.
</summary>
<remarks>
<para>This event occurs when the device can guarantee that all the active identifiers have sent all their frames before the given timestamp. There may be input frames with later timestamps sent before this event occurs. If an input identifier does not appears between two subsequent <see cref="E:Cryville.Input.InputHandler.OnBatch" /> events, then there is no update on it.</para>
<para>However, there is no guarantee that this event will occur when no input identifier is active.</para>
</remarks>
</member>
<member name="M:Cryville.Input.InputHandler.Finalize">
<inheritdoc />
@@ -128,9 +135,12 @@
</member>
<member name="M:Cryville.Input.InputHandler.Batch(System.Double)">
<summary>
Marks the end of the current input batch and starts a new batch.
Marks the end of an input batch.
</summary>
<param name="time">The timestamp of the input batch in seconds.</param>
<remarks>
<para>See <see cref="E:Cryville.Input.InputHandler.OnBatch" /> for more information.</para>
</remarks>
</member>
<member name="T:Cryville.Input.InputIdentifier">
<summary>

View File

@@ -52,11 +52,20 @@
<summary>
在新的输入帧被发送时发生。
</summary>
<remarks>
<para>不保证输入帧按时间顺序发送。</para>
</remarks>
</member>
<member name="E:Cryville.Input.InputHandler.OnBatch">
<summary>
在输入批次完成发送时发生。
</summary>
<remarks>
<para>
该事件在设备能够确认所有活跃的输入标识已经发送了给定时间戳之前的所有输入帧时发生。在该事件发生之前,可能会有时间戳大于本事件时间戳的输入帧被发送。如果一个输入标识在两次相邻的 <see cref="E:Cryville.Input.InputHandler.OnBatch" /> 事件之间没有出现的话,那么它就是没有更新。
</para>
<para>然而,在没有输入标识活跃的情况下,不保证该事件会发生。</para>
</remarks>
</member>
<member name="M:Cryville.Input.InputHandler.Finalize">
<inheritdoc />
@@ -138,9 +147,14 @@
</member>
<member name="M:Cryville.Input.InputHandler.Batch(System.Double)">
<summary>
当前的输入批次标记结束并开始新的批次
一个输入批次标记结束。
</summary>
<param name="time">输入批次的时间戳(秒)。</param>
<remarks>
<para>
详细信息参见 <see cref="E:Cryville.Input.InputHandler.OnBatch" />
</para>
</remarks>
</member>
<member name="T:Cryville.Input.InputIdentifier">
<summary>