docs: rebuild Input API content

This commit is contained in:
2026-03-26 17:39:53 +08:00
parent ec4edb2689
commit ce2eee32e3
54 changed files with 1108 additions and 941 deletions

View File

@@ -1,31 +1,39 @@
# InputManager::IsKeyPressed
查询当前状态
查询一个键是否在本帧刚被按下
```cpp
bool IsKeyPressed(KeyCode key) const;
```
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
## 行为说明
**参数:**
- `key` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
当前实现判断条件是:
```cpp
#include <XCEngine/Input/InputManager.h>
m_keyDownThisFrame[index] && !m_keyDownLastFrame[index]
```
void Example() {
XCEngine::Input::InputManager object;
// 根据上下文补齐参数后调用 InputManager::IsKeyPressed(...)。
(void)object;
所以它表示的是“从上一帧到当前帧的按下边沿”。要得到正确结果,必须保证 [Update](Update.md) 每帧只在固定边界调用一次。
## 参数
- `key` - 要查询的键。
## 返回值
- `bool` - 当前帧是否刚按下。
## 示例
```cpp
if (XCEngine::Input::InputManager::Get().IsKeyPressed(XCEngine::Input::KeyCode::Space)) {
// ...
}
```
## 相关文档
- [返回类总览](InputManager.md)
- [返回模块目录](../Input.md)
- [返回类总览](InputManager.md)
- [Update](Update.md)
- [IsKeyDown](IsKeyDown.md)