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:
15
docs/api/rhi/pipeline-state/get-native-handle.md
Normal file
15
docs/api/rhi/pipeline-state/get-native-handle.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIPipelineState::GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
|
||||
**返回:** 原生管线状态句柄
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIPipelineState 总览](pipeline-state.md) - 返回类总览
|
||||
15
docs/api/rhi/pipeline-state/get-type.md
Normal file
15
docs/api/rhi/pipeline-state/get-type.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIPipelineState::GetType
|
||||
|
||||
```cpp
|
||||
virtual PipelineType GetType() const = 0;
|
||||
```
|
||||
|
||||
获取管线类型。
|
||||
|
||||
**返回:** 管线类型枚举值
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIPipelineState 总览](pipeline-state.md) - 返回类总览
|
||||
41
docs/api/rhi/pipeline-state/methods.md
Normal file
41
docs/api/rhi/pipeline-state/methods.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# RHIPipelineState 方法
|
||||
|
||||
## Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放管线状态对象。
|
||||
|
||||
## Bind
|
||||
|
||||
```cpp
|
||||
virtual void Bind() = 0;
|
||||
```
|
||||
|
||||
绑定管线状态到管线。
|
||||
|
||||
## Unbind
|
||||
|
||||
```cpp
|
||||
virtual void Unbind() = 0;
|
||||
```
|
||||
|
||||
解绑管线状态。
|
||||
|
||||
## GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
|
||||
## GetType
|
||||
|
||||
```cpp
|
||||
virtual PipelineType GetType() const = 0;
|
||||
```
|
||||
|
||||
获取管线类型。
|
||||
30
docs/api/rhi/pipeline-state/pipeline-state.md
Normal file
30
docs/api/rhi/pipeline-state/pipeline-state.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# RHIPipelineState
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**描述**: GPU 渲染管线状态抽象接口,封装了渲染管线的各种固定功能配置。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Shutdown`](shutdown.md) | 关闭并释放资源 |
|
||||
| [`Bind`](../shader/bind.md) | 绑定管线状态 |
|
||||
| [`Unbind`](../shader/unbind.md) | 解绑管线状态 |
|
||||
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
|
||||
| [`GetType`](get-type.md) | 获取管线类型 |
|
||||
|
||||
## 管线类型 (PipelineType)
|
||||
|
||||
| 枚举值 | 描述 |
|
||||
|--------|------|
|
||||
| `Graphics` | 图形渲染管线 |
|
||||
| `Compute` | 计算管线 |
|
||||
| `Raytracing` | 光线追踪管线 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHIDevice](../device/device.md) - 创建设备
|
||||
13
docs/api/rhi/pipeline-state/shutdown.md
Normal file
13
docs/api/rhi/pipeline-state/shutdown.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# RHIPipelineState::Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放管线状态对象资源。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIPipelineState 总览](pipeline-state.md) - 返回类总览
|
||||
Reference in New Issue
Block a user