docs: update RHI API docs

This commit is contained in:
2026-03-20 02:35:45 +08:00
parent ea756c0177
commit 070b444f8f
501 changed files with 13493 additions and 2022 deletions

View File

@@ -4,27 +4,44 @@
**类型**: `class` (abstract)
**描述**: GPU 着色器资源抽象接口,用于管理着色器代码的编译和绑定。
**头文件**: `XCEngine/RHI/RHIShader.h`
**描述**: 着色器接口,管理 GPU 着色器程序
## 概述
`RHIShader` 是 XCEngine RHI 模块中的抽象着色器接口类,定义了 GPU 着色器程序的标准 API。该类是所有具体着色器实现如 D3D12Shader、VulkanShader 等)的基类,提供了统一的着色器编译、绑定和参数设置接口。
设计目的:
- 提供跨平台的着色器抽象
- 统一着色器资源管理和绑定流程
- 简化渲染管线中着色器的使用
## 公共方法
| 方法 | 描述 |
|------|------|
| [`CompileFromFile`](compile-from-file.md) | 从文件编译着色器 |
| [`Compile`](compile.md) | 从源码编译着色器 |
| [`Compile`](compile.md) | 从内存数据编译着色器 |
| [`GetType`](get-type.md) | 获取着色器类型 |
| [`IsValid`](is-valid.md) | 检查着色器是否有效 |
| [`Bind`](bind.md) | 绑定着色器 |
| [`Bind`](bind.md) | 绑定着色器到渲染管线 |
| [`Unbind`](unbind.md) | 解绑着色器 |
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
| [`SetInt`](set-int.md) | 设置整数 uniform |
| [`SetFloat`](set-float.md) | 设置浮点数 uniform |
| [`SetVec3`](set-vec3.md) | 设置 vec3 uniform |
| [`SetVec4`](set-vec4.md) | 设置 vec4 uniform |
| [`SetMat4`](set-mat4.md) | 设置 mat4 uniform |
| [`Shutdown`](shutdown.md) | 关闭并释放资源 |
| [`GetNativeHandle`](get-native-handle.md) | 获取原生句柄 |
| [`SetVec3`](set-vec3.md) | 设置三维向量 uniform |
| [`SetVec4`](set-vec4.md) | 设置四维向量 uniform |
| [`SetMat4`](set-mat4.md) | 设置 4x4 矩阵 uniform |
| [`Shutdown`](shutdown.md) | 释放着色器资源 |
## 着色器类型 (ShaderType)
## 公共属性
| 属性 | 类型 | 描述 |
|------|------|------|
| `ShaderType` | `enum` | 着色器类型枚举 |
### ShaderType 枚举值
| 枚举值 | 描述 |
|--------|------|
@@ -43,13 +60,36 @@
## 使用示例
```cpp
RHIShader* vs = device->CompileShader({});
vs->CompileFromFile(L"shaders/vertex.hlsl", "main", "vs_6_0");
vs->SetMat4("modelMatrix", modelMatrix);
vs->Bind();
#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;
}
```
## 相关文档
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
- [RHI 模块总览](../rhi.md) - RHI 模块总览
- [RHIDevice](../device/device.md) - 创建设备