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:
50
docs/api/rhi/fence/methods.md
Normal file
50
docs/api/rhi/fence/methods.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# RHIFence 方法
|
||||
|
||||
## Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放栅栏资源。
|
||||
|
||||
## Signal
|
||||
|
||||
```cpp
|
||||
virtual void Signal() = 0;
|
||||
virtual void Signal(uint64_t value) = 0;
|
||||
```
|
||||
|
||||
信号通知(值为 1)或指定值。
|
||||
|
||||
## Wait
|
||||
|
||||
```cpp
|
||||
virtual void Wait(uint64_t value) = 0;
|
||||
```
|
||||
|
||||
等待指定值。
|
||||
|
||||
## GetCompletedValue
|
||||
|
||||
```cpp
|
||||
virtual uint64_t GetCompletedValue() const = 0;
|
||||
```
|
||||
|
||||
获取已完成的值。
|
||||
|
||||
## IsSignaled
|
||||
|
||||
```cpp
|
||||
virtual bool IsSignaled() const = 0;
|
||||
```
|
||||
|
||||
检查是否已信号通知。
|
||||
|
||||
## GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
Reference in New Issue
Block a user