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:
25
docs/api/rhi/opengl/fence/fence.md
Normal file
25
docs/api/rhi/opengl/fence/fence.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# OpenGLFence
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: OpenGL 栅栏同步实现,继承自 `RHIFence`。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Initialize`](initialize.md) | 初始化栅栏 |
|
||||
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭栅栏 |
|
||||
| [`Signal`](signal.md) | 信号栅栏 |
|
||||
| [`Wait`](../../../threading/task-group/wait.md) | 等待栅栏 |
|
||||
| [`Reset`](reset.md) | 重置栅栏 |
|
||||
| [`IsSignaled`](is-signaled.md) | 检查是否已信号 |
|
||||
| [`GetStatus`](get-status.md) | 获取状态 |
|
||||
| [`GetCompletedValue`](get-completed-value.md) | 获取完成值 |
|
||||
| [`GetCurrentValue`](get-current-value.md) | 获取当前值 |
|
||||
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGL 后端总览](../overview.md)
|
||||
- [RHIFence](../../fence/fence.md) - 抽象栅栏接口
|
||||
19
docs/api/rhi/opengl/fence/get-completed-value.md
Normal file
19
docs/api/rhi/opengl/fence/get-completed-value.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLFence::GetCompletedValue
|
||||
|
||||
```cpp
|
||||
uint64_t GetCompletedValue() const override
|
||||
```
|
||||
|
||||
获取已完成的最大栅栏值。
|
||||
|
||||
**返回:** `uint64_t` - 已完成的栅栏值
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
uint64_t completed = fence.GetCompletedValue();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLFence](fence.md) - 返回类总览
|
||||
19
docs/api/rhi/opengl/fence/get-current-value.md
Normal file
19
docs/api/rhi/opengl/fence/get-current-value.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLFence::GetCurrentValue
|
||||
|
||||
```cpp
|
||||
uint64_t GetCurrentValue() const
|
||||
```
|
||||
|
||||
获取栅栏的当前值。
|
||||
|
||||
**返回:** `uint64_t` - 当前栅栏值
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
uint64_t current = fence.GetCurrentValue();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLFence](fence.md) - 返回类总览
|
||||
25
docs/api/rhi/opengl/fence/get-status.md
Normal file
25
docs/api/rhi/opengl/fence/get-status.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# OpenGLFence::GetStatus
|
||||
|
||||
```cpp
|
||||
FenceStatus GetStatus() const
|
||||
```
|
||||
|
||||
获取栅栏的当前状态。
|
||||
|
||||
**返回:** `FenceStatus` - 栅栏状态,可能的值:
|
||||
- `FenceStatus::Signaled` - 栅栏已signaled
|
||||
- `FenceStatus::Unsignaled` - 栅栏未signaled
|
||||
- `FenceStatus::Error` - 发生错误
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
FenceStatus status = fence.GetStatus();
|
||||
if (status == FenceStatus::Signaled) {
|
||||
// 操作已完成
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLFence](fence.md) - 返回类总览
|
||||
23
docs/api/rhi/opengl/fence/initialize.md
Normal file
23
docs/api/rhi/opengl/fence/initialize.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# OpenGLFence::Initialize
|
||||
|
||||
```cpp
|
||||
bool Initialize(bool signaled = false);
|
||||
```
|
||||
|
||||
初始化 OpenGL 栅栏。
|
||||
|
||||
**参数:**
|
||||
- `signaled` - 初始是否为 signaled 状态
|
||||
|
||||
**返回:** 成功返回 true
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLFence fence;
|
||||
fence.Initialize(true);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLFence 总览](fence.md) - 返回类总览
|
||||
21
docs/api/rhi/opengl/fence/is-signaled.md
Normal file
21
docs/api/rhi/opengl/fence/is-signaled.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# OpenGLFence::IsSignaled
|
||||
|
||||
```cpp
|
||||
bool IsSignaled() const override
|
||||
```
|
||||
|
||||
检查栅栏是否处于 signaled 状态。
|
||||
|
||||
**返回:** `bool` - 如果栅栏已signaled返回 true,否则返回 false
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
if (fence.IsSignaled()) {
|
||||
// 可以安全地继续执行
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLFence](fence.md) - 返回类总览
|
||||
17
docs/api/rhi/opengl/fence/reset.md
Normal file
17
docs/api/rhi/opengl/fence/reset.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# OpenGLFence::Reset
|
||||
|
||||
```cpp
|
||||
void Reset();
|
||||
```
|
||||
|
||||
重置栅栏。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
fence->Reset();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLFence 总览](fence.md) - 返回类总览
|
||||
20
docs/api/rhi/opengl/fence/signal.md
Normal file
20
docs/api/rhi/opengl/fence/signal.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# OpenGLFence::Signal
|
||||
|
||||
```cpp
|
||||
void Signal() override
|
||||
void Signal(uint64_t value) override
|
||||
```
|
||||
|
||||
将栅栏设置为 signaled 状态,通知等待的线程操作完成。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLFence fence;
|
||||
fence.Initialize(false);
|
||||
fence.Signal();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLFence](fence.md) - 返回类总览
|
||||
Reference in New Issue
Block a user