xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: sync api and planning docs

Browse Source
This commit is contained in:
ssdfasd
2026-04-08 16:07:03 +08:00
parent 08c3278e10
commit 31756847ab
1826 changed files with 44502 additions and 29645 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/api/XCEngine/Platform/Windows/WindowsInputModule/WindowsInputModule.md
View File

@@ -6,30 +6,37 @@
**头文件**: `XCEngine/Platform/Windows/WindowsInputModule.h`
**描述**: 定义 `XCEngine/Platform/Windows` 子目录中的 `WindowsInputModule` public API。
**描述**: `InputModule` 的 Win32 实现，把窗口消息翻译成 `InputManager` 的键盘、鼠标和文本输入事件。
## 概述
`WindowsInputModule.h` 是 `XCEngine/Platform/Windows` 子目录 下的 public header，当前页面作为平行目录中的 canonical 总览，用于汇总该头文件暴露的主要声明。
`WindowsInputModule` 本身不拥有消息循环；它依赖窗口层把 Win32 消息喂给 [HandleMessage](HandleMessage.md)。按 `engine/src/Platform/Windows/WindowsInputModule.cpp` 的当前实现：
- [Initialize](Initialize.md) 只保存 `HWND`、重置鼠标位置并标记已初始化
- [PumpEvents](PumpEvents.md) 当前是空实现
- [HandleMessage](HandleMessage.md) 负责把 `WM_KEYDOWN`、`WM_MOUSEMOVE`、`WM_MOUSEWHEEL`、`WM_CHAR` 等消息转换成 `InputManager::Get()` 的调用
它是一个纯桥接层，真正的输入状态存储和按帧语义都在 `InputManager` 里。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `WindowsInputModule` | `class` | 继承自 `InputModule` 的公开声明。 |
| `WindowsInputModule` | `class` | `InputModule` 的 Win32 消息适配器。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [WindowsInputModule()](Constructor.md) | 构造对象。 |
| [~WindowsInputModule()](Destructor.md) | 销毁对象并释放相关资源。 |
| [Initialize](Initialize.md) | 初始化内部状态。 |
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
| [PumpEvents](PumpEvents.md) | 公开方法，详见头文件声明。 |
| [HandleMessage](HandleMessage.md) | 公开方法，详见头文件声明。 |
| [WindowsInputModule()](Constructor.md) | 初始化空句柄和未初始化状态。 |
| [~WindowsInputModule()](Destructor.md) | 析构时调用 [Shutdown](Shutdown.md)。 |
| [Initialize](Initialize.md) | 绑定窗口句柄并进入可处理消息状态。 |
| [Shutdown](Shutdown.md) | 清空窗口句柄并退出已初始化状态。 |
| [PumpEvents](PumpEvents.md) | 当前为空实现，消息处理实际发生在 [HandleMessage](HandleMessage.md)。 |
| [HandleMessage](HandleMessage.md) | 把 Win32 键盘 / 鼠标 / 字符消息翻译成 `InputManager` 调用。 |
## 相关文档
- [当前目录](../Windows.md) - 返回 `Windows` 平行目录
- [API 总索引](../../../../main.md) - 返回顶层索引
- [Windows](../Windows.md)
- [WindowsWindow](../WindowsWindow/WindowsWindow.md)
- [InputManager](../../../Input/InputManager/InputManager.md)