refactor api documentation structure

This commit is contained in:
2026-03-26 16:45:24 +08:00
parent 45842e961e
commit 6244b586bb
4389 changed files with 80504 additions and 69241 deletions

View File

@@ -0,0 +1,30 @@
# InputManager::ClearAxes
清空内部数据。
```cpp
void ClearAxes();
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::ClearAxes(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,29 @@
# InputManager::Get
获取相关状态或对象。
```cpp
static InputManager& Get();
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `InputManager&` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
auto& instance = XCEngine::Input::InputManager::Get();
(void)instance;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::GetAxis
获取相关状态或对象。
```cpp
float GetAxis(const Containers::String& axisName) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `axisName` - 参数语义详见头文件声明。
**返回:** `float` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetAxis(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::GetAxisRaw
获取相关状态或对象。
```cpp
float GetAxisRaw(const Containers::String& axisName) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `axisName` - 参数语义详见头文件声明。
**返回:** `float` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetAxisRaw(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::GetButton
获取相关状态或对象。
```cpp
bool GetButton(const Containers::String& buttonName) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `buttonName` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetButton(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::GetButtonDown
获取相关状态或对象。
```cpp
bool GetButtonDown(const Containers::String& buttonName) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `buttonName` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetButtonDown(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::GetButtonUp
获取相关状态或对象。
```cpp
bool GetButtonUp(const Containers::String& buttonName) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `buttonName` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetButtonUp(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::GetMouseDelta
获取相关状态或对象。
```cpp
Math::Vector2 GetMouseDelta() const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `Math::Vector2` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetMouseDelta(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::GetMousePosition
获取相关状态或对象。
```cpp
Math::Vector2 GetMousePosition() const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `Math::Vector2` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetMousePosition(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::GetMouseScrollDelta
获取相关状态或对象。
```cpp
float GetMouseScrollDelta() const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `float` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetMouseScrollDelta(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::GetTouch
获取相关状态或对象。
```cpp
TouchState GetTouch(int index) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `index` - 参数语义详见头文件声明。
**返回:** `TouchState` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetTouch(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::GetTouchCount
获取相关状态或对象。
```cpp
int GetTouchCount() const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `int` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::GetTouchCount(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::Initialize
初始化内部状态。
```cpp
void Initialize(void* platformWindowHandle);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `platformWindowHandle` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::Initialize(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View 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) - 返回顶层索引

View File

@@ -0,0 +1,31 @@
# InputManager::IsKeyDown
查询当前状态。
```cpp
bool IsKeyDown(KeyCode key) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `key` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::IsKeyDown(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::IsKeyPressed
查询当前状态。
```cpp
bool IsKeyPressed(KeyCode key) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `key` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::IsKeyPressed(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::IsKeyUp
查询当前状态。
```cpp
bool IsKeyUp(KeyCode key) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `key` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::IsKeyUp(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::IsMouseButtonClicked
查询当前状态。
```cpp
bool IsMouseButtonClicked(MouseButton button) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `button` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::IsMouseButtonClicked(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::IsMouseButtonDown
查询当前状态。
```cpp
bool IsMouseButtonDown(MouseButton button) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `button` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::IsMouseButtonDown(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::IsMouseButtonUp
查询当前状态。
```cpp
bool IsMouseButtonUp(MouseButton button) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `button` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::IsMouseButtonUp(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::OnKeyEvent
公开方法,详见头文件声明。
```cpp
Core::Event<const KeyEvent&>& OnKeyEvent();
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `Core::Event<const KeyEvent&>&` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::OnKeyEvent(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::OnMouseButton
公开方法,详见头文件声明。
```cpp
Core::Event<const MouseButtonEvent&>& OnMouseButton();
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `Core::Event<const MouseButtonEvent&>&` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::OnMouseButton(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::OnMouseMove
公开方法,详见头文件声明。
```cpp
Core::Event<const MouseMoveEvent&>& OnMouseMove();
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `Core::Event<const MouseMoveEvent&>&` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::OnMouseMove(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::OnMouseWheel
公开方法,详见头文件声明。
```cpp
Core::Event<const MouseWheelEvent&>& OnMouseWheel();
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `Core::Event<const MouseWheelEvent&>&` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::OnMouseWheel(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::OnTextInput
公开方法,详见头文件声明。
```cpp
Core::Event<const TextInputEvent&>& OnTextInput();
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `Core::Event<const TextInputEvent&>&` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::OnTextInput(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,36 @@
# InputManager::ProcessKeyDown
公开方法,详见头文件声明。
```cpp
void ProcessKeyDown(KeyCode key, bool repeat, bool alt, bool ctrl, bool shift, bool meta);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `key` - 参数语义详见头文件声明。
- `repeat` - 参数语义详见头文件声明。
- `alt` - 参数语义详见头文件声明。
- `ctrl` - 参数语义详见头文件声明。
- `shift` - 参数语义详见头文件声明。
- `meta` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::ProcessKeyDown(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,35 @@
# InputManager::ProcessKeyUp
公开方法,详见头文件声明。
```cpp
void ProcessKeyUp(KeyCode key, bool alt, bool ctrl, bool shift, bool meta);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `key` - 参数语义详见头文件声明。
- `alt` - 参数语义详见头文件声明。
- `ctrl` - 参数语义详见头文件声明。
- `shift` - 参数语义详见头文件声明。
- `meta` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::ProcessKeyUp(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,34 @@
# InputManager::ProcessMouseButton
公开方法,详见头文件声明。
```cpp
void ProcessMouseButton(MouseButton button, bool pressed, int x, int y);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `button` - 参数语义详见头文件声明。
- `pressed` - 参数语义详见头文件声明。
- `x` - 参数语义详见头文件声明。
- `y` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::ProcessMouseButton(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,34 @@
# InputManager::ProcessMouseMove
公开方法,详见头文件声明。
```cpp
void ProcessMouseMove(int x, int y, int deltaX, int deltaY);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `x` - 参数语义详见头文件声明。
- `y` - 参数语义详见头文件声明。
- `deltaX` - 参数语义详见头文件声明。
- `deltaY` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::ProcessMouseMove(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,33 @@
# InputManager::ProcessMouseWheel
公开方法,详见头文件声明。
```cpp
void ProcessMouseWheel(float delta, int x, int y);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `delta` - 参数语义详见头文件声明。
- `x` - 参数语义详见头文件声明。
- `y` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::ProcessMouseWheel(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::ProcessTextInput
公开方法,详见头文件声明。
```cpp
void ProcessTextInput(char c);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `c` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::ProcessTextInput(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::RegisterAxis
注册对象、回调或映射。
```cpp
void RegisterAxis(const InputAxis& axis);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `axis` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::RegisterAxis(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,32 @@
# InputManager::RegisterButton
注册对象、回调或映射。
```cpp
void RegisterButton(const Containers::String& name, KeyCode key);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `name` - 参数语义详见头文件声明。
- `key` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::RegisterButton(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,30 @@
# InputManager::Shutdown
关闭并清理内部状态。
```cpp
void Shutdown();
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::Shutdown(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,31 @@
# InputManager::Update
更新运行时状态。
```cpp
void Update(float deltaTime);
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
**参数:**
- `deltaTime` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputManager.h>
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::Update(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)