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:
2026-03-19 12:44:08 +08:00
parent e003fe6513
commit 58a83f445a
1012 changed files with 56880 additions and 22 deletions

View File

@@ -0,0 +1,53 @@
# D3D12PipelineState::CreateDesc
## 函数签名
```cpp
static D3D12_GRAPHICS_PIPELINE_STATE_DESC CreateDesc(
ID3D12RootSignature* rootSignature,
const D3D12_SHADER_BYTECODE& vs,
const D3D12_SHADER_BYTECODE& ps,
const D3D12_SHADER_BYTECODE& gs,
uint32_t inputElementCount,
const D3D12_INPUT_ELEMENT_DESC* inputElements)
```
## 中文描述
创建图形管线状态描述符,包含着色器和输入布局信息。
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `rootSignature` | `ID3D12RootSignature*` | 根签名指针 |
| `vs` | `D3D12_SHADER_BYTECODE` | 顶点着色器字节码 |
| `ps` | `D3D12_SHADER_BYTECODE` | 像素着色器字节码 |
| `gs` | `D3D12_SHADER_BYTECODE` | 几何着色器字节码 |
| `inputElementCount` | `uint32_t` | 输入元素数量 |
| `inputElements` | `D3D12_INPUT_ELEMENT_DESC*` | 输入元素描述数组 |
## 返回值
`D3D12_GRAPHICS_PIPELINE_STATE_DESC` - 管线状态描述符
## 复杂度
O(1)
## 示例
```cpp
D3D12_GRAPHICS_PIPELINE_STATE_DESC psoDesc = D3D12PipelineState::CreateDesc(
rootSignature->GetRootSignature(),
vsBytecode,
psBytecode,
gsBytecode,
inputElementCount,
inputElements);
```
## 相关文档
- [D3D12PipelineState](pipeline-state.md) - 类总览
- [D3D12PipelineState::CreateInputElement](create-input-element.md) - 创建输入元素

View File

@@ -0,0 +1,54 @@
# D3D12PipelineState::CreateInputElement
## 函数签名
```cpp
static D3D12_INPUT_ELEMENT_DESC CreateInputElement(
const char* semanticName,
uint32_t semanticIndex,
Format format,
uint32_t inputSlot,
uint32_t alignedByteOffset)
static D3D12_INPUT_ELEMENT_DESC CreateInputElement(
const char* semanticName,
uint32_t semanticIndex,
Format format,
uint32_t inputSlot)
```
## 中文描述
创建输入元素描述符,用于定义顶点缓冲区的数据布局。
## 参数
| 参数 | 类型 | 描述 |
|------|------|------|
| `semanticName` | `const char*` | 语义名称(如 "POSITION", "TEXCOORD" |
| `semanticIndex` | `uint32_t` | 语义索引 |
| `format` | `Format` | 数据格式 |
| `inputSlot` | `uint32_t` | 输入槽位 |
| `alignedByteOffset` | `uint32_t` | 对齐字节偏移(仅第一个重载) |
## 返回值
`D3D12_INPUT_ELEMENT_DESC` - 输入元素描述符
## 复杂度
O(1)
## 示例
```cpp
D3D12_INPUT_ELEMENT_DESC elements[] = {
D3D12PipelineState::CreateInputElement("POSITION", 0, Format::R32G32B32_FLOAT, 0, 0),
D3D12PipelineState::CreateInputElement("TEXCOORD", 0, Format::R32G32_FLOAT, 0, 12)
};
```
## 相关文档
- [D3D12PipelineState](pipeline-state.md) - 类总览
- [D3D12PipelineState::CreateDesc](create-desc.md) - 创建管线描述符

View File

@@ -0,0 +1,29 @@
# D3D12PipelineState::GetPipelineState
## 函数签名
```cpp
ID3D12PipelineState* GetPipelineState() const
```
## 中文描述
获取底层 `ID3D12PipelineState` 接口指针。
## 返回值
`ID3D12PipelineState*` - D3D12 管线状态对象接口指针
## 复杂度
O(1)
## 示例
```cpp
ID3D12PipelineState* pso = pipelineState->GetPipelineState();
```
## 相关文档
- [D3D12PipelineState](pipeline-state.md) - 类总览

View File

@@ -0,0 +1,24 @@
# D3D12PipelineState
**命名空间**: `XCEngine::RHI`
**描述**: DirectX 12 管线状态对象的 D3D12 实现,继承自 `RHIPipelineState`
## 公共方法
| 方法 | 描述 |
|------|------|
| [`Initialize`](../../../threading/task-system/initialize.md) | 初始化管线状态 |
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭管线状态 |
| [`GetPipelineState`](get-pipeline-state.md) | 获取 D3D12 管线状态对象 |
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
| [`GetType`](../../command-queue/get-type.md) | 获取管线类型 |
| [`Bind`](../../shader/bind.md) | 绑定管线状态 |
| [`Unbind`](../../shader/unbind.md) | 解绑管线状态 |
| [`CreateDesc`](create-desc.md) | 创建管线状态描述符(静态) |
| [`CreateInputElement`](create-input-element.md) | 创建输入元素描述符(静态) |
## 相关文档
- [D3D12 后端总览](../../opengl/overview.md)
- [RHIPipelineState](../../pipeline-state/pipeline-state.md) - 抽象管线状态接口