refactor api documentation structure
This commit is contained in:
63
docs/api/XCEngine/Input/InputManager/InputManager.md
Normal file
63
docs/api/XCEngine/Input/InputManager/InputManager.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# InputManager
|
||||
|
||||
**命名空间**: `XCEngine::Input`
|
||||
|
||||
**类型**: `class (singleton)`
|
||||
|
||||
**头文件**: `XCEngine/Input/InputManager.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Input` 子目录中的 `InputManager` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`InputManager.h` 是 `XCEngine/Input` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `InputManager` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Get](Get.md) | 获取相关状态或对象。 |
|
||||
| [Initialize](Initialize.md) | 初始化内部状态。 |
|
||||
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
|
||||
| [Update](Update.md) | 更新运行时状态。 |
|
||||
| [IsKeyDown](IsKeyDown.md) | 查询当前状态。 |
|
||||
| [IsKeyUp](IsKeyUp.md) | 查询当前状态。 |
|
||||
| [IsKeyPressed](IsKeyPressed.md) | 查询当前状态。 |
|
||||
| [GetMousePosition](GetMousePosition.md) | 获取相关状态或对象。 |
|
||||
| [GetMouseDelta](GetMouseDelta.md) | 获取相关状态或对象。 |
|
||||
| [GetMouseScrollDelta](GetMouseScrollDelta.md) | 获取相关状态或对象。 |
|
||||
| [IsMouseButtonDown](IsMouseButtonDown.md) | 查询当前状态。 |
|
||||
| [IsMouseButtonUp](IsMouseButtonUp.md) | 查询当前状态。 |
|
||||
| [IsMouseButtonClicked](IsMouseButtonClicked.md) | 查询当前状态。 |
|
||||
| [GetTouchCount](GetTouchCount.md) | 获取相关状态或对象。 |
|
||||
| [GetTouch](GetTouch.md) | 获取相关状态或对象。 |
|
||||
| [GetAxis](GetAxis.md) | 获取相关状态或对象。 |
|
||||
| [GetAxisRaw](GetAxisRaw.md) | 获取相关状态或对象。 |
|
||||
| [GetButton](GetButton.md) | 获取相关状态或对象。 |
|
||||
| [GetButtonDown](GetButtonDown.md) | 获取相关状态或对象。 |
|
||||
| [GetButtonUp](GetButtonUp.md) | 获取相关状态或对象。 |
|
||||
| [RegisterAxis](RegisterAxis.md) | 注册对象、回调或映射。 |
|
||||
| [RegisterButton](RegisterButton.md) | 注册对象、回调或映射。 |
|
||||
| [ClearAxes](ClearAxes.md) | 清空内部数据。 |
|
||||
| [OnKeyEvent](OnKeyEvent.md) | 公开方法,详见头文件声明。 |
|
||||
| [OnMouseButton](OnMouseButton.md) | 公开方法,详见头文件声明。 |
|
||||
| [OnMouseMove](OnMouseMove.md) | 公开方法,详见头文件声明。 |
|
||||
| [OnMouseWheel](OnMouseWheel.md) | 公开方法,详见头文件声明。 |
|
||||
| [OnTextInput](OnTextInput.md) | 公开方法,详见头文件声明。 |
|
||||
| [ProcessKeyDown](ProcessKeyDown.md) | 公开方法,详见头文件声明。 |
|
||||
| [ProcessKeyUp](ProcessKeyUp.md) | 公开方法,详见头文件声明。 |
|
||||
| [ProcessMouseMove](ProcessMouseMove.md) | 公开方法,详见头文件声明。 |
|
||||
| [ProcessMouseButton](ProcessMouseButton.md) | 公开方法,详见头文件声明。 |
|
||||
| [ProcessMouseWheel](ProcessMouseWheel.md) | 公开方法,详见头文件声明。 |
|
||||
| [ProcessTextInput](ProcessTextInput.md) | 公开方法,详见头文件声明。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Input.md) - 返回 `Input` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user