docs: rebuild Input API content
This commit is contained in:
@@ -1,31 +1,24 @@
|
||||
# InputManager::IsMouseButtonDown
|
||||
|
||||
查询当前状态。
|
||||
查询鼠标按键当前是否按下。
|
||||
|
||||
```cpp
|
||||
bool IsMouseButtonDown(MouseButton button) const;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Input/InputManager.h`,当前页面用于固定 `InputManager` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `button` - 参数语义详见头文件声明。
|
||||
如果未初始化或按钮索引越界,当前实现返回 `false`。否则返回 `m_mouseButtonDown[index]`。
|
||||
|
||||
**返回:** `bool` - 返回值语义详见头文件声明。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- `button` - 要查询的鼠标按键。
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Input/InputManager.h>
|
||||
## 返回值
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::InputManager object;
|
||||
// 根据上下文补齐参数后调用 InputManager::IsMouseButtonDown(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- `bool` - 当前是否按下。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](InputManager.md)
|
||||
- [返回模块目录](../Input.md)
|
||||
- [返回类型总览](InputManager.md)
|
||||
- [IsMouseButtonUp](IsMouseButtonUp.md)
|
||||
|
||||
Reference in New Issue
Block a user