docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录 - 重命名 index.md 为 main.md - 修正所有模块文档中的错误: - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式 - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节 - core: 修复 types 链接错误 - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI - memory: 修复头文件路径, malloc vs operator new, 新增方法文档 - resources: 修复 Shader/Texture 链接错误 - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接 - 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
43
docs/api/core/event/Invoke.md
Normal file
43
docs/api/core/event/Invoke.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Event::Invoke
|
||||
|
||||
```cpp
|
||||
void Invoke(Args... args);
|
||||
```
|
||||
|
||||
调用所有订阅的回调。
|
||||
|
||||
**描述**
|
||||
|
||||
依次调用所有已订阅的回调函数。在调用前会自动处理待退订的回调。回调是在锁外执行的,因此可以在回调中安全地进行订阅/退订操作。线程安全。
|
||||
|
||||
**参数:**
|
||||
- `args` - 传递给回调的参数
|
||||
|
||||
**复杂度:** O(n) 其中 n 为订阅数量
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/Event.h>
|
||||
|
||||
// 无参数事件
|
||||
Event<> frameEndEvent;
|
||||
frameEndEvent.Subscribe([]() {
|
||||
printf("Frame ended\n");
|
||||
});
|
||||
|
||||
// 带参数事件
|
||||
Event<int, const char*> playerDiedEvent;
|
||||
playerDiedEvent.Subscribe([](int playerId, const char* reason) {
|
||||
printf("Player %d died: %s\n", playerId, reason);
|
||||
});
|
||||
|
||||
// 触发事件
|
||||
frameEndEvent.Invoke();
|
||||
playerDiedEvent.Invoke(1, "fell off a cliff");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Event 总览](event.md) - 返回类总览
|
||||
- [Subscribe](Subscribe.md) - 订阅事件
|
||||
Reference in New Issue
Block a user