refactor api documentation structure
This commit is contained in:
39
docs/api/XCEngine/Input/InputEvent/InputEvent.md
Normal file
39
docs/api/XCEngine/Input/InputEvent/InputEvent.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# InputEvent
|
||||
|
||||
**命名空间**: `XCEngine::Input`
|
||||
|
||||
**类型**: `struct`
|
||||
|
||||
**头文件**: `XCEngine/Input/InputEvent.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Input` 子目录中的 `InputEvent` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`InputEvent.h` 是 `XCEngine/Input` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `KeyEvent` | `struct` | 头文件中的公开声明。 |
|
||||
| `MouseButtonEvent` | `struct` | 头文件中的公开声明。 |
|
||||
| `MouseMoveEvent` | `struct` | 头文件中的公开声明。 |
|
||||
| `MouseWheelEvent` | `struct` | 头文件中的公开声明。 |
|
||||
| `TextInputEvent` | `struct` | 头文件中的公开声明。 |
|
||||
| `TouchState` | `struct` | 头文件中的公开声明。 |
|
||||
|
||||
## 结构体成员
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `keyCode` | `KeyCode` | 结构体公开字段。 | - |
|
||||
| `alt` | `bool` | 结构体公开字段。 | - |
|
||||
| `ctrl` | `bool` | 结构体公开字段。 | - |
|
||||
| `shift` | `bool` | 结构体公开字段。 | - |
|
||||
| `meta` | `bool` | 结构体公开字段。 | - |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Input.md) - 返回 `Input` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user