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 个断裂引用
This commit is contained in:
20
docs/api/rhi/shader/bind.md
Normal file
20
docs/api/rhi/shader/bind.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# RHIShader::Bind
|
||||
|
||||
```cpp
|
||||
virtual void Bind() = 0;
|
||||
```
|
||||
|
||||
绑定着色器到管线。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
vs->Bind();
|
||||
ps->Bind();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
26
docs/api/rhi/shader/compile-from-file.md
Normal file
26
docs/api/rhi/shader/compile-from-file.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# RHIShader::CompileFromFile
|
||||
|
||||
```cpp
|
||||
virtual bool CompileFromFile(const wchar_t* filePath, const char* entryPoint, const char* target) = 0;
|
||||
```
|
||||
|
||||
从文件编译着色器。
|
||||
|
||||
**参数:**
|
||||
- `filePath` - 着色器源文件路径
|
||||
- `entryPoint` - 入口点函数名
|
||||
- `target` - 编译目标(如 `"vs_6_0"`, `"ps_6_0"`)
|
||||
|
||||
**返回:** 成功返回 `true`,失败返回 `false`
|
||||
|
||||
**复杂度:** O(n) - 取决于着色器代码复杂度
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
shader->CompileFromFile(L"shaders/vertex.hlsl", "main", "vs_6_0");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
21
docs/api/rhi/shader/compile.md
Normal file
21
docs/api/rhi/shader/compile.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# RHIShader::Compile
|
||||
|
||||
```cpp
|
||||
virtual bool Compile(const void* sourceData, size_t sourceSize, const char* entryPoint, const char* target) = 0;
|
||||
```
|
||||
|
||||
从内存编译着色器。
|
||||
|
||||
**参数:**
|
||||
- `sourceData` - 着色器源代码指针
|
||||
- `sourceSize` - 源代码大小
|
||||
- `entryPoint` - 入口点函数名
|
||||
- `target` - 编译目标
|
||||
|
||||
**返回:** 成功返回 `true`,失败返回 `false`
|
||||
|
||||
**复杂度:** O(n)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
15
docs/api/rhi/shader/get-native-handle.md
Normal file
15
docs/api/rhi/shader/get-native-handle.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIShader::GetNativeHandle
|
||||
|
||||
```cpp
|
||||
virtual void* GetNativeHandle() = 0;
|
||||
```
|
||||
|
||||
获取原生 API 句柄。
|
||||
|
||||
**返回:** 原生着色器句柄
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
15
docs/api/rhi/shader/get-type.md
Normal file
15
docs/api/rhi/shader/get-type.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIShader::GetType
|
||||
|
||||
```cpp
|
||||
virtual ShaderType GetType() const = 0;
|
||||
```
|
||||
|
||||
获取着色器类型。
|
||||
|
||||
**返回:** 着色器类型枚举值
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
15
docs/api/rhi/shader/is-valid.md
Normal file
15
docs/api/rhi/shader/is-valid.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# RHIShader::IsValid
|
||||
|
||||
```cpp
|
||||
virtual bool IsValid() const = 0;
|
||||
```
|
||||
|
||||
检查着色器是否有效(已成功编译)。
|
||||
|
||||
**返回:** 有效返回 `true`,无效返回 `false`
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
17
docs/api/rhi/shader/set-float.md
Normal file
17
docs/api/rhi/shader/set-float.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# RHIShader::SetFloat
|
||||
|
||||
```cpp
|
||||
virtual void SetFloat(const char* name, float value) = 0;
|
||||
```
|
||||
|
||||
设置浮点 uniform。
|
||||
|
||||
**参数:**
|
||||
- `name` - uniform 变量名
|
||||
- `value` - 浮点值
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
17
docs/api/rhi/shader/set-int.md
Normal file
17
docs/api/rhi/shader/set-int.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# RHIShader::SetInt
|
||||
|
||||
```cpp
|
||||
virtual void SetInt(const char* name, int value) = 0;
|
||||
```
|
||||
|
||||
设置整数 uniform。
|
||||
|
||||
**参数:**
|
||||
- `name` - uniform 变量名
|
||||
- `value` - 整数值
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
17
docs/api/rhi/shader/set-mat4.md
Normal file
17
docs/api/rhi/shader/set-mat4.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# RHIShader::SetMat4
|
||||
|
||||
```cpp
|
||||
virtual void SetMat4(const char* name, const float* value) = 0;
|
||||
```
|
||||
|
||||
设置 4x4 矩阵 uniform。
|
||||
|
||||
**参数:**
|
||||
- `name` - uniform 变量名
|
||||
- `value` - 矩阵数据指针(16 个 float)
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
17
docs/api/rhi/shader/set-vec3.md
Normal file
17
docs/api/rhi/shader/set-vec3.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# RHIShader::SetVec3
|
||||
|
||||
```cpp
|
||||
virtual void SetVec3(const char* name, float x, float y, float z) = 0;
|
||||
```
|
||||
|
||||
设置三维向量 uniform。
|
||||
|
||||
**参数:**
|
||||
- `name` - uniform 变量名
|
||||
- `x, y, z` - 向量分量
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
17
docs/api/rhi/shader/set-vec4.md
Normal file
17
docs/api/rhi/shader/set-vec4.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# RHIShader::SetVec4
|
||||
|
||||
```cpp
|
||||
virtual void SetVec4(const char* name, float x, float y, float z, float w) = 0;
|
||||
```
|
||||
|
||||
设置四维向量 uniform。
|
||||
|
||||
**参数:**
|
||||
- `name` - uniform 变量名
|
||||
- `x, y, z, w` - 向量分量
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
74
docs/api/rhi/shader/shader.md
Normal file
74
docs/api/rhi/shader/shader.md
Normal file
@@ -0,0 +1,74 @@
|
||||
# RHIShader
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**类型**: `class` (abstract)
|
||||
|
||||
**描述**: GPU 着色器资源抽象接口,用于管理着色器代码的编译和绑定。
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 编译
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `CompileFromFile` | [详细文档](compile-from-file.md) |
|
||||
| `Compile` | [详细文档](compile.md) |
|
||||
|
||||
### 属性访问
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetType` | [详细文档](get-type.md) |
|
||||
| `IsValid` | [详细文档](is-valid.md) |
|
||||
|
||||
### 绑定/解绑
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Bind` | [详细文档](bind.md) |
|
||||
| `Unbind` | [详细文档](unbind.md) |
|
||||
|
||||
### Uniform 设置
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `SetInt` | [详细文档](set-int.md) |
|
||||
| `SetFloat` | [详细文档](set-float.md) |
|
||||
| `SetVec3` | [详细文档](set-vec3.md) |
|
||||
| `SetVec4` | [详细文档](set-vec4.md) |
|
||||
| `SetMat4` | [详细文档](set-mat4.md) |
|
||||
|
||||
### 生命周期
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Shutdown` | [详细文档](../../threading/task-system/shutdown.md) |
|
||||
|
||||
### 其他
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `GetNativeHandle` | [详细文档](../buffer/get-native-handle.md) |
|
||||
|
||||
## 着色器类型 (ShaderType)
|
||||
|
||||
| 枚举值 | 描述 |
|
||||
|--------|------|
|
||||
| `Vertex` | 顶点着色器 |
|
||||
| `Fragment` | 片元着色器 |
|
||||
| `Compute` | 计算着色器 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
RHIShader* vs = device->CompileShader({});
|
||||
vs->CompileFromFile(L"shaders/vertex.hlsl", "main", "vs_6_0");
|
||||
vs->SetMat4("modelMatrix", modelMatrix);
|
||||
vs->Bind();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [../rhi/rhi.md](../rhi.md) - RHI 模块总览
|
||||
- [RHIDevice](../device/device.md) - 创建设备
|
||||
13
docs/api/rhi/shader/shutdown.md
Normal file
13
docs/api/rhi/shader/shutdown.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# RHIShader::Shutdown
|
||||
|
||||
```cpp
|
||||
virtual void Shutdown() = 0;
|
||||
```
|
||||
|
||||
释放着色器资源。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
13
docs/api/rhi/shader/unbind.md
Normal file
13
docs/api/rhi/shader/unbind.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# RHIShader::Unbind
|
||||
|
||||
```cpp
|
||||
virtual void Unbind() = 0;
|
||||
```
|
||||
|
||||
解绑着色器。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RHIShader 总览](shader.md) - 返回类总览
|
||||
Reference in New Issue
Block a user