docs: rebuild Input API content
This commit is contained in:
@@ -1,30 +1,28 @@
|
||||
# InputManager::GetMousePosition
|
||||
|
||||
获取相关状态或对象。
|
||||
读取当前保存的鼠标位置。
|
||||
|
||||
```cpp
|
||||
Math::Vector2 GetMousePosition() const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现直接返回内部 `m_mousePosition`。该值由 [ProcessMouseMove](ProcessMouseMove.md) 或鼠标按钮/滚轮事件携带的位置间接更新。
|
||||
|
||||
**返回:** `Math::Vector2` - 返回值语义详见头文件声明。
|
||||
如果尚未收到任何鼠标输入,默认值通常是零向量。
|
||||
|
||||
**示例:**
|
||||
## 返回值
|
||||
|
||||
- `Math::Vector2` - 当前鼠标位置。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Input/InputManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::InputManager object;
|
||||
// 根据上下文补齐参数后调用 InputManager::GetMousePosition(...)。
|
||||
(void)object;
|
||||
}
|
||||
auto pos = XCEngine::Input::InputManager::Get().GetMousePosition();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](InputManager.md)
|
||||
- [返回模块目录](../Input.md)
|
||||
- [返回类型总览](InputManager.md)
|
||||
- [ProcessMouseMove](ProcessMouseMove.md)
|
||||
|
||||
Reference in New Issue
Block a user