xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
8df04c120f5c7e5e396a82f71ef9b790adee74b8
XCEngine/docs/api/rhi/shader/shader.md

81 lines
2.3 KiB
Markdown
Raw Normal View History

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)
docs: update RHI API docs
2026-03-20 02:35:45 +08:00
**头文件**: `XCEngine/RHI/RHIShader.h`
**描述**: 着色器接口，管理 GPU 着色器程序
## 概述
docs: 更新 API 文档 - 多模块修复和完善 - audio: 更新 audio-system 方法文档 - components: 新增 audio-listener/audio-source 组件方法文档，新增 remove-component 方法 - core: 更新 filewriter, types 文档 - math: 更新 box 方法文档 - memory: 更新 proxy-allocator 文档 - resources: 更新 loader 和 texture 文档 - rhi: 更新 opengl 设备、shader、swap-chain 文档 - threading: 更新 mutex 和 task-system 文档
2026-03-26 01:58:45 +08:00
`RHIShader` 是 XCEngine RHI 模块中的抽象着色器接口类，定义了 GPU 着色器程序的标准 API。该类是所有具体着色器实现（如 D3D12Shader、OpenGLShader 等）的基类，提供了统一的着色器编译和元数据查询接口。
docs: update RHI API docs
2026-03-20 02:35:45 +08:00
设计目的：
- 提供跨平台的着色器抽象
docs: 更新 API 文档 - 多模块修复和完善 - audio: 更新 audio-system 方法文档 - components: 新增 audio-listener/audio-source 组件方法文档，新增 remove-component 方法 - core: 更新 filewriter, types 文档 - math: 更新 box 方法文档 - memory: 更新 proxy-allocator 文档 - resources: 更新 loader 和 texture 文档 - rhi: 更新 opengl 设备、shader、swap-chain 文档 - threading: 更新 mutex 和 task-system 文档
2026-03-26 01:58:45 +08:00
- 统一着色器编译和资源管理
docs: update RHI API docs
2026-03-20 02:35:45 +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
## 公共方法
docs: Fix SKILL.md规范 violations - Remove ## 方法列表 and flatten ### sub-headers in ## 公共方法
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
|------|------|
docs: Fix SKILL.md规范 violations - Remove ## 方法列表 and flatten ### sub-headers in ## 公共方法
2026-03-19 02:01:18 +08:00
| [`CompileFromFile`](compile-from-file.md) | 从文件编译着色器 |
docs: update RHI API docs
2026-03-20 02:35:45 +08:00
| [`Compile`](compile.md) | 从内存数据编译着色器 |
docs: Fix SKILL.md规范 violations - Remove ## 方法列表 and flatten ### sub-headers in ## 公共方法
2026-03-19 02:01:18 +08:00
| [`GetType`](get-type.md) | 获取着色器类型 |
| [`IsValid`](is-valid.md) | 检查着色器是否有效 |
docs: update RHI API docs
2026-03-20 02:35:45 +08:00
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
| [`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
docs: update RHI API docs
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
| 枚举值 | 描述 |
|--------|------|
docs: 修正 API 文档准确性 (第三轮检查) 修复问题: - containers: HashMap include 路径修复 - core: RefCounted 析构函数访问级别, Event::begin/end 返回值说明 - memory: LinearAllocator::GetMarker 返回偏移量非指针 - resources: LoadAsync 示例使用不存在的模板方法 - rhi: OpenGL 链接错误, ShaderType 枚举缺失8个类型, 链接修复 - threading: SpinLock STL 兼容方法说明, Mutex const 方法说明
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
docs: update RHI API docs
2026-03-20 02:35:45 +08:00
#include "XCEngine/RHI/RHIShader.h"
#include "XCEngine/RHI/RHIDevice.h"
using namespace XCEngine::RHI;
docs: 更新 API 文档 - 多模块修复和完善 - audio: 更新 audio-system 方法文档 - components: 新增 audio-listener/audio-source 组件方法文档，新增 remove-component 方法 - core: 更新 filewriter, types 文档 - math: 更新 box 方法文档 - memory: 更新 proxy-allocator 文档 - resources: 更新 loader 和 texture 文档 - rhi: 更新 opengl 设备、shader、swap-chain 文档 - threading: 更新 mutex 和 task-system 文档
2026-03-26 01:58:45 +08:00
// 通过 RHIDevice 创建并编译着色器
docs: update RHI API docs
2026-03-20 02:35:45 +08:00
ShaderCompileDesc vsDesc;
vsDesc.fileName = L"shaders/vertex.cso";
vsDesc.entryPoint = "VSMain";
vsDesc.profile = "vs_5_0";
docs: 更新 API 文档 - 多模块修复和完善 - audio: 更新 audio-system 方法文档 - components: 新增 audio-listener/audio-source 组件方法文档，新增 remove-component 方法 - core: 更新 filewriter, types 文档 - math: 更新 box 方法文档 - memory: 更新 proxy-allocator 文档 - resources: 更新 loader 和 texture 文档 - rhi: 更新 opengl 设备、shader、swap-chain 文档 - threading: 更新 mutex 和 task-system 文档
2026-03-26 01:58:45 +08:00
RHIShader* vertexShader = device->CreateShader(vsDesc);
docs: update RHI API docs
2026-03-20 02:35:45 +08:00
if (vertexShader && vertexShader->IsValid()) {
// 渲染...
}
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
```
## 相关文档
docs: update RHI API docs
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) - 创建设备
Reference in New Issue Copy Permalink