fix: improve doc link navigation and tree display
- Fix link resolution with proper relative/absolute path handling - Improve link styling with underline decoration - Hide leaf nodes from tree, only show directories - Fix log file path for packaged app
This commit is contained in:
34
docs/api/rhi/fence/fence.md
Normal file
34
docs/api/rhi/fence/fence.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# RHIFence
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**描述**: GPU 同步栅栏抽象接口,用于 GPU/CPU 同步和跨队列同步。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Shutdown`](shutdown.md) | 关闭并释放资源 |
|
||||
| [`Signal`](signal.md) | 信号栅栏 |
|
||||
| [`Wait`](wait.md) | 等待栅栏 |
|
||||
| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 |
|
||||
| [`IsSignaled`](is-signaled.md) | 检查是否已信号 |
|
||||
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
FenceDesc desc;
|
||||
desc.initialValue = 0;
|
||||
RHIFence* fence = device->CreateFence(desc);
|
||||
|
||||
commandQueue->Signal(fence, 1);
|
||||
fence->Wait(1);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHICommandQueue](../command-queue/command-queue.md) - 命令队列
|
||||
19
docs/api/rhi/fence/get-completed-value.md
Normal file
19
docs/api/rhi/fence/get-completed-value.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# RHIFence::GetCompletedValue
|
||||
|
||||
```cpp
|
||||
virtual uint64_t GetCompletedValue() const = 0;
|
||||
```
|
||||
|
||||
获取已完成信号值。
|
||||
|
||||
**返回:** 已完成的信号值
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
uint64_t value = fence->GetCompletedValue();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFence 总览](fence.md) - 返回类总览
|
||||
15
docs/api/rhi/fence/get-native-handle.md
Normal file
15
docs/api/rhi/fence/get-native-handle.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIFence::GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
|
||||
**返回:** 原生栅栏句柄
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFence 总览](fence.md) - 返回类总览
|
||||
21
docs/api/rhi/fence/is-signaled.md
Normal file
21
docs/api/rhi/fence/is-signaled.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# RHIFence::IsSignaled
|
||||
|
||||
```cpp
|
||||
virtual bool IsSignaled() const = 0;
|
||||
```
|
||||
|
||||
检查栅栏是否被信号触发。
|
||||
|
||||
**返回:** 如果栅栏已被信号触发返回 true
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
if (fence->IsSignaled()) {
|
||||
// 栅栏已完成
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFence 总览](fence.md) - 返回类总览
|
||||
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 句柄。
|
||||
13
docs/api/rhi/fence/shutdown.md
Normal file
13
docs/api/rhi/fence/shutdown.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# RHIFence::Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放栅栏资源。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFence 总览](fence.md) - 返回类总览
|
||||
22
docs/api/rhi/fence/signal.md
Normal file
22
docs/api/rhi/fence/signal.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# RHIFence::Signal
|
||||
|
||||
```cpp
|
||||
virtual void Signal() = 0;
|
||||
virtual void Signal(uint64_t value) = 0;
|
||||
```
|
||||
|
||||
向栅栏发送信号。
|
||||
|
||||
**参数:**
|
||||
- `value` - 信号值(重载版本)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
fence->Signal();
|
||||
fence->Signal(1);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFence 总览](fence.md) - 返回类总览
|
||||
20
docs/api/rhi/fence/wait.md
Normal file
20
docs/api/rhi/fence/wait.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# RHIFence::Wait
|
||||
|
||||
```cpp
|
||||
virtual void Wait(uint64_t value) = 0;
|
||||
```
|
||||
|
||||
等待栅栏达到指定值。
|
||||
|
||||
**参数:**
|
||||
- `value` - 要等待的值
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
fence->Wait(1);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIFence 总览](fence.md) - 返回类总览
|
||||
Reference in New Issue
Block a user