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 文档
This commit is contained in:
2026-03-26 01:58:45 +08:00
parent 445876752c
commit 8df04c120f
81 changed files with 1747 additions and 170 deletions

View File

@@ -10,31 +10,22 @@
## 概述
`RHIShader` 是 XCEngine RHI 模块中的抽象着色器接口类,定义了 GPU 着色器程序的标准 API。该类是所有具体着色器实现如 D3D12Shader、VulkanShader 等)的基类,提供了统一的着色器编译、绑定和参数设置接口。
`RHIShader` 是 XCEngine RHI 模块中的抽象着色器接口类,定义了 GPU 着色器程序的标准 API。该类是所有具体着色器实现如 D3D12Shader、OpenGLShader 等)的基类,提供了统一的着色器编译和元数据查询接口。
设计目的:
- 提供跨平台的着色器抽象
- 统一着色器资源管理和绑定流程
- 统一着色器编译和资源管理
- 简化渲染管线中着色器的使用
## 公共方法
| 方法 | 描述 |
|------|------|
| [`RHIShader`](constructor.md) | 默认构造函数 |
| [`~RHIShader`](destructor.md) | 虚析构函数 |
| [`CompileFromFile`](compile-from-file.md) | 从文件编译着色器 |
| [`Compile`](compile.md) | 从内存数据编译着色器 |
| [`GetType`](get-type.md) | 获取着色器类型 |
| [`IsValid`](is-valid.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) | 设置三维向量 uniform |
| [`SetVec4`](set-vec4.md) | 设置四维向量 uniform |
| [`SetMat4`](set-mat4.md) | 设置 4x4 矩阵 uniform |
| [`Shutdown`](shutdown.md) | 释放着色器资源 |
## 公共属性
@@ -67,22 +58,14 @@
using namespace XCEngine::RHI;
// 通过 RHIDevice 编译着色器
// 通过 RHIDevice 创建并编译着色器
ShaderCompileDesc vsDesc;
vsDesc.fileName = L"shaders/vertex.cso";
vsDesc.entryPoint = "VSMain";
vsDesc.profile = "vs_5_0";
RHIShader* vertexShader = device->CompileShader(vsDesc);
RHIShader* vertexShader = device->CreateShader(vsDesc);
if (vertexShader && vertexShader->IsValid()) {
vertexShader->Bind();
// 设置 uniform 参数
float modelMatrix[16] = { /* 4x4 模型矩阵数据 */ };
vertexShader->SetMat4("u_modelMatrix", modelMatrix);
// 渲染...
vertexShader->Unbind();
}
if (vertexShader) {