docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
- math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
- containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
- core: 修复 types 链接错误
- debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
- memory: 修复头文件路径, malloc vs operator new, 新增方法文档
- resources: 修复 Shader/Texture 链接错误
- threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
# RHIPipelineState
|
|
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
|
|
|
|
|
|
|
|
**类型**: `class` (abstract)
|
|
|
|
|
|
|
2026-03-20 02:35:45 +08:00
|
|
|
|
**头文件**: `XCEngine/RHI/RHIPipelineState.h`
|
|
|
|
|
|
|
|
|
|
|
|
**描述**: 管线状态接口,管理渲染管线状态
|
|
|
|
|
|
|
|
|
|
|
|
## 概述
|
|
|
|
|
|
|
|
|
|
|
|
`RHIPipelineState` 是 XCEngine RHI 模块中的抽象基类,定义了渲染管线状态的统一接口。它提供了绑定、解绑定、获取原生句柄以及查询管线类型等基本操作。作为抽象基类,具体实现由各图形 API(D3D12、OpenGL、Vulkan、Metal)自行实现。
|
|
|
|
|
|
|
|
|
|
|
|
此接口的主要作用是:
|
|
|
|
|
|
- 提供统一的管线状态管理抽象
|
|
|
|
|
|
- 屏蔽不同图形 API 的底层差异
|
|
|
|
|
|
- 支持图形管线、计算管线和光线追踪管线的管理
|
docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
- math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
- containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
- core: 修复 types 链接错误
- debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
- memory: 修复头文件路径, malloc vs operator new, 新增方法文档
- resources: 修复 Shader/Texture 链接错误
- threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
|
|
|
|
|
|
## 公共方法
|
|
|
|
|
|
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| 方法 | 描述 |
|
docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
- math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
- containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
- core: 修复 types 链接错误
- debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
- memory: 修复头文件路径, malloc vs operator new, 新增方法文档
- resources: 修复 Shader/Texture 链接错误
- threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
|------|------|
|
fix(rhi): Fix RHI abstraction layer API docs per api-skill.md template
- Rename texture/dtor.md to destructor.md per template spec
- Remove duplicate non-hyphenated fence docs (getnativehandle.md, issignaled.md, getcompletedvalue.md)
- Fix template field issues:
- swap-chain, command-queue: 类型 now uses 'class (abstract)'
- sampler: 头文件 now uses full path 'XCEngine/RHI/RHISampler.h'
- types: 类型 fixed from 'structs' to 'struct'
- enums: 类型 fixed from 'enums' to 'enum class'
- Fix include paths in command-queue and pipeline-layout code examples
- Create missing constructor/destructor docs for 11 classes:
buffer, texture, shader, device, command-list, command-queue,
fence, sampler, swap-chain, pipeline-state, pipeline-layout
- Update class overview pages to include constructor/destructor entries
2026-03-22 03:07:41 +08:00
|
|
|
|
| [`RHIPipelineState`](constructor.md) | 默认构造函数 |
|
|
|
|
|
|
| [`~RHIPipelineState`](destructor.md) | 虚析构函数 |
|
2026-03-20 02:35:45 +08:00
|
|
|
|
| [`Shutdown`](shutdown.md) | 关闭并释放管线状态资源 |
|
|
|
|
|
|
| [`Bind`](bind.md) | 将管线状态绑定到渲染上下文 |
|
|
|
|
|
|
| [`Unbind`](unbind.md) | 将管线状态从渲染上下文解绑 |
|
|
|
|
|
|
| [`GetNativeHandle`](get-native-handle.md) | 获取底层图形 API 的原生句柄 |
|
|
|
|
|
|
| [`GetType`](get-type.md) | 获取管线类型(图形/计算/光线追踪) |
|
|
|
|
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
|
#include "XCEngine/RHI/RHIPipelineState.h"
|
|
|
|
|
|
#include "XCEngine/RHI/RHIEnums.h"
|
|
|
|
|
|
|
|
|
|
|
|
void ExampleUsage(RHIPipelineState* pipelineState) {
|
|
|
|
|
|
if (!pipelineState) {
|
|
|
|
|
|
return;
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
PipelineType type = pipelineState->GetType();
|
|
|
|
|
|
|
|
|
|
|
|
if (type == PipelineType::Graphics) {
|
|
|
|
|
|
pipelineState->Bind();
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void* nativeHandle = pipelineState->GetNativeHandle();
|
|
|
|
|
|
|
|
|
|
|
|
pipelineState->Unbind();
|
|
|
|
|
|
pipelineState->Shutdown();
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
- math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
- containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
- core: 修复 types 链接错误
- debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
- memory: 修复头文件路径, malloc vs operator new, 新增方法文档
- resources: 修复 Shader/Texture 链接错误
- threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
|
2026-03-20 02:35:45 +08:00
|
|
|
|
- [RHIDevice](../device/device.md) - 设备接口,创建管线状态
|
|
|
|
|
|
- [RHIPipelineLayout](../pipeline-layout/pipeline-layout.md) - 管线布局
|
|
|
|
|
|
- [RHICommandList](../command-list/command-list.md) - 命令列表,执行绘制命令
|