docs: update RHI API docs

This commit is contained in:
2026-03-20 02:35:45 +08:00
parent ea756c0177
commit 070b444f8f
501 changed files with 13493 additions and 2022 deletions

View File

@@ -4,16 +4,31 @@
virtual uint64_t GetCompletedValue() = 0;
```
获取栅栏已完成值
查询栅栏的当前完成值。返回值表示栅栏已被 GPU 完成的最新信号值。如果返回的值小于等待的值,则表示 GPU 尚未完成到该点的所有操作
**返回** 已完成的信号值
**参数**
**返回:** 栅栏已完成的最大信号值uint64_t
**线程安全:** ✅ 线程安全,可以从任意线程调用
**复杂度:** O(1)
**示例:**
```cpp
uint64_t value = cmdQueue->GetCompletedValue();
#include "RHICommandQueue.h"
#include "RHIFence.h"
void CheckFenceStatus(RHICommandQueue* cmdQueue, RHIFence* fence) {
uint64_t completed = cmdQueue->GetCompletedValue();
if (completed >= fence->GetCurrentValue()) {
}
}
```
## 相关文档
- [RHICommandQueue 总览](command-queue.md) - 返回类总览
- [Signal](signal.md) - 信号栅栏
- [Wait](wait.md) - 等待栅栏