docs: rebuild Input API content
This commit is contained in:
@@ -1,31 +1,45 @@
|
||||
# InputManager::Initialize
|
||||
|
||||
初始化内部状态。
|
||||
初始化输入状态缓存并注册默认逻辑映射。
|
||||
|
||||
```cpp
|
||||
void Initialize(void* platformWindowHandle);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `platformWindowHandle` - 参数语义详见头文件声明。
|
||||
当前实现是幂等的:如果已经初始化,直接返回。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
首次初始化时,它会:
|
||||
|
||||
**示例:**
|
||||
- 保存 `platformWindowHandle`
|
||||
- 分配 256 槽键盘状态数组
|
||||
- 分配 5 槽鼠标按键状态数组
|
||||
- 分配 32 槽按钮瞬时状态数组
|
||||
- 注册默认轴和按钮映射
|
||||
- 把 `m_initialized` 设为 `true`
|
||||
|
||||
当前没有做的事情:
|
||||
|
||||
- 不会清空事件监听器
|
||||
- 不会校验窗口句柄
|
||||
- 不会启动平台事件循环
|
||||
|
||||
## 参数
|
||||
|
||||
- `platformWindowHandle` - 平台窗口句柄;当前会保存下来,但 `InputManager` 本身不直接使用它。
|
||||
|
||||
## 返回值
|
||||
|
||||
- 无。
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Input/InputManager.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::InputManager object;
|
||||
// 根据上下文补齐参数后调用 InputManager::Initialize(...)。
|
||||
(void)object;
|
||||
}
|
||||
XCEngine::Input::InputManager::Get().Initialize(windowHandle);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](InputManager.md)
|
||||
- [返回模块目录](../Input.md)
|
||||
- [返回类型总览](InputManager.md)
|
||||
- [Shutdown](Shutdown.md)
|
||||
|
||||
Reference in New Issue
Block a user