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
|
|
|
|
# RHIShader
|
|
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::RHI`
|
|
|
|
|
|
|
|
|
|
|
|
**类型**: `class` (abstract)
|
|
|
|
|
|
|
2026-03-20 02:35:45 +08:00
|
|
|
|
**头文件**: `XCEngine/RHI/RHIShader.h`
|
|
|
|
|
|
|
|
|
|
|
|
**描述**: 着色器接口,管理 GPU 着色器程序
|
|
|
|
|
|
|
|
|
|
|
|
## 概述
|
|
|
|
|
|
|
|
|
|
|
|
`RHIShader` 是 XCEngine RHI 模块中的抽象着色器接口类,定义了 GPU 着色器程序的标准 API。该类是所有具体着色器实现(如 D3D12Shader、VulkanShader 等)的基类,提供了统一的着色器编译、绑定和参数设置接口。
|
|
|
|
|
|
|
|
|
|
|
|
设计目的:
|
|
|
|
|
|
- 提供跨平台的着色器抽象
|
|
|
|
|
|
- 统一着色器资源管理和绑定流程
|
|
|
|
|
|
- 简化渲染管线中着色器的使用
|
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
|
|
|
|
| [`RHIShader`](constructor.md) | 默认构造函数 |
|
|
|
|
|
|
| [`~RHIShader`](destructor.md) | 虚析构函数 |
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| [`CompileFromFile`](compile-from-file.md) | 从文件编译着色器 |
|
2026-03-20 02:35:45 +08:00
|
|
|
|
| [`Compile`](compile.md) | 从内存数据编译着色器 |
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| [`GetType`](get-type.md) | 获取着色器类型 |
|
|
|
|
|
|
| [`IsValid`](is-valid.md) | 检查着色器是否有效 |
|
2026-03-20 02:35:45 +08:00
|
|
|
|
| [`Bind`](bind.md) | 绑定着色器到渲染管线 |
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| [`Unbind`](unbind.md) | 解绑着色器 |
|
2026-03-20 02:35:45 +08:00
|
|
|
|
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
|
2026-03-19 02:01:18 +08:00
|
|
|
|
| [`SetInt`](set-int.md) | 设置整数 uniform |
|
|
|
|
|
|
| [`SetFloat`](set-float.md) | 设置浮点数 uniform |
|
2026-03-20 02:35:45 +08:00
|
|
|
|
| [`SetVec3`](set-vec3.md) | 设置三维向量 uniform |
|
|
|
|
|
|
| [`SetVec4`](set-vec4.md) | 设置四维向量 uniform |
|
|
|
|
|
|
| [`SetMat4`](set-mat4.md) | 设置 4x4 矩阵 uniform |
|
|
|
|
|
|
| [`Shutdown`](shutdown.md) | 释放着色器资源 |
|
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
|
|
|
|
## 公共属性
|
|
|
|
|
|
|
|
|
|
|
|
| 属性 | 类型 | 描述 |
|
|
|
|
|
|
|------|------|------|
|
|
|
|
|
|
| `ShaderType` | `enum` | 着色器类型枚举 |
|
|
|
|
|
|
|
|
|
|
|
|
### ShaderType 枚举值
|
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 00:35:26 +08:00
|
|
|
|
| `ShaderType::Vertex` | 顶点着色器 |
|
|
|
|
|
|
| `ShaderType::Fragment` | 片元着色器 |
|
|
|
|
|
|
| `ShaderType::Geometry` | 几何着色器 |
|
|
|
|
|
|
| `ShaderType::Compute` | 计算着色器 |
|
|
|
|
|
|
| `ShaderType::TessControl` | 曲面细分控制着色器 |
|
|
|
|
|
|
| `ShaderType::TessEvaluation` | 曲面细分评估着色器 |
|
|
|
|
|
|
| `ShaderType::Hull` | Hull 着色器 (D3D12) |
|
|
|
|
|
|
| `ShaderType::Domain` | Domain 着色器 (D3D12) |
|
|
|
|
|
|
| `ShaderType::Amplification` | 放大着色器 (Mesh Shader) |
|
|
|
|
|
|
| `ShaderType::Mesh` | Mesh 着色器 |
|
|
|
|
|
|
| `ShaderType::Library` | 着色器库 |
|
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
|
|
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
|
|
```cpp
|
2026-03-20 02:35:45 +08:00
|
|
|
|
#include "XCEngine/RHI/RHIShader.h"
|
|
|
|
|
|
#include "XCEngine/RHI/RHIDevice.h"
|
|
|
|
|
|
|
|
|
|
|
|
using namespace XCEngine::RHI;
|
|
|
|
|
|
|
|
|
|
|
|
// 通过 RHIDevice 编译着色器
|
|
|
|
|
|
ShaderCompileDesc vsDesc;
|
|
|
|
|
|
vsDesc.fileName = L"shaders/vertex.cso";
|
|
|
|
|
|
vsDesc.entryPoint = "VSMain";
|
|
|
|
|
|
vsDesc.profile = "vs_5_0";
|
|
|
|
|
|
RHIShader* vertexShader = device->CompileShader(vsDesc);
|
|
|
|
|
|
if (vertexShader && vertexShader->IsValid()) {
|
|
|
|
|
|
vertexShader->Bind();
|
|
|
|
|
|
|
|
|
|
|
|
// 设置 uniform 参数
|
|
|
|
|
|
float modelMatrix[16] = { /* 4x4 模型矩阵数据 */ };
|
|
|
|
|
|
vertexShader->SetMat4("u_modelMatrix", modelMatrix);
|
|
|
|
|
|
|
|
|
|
|
|
// 渲染...
|
|
|
|
|
|
|
|
|
|
|
|
vertexShader->Unbind();
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
if (vertexShader) {
|
|
|
|
|
|
vertexShader->Shutdown();
|
|
|
|
|
|
delete vertexShader;
|
|
|
|
|
|
}
|
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
|
|
|
|
- [RHI 模块总览](../rhi.md) - RHI 模块总览
|
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
|
|
|
|
- [RHIDevice](../device/device.md) - 创建设备
|