docs: rebuild Input API content
This commit is contained in:
@@ -1,30 +1,30 @@
|
||||
# InputManager::GetMouseDelta
|
||||
|
||||
获取相关状态或对象。
|
||||
读取当前帧保存的鼠标位移。
|
||||
|
||||
```cpp
|
||||
Math::Vector2 GetMouseDelta() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现返回最近一次 [ProcessMouseMove](ProcessMouseMove.md) 写入的 `m_mouseDelta`。它有两个重要特点:
|
||||
|
||||
**返回:** `Math::Vector2` - 返回值语义详见头文件声明。
|
||||
- 不是累加值,而是最近一次输入事件的 delta
|
||||
- 会在 [Update](Update.md) 时被重置为 `Vector2::Zero()`
|
||||
|
||||
**示例:**
|
||||
## 返回值
|
||||
|
||||
- `Math::Vector2` - 当前保存的鼠标位移。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Input/InputManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::InputManager object;
|
||||
// 根据上下文补齐参数后调用 InputManager::GetMouseDelta(...)。
|
||||
(void)object;
|
||||
}
|
||||
auto delta = XCEngine::Input::InputManager::Get().GetMouseDelta();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](InputManager.md)
|
||||
- [返回模块目录](../Input.md)
|
||||
- [返回类型总览](InputManager.md)
|
||||
- [ProcessMouseMove](ProcessMouseMove.md)
|
||||
- [Update](Update.md)
|
||||
|
||||
Reference in New Issue
Block a user