docs: rebuild Input API content
This commit is contained in:
@@ -1,30 +1,20 @@
|
||||
# InputModule::PumpEvents
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
主动轮询平台事件。
|
||||
|
||||
```cpp
|
||||
virtual void PumpEvents() = 0;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Input/InputModule.h`,当前页面用于固定 `InputModule` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
这个接口用于那些需要主动从平台消息队列拉取输入事件的后端。当前 Windows 实现提供了该方法,但方法体为空,因为现有路径主要通过外部窗口消息回调调用 `HandleMessage`。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
## 返回值
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Input/InputModule.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::InputModule object;
|
||||
// 根据上下文补齐参数后调用 InputModule::PumpEvents(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 无。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](InputModule.md)
|
||||
- [返回模块目录](../Input.md)
|
||||
- [返回类型总览](InputModule.md)
|
||||
- [HandleMessage](HandleMessage.md)
|
||||
|
||||
Reference in New Issue
Block a user