docs: rebuild Input API content
This commit is contained in:
@@ -1,34 +1,36 @@
|
||||
# InputManager::ProcessMouseMove
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
向输入系统注入一个鼠标移动事件。
|
||||
|
||||
```cpp
|
||||
void ProcessMouseMove(int x, int y, int deltaX, int deltaY);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `x` - 参数语义详见头文件声明。
|
||||
- `y` - 参数语义详见头文件声明。
|
||||
- `deltaX` - 参数语义详见头文件声明。
|
||||
- `deltaY` - 参数语义详见头文件声明。
|
||||
当前实现会:
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
- 如果未初始化,直接返回
|
||||
- 更新 `m_mousePosition`
|
||||
- 更新 `m_mouseDelta`
|
||||
- 构造 `MouseMoveEvent`
|
||||
- 同步触发 `m_onMouseMove`
|
||||
|
||||
**示例:**
|
||||
它不会累积一帧内的多次移动量,`m_mouseDelta` 始终是最近一次写入的值。
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Input/InputManager.h>
|
||||
## 参数
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::InputManager object;
|
||||
// 根据上下文补齐参数后调用 InputManager::ProcessMouseMove(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- `x` - 当前鼠标位置 X。
|
||||
- `y` - 当前鼠标位置 Y。
|
||||
- `deltaX` - 相对位移 X。
|
||||
- `deltaY` - 相对位移 Y。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](InputManager.md)
|
||||
- [返回模块目录](../Input.md)
|
||||
- [返回类型总览](InputManager.md)
|
||||
- [OnMouseMove](OnMouseMove.md)
|
||||
- [GetMouseDelta](GetMouseDelta.md)
|
||||
|
||||
Reference in New Issue
Block a user