fix: improve doc link navigation and tree display
- Fix link resolution with proper relative/absolute path handling - Improve link styling with underline decoration - Hide leaf nodes from tree, only show directories - Fix log file path for packaged app
This commit is contained in:
30
docs/api/rhi/d3d12/shader/get-bytecode-size.md
Normal file
30
docs/api/rhi/d3d12/shader/get-bytecode-size.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# D3D12Shader::GetBytecodeSize
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
size_t GetBytecodeSize() const
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
获取着色器字节码大小。
|
||||
|
||||
## 返回值
|
||||
|
||||
`size_t` - 字节码大小(字节)
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
size_t size = shader->GetBytecodeSize();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12Shader](shader.md) - 类总览
|
||||
- [D3D12Shader::GetBytecode](get-bytecode.md) - 获取字节码数据
|
||||
30
docs/api/rhi/d3d12/shader/get-bytecode.md
Normal file
30
docs/api/rhi/d3d12/shader/get-bytecode.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# D3D12Shader::GetBytecode
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
const void* GetBytecode() const
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
获取着色器字节码数据指针。
|
||||
|
||||
## 返回值
|
||||
|
||||
`const void*` - 字节码数据指针
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
const void* bytecode = shader->GetBytecode();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12Shader](shader.md) - 类总览
|
||||
- [D3D12Shader::GetBytecodeSize](get-bytecode-size.md) - 获取字节码大小
|
||||
29
docs/api/rhi/d3d12/shader/get-d3d12-bytecode.md
Normal file
29
docs/api/rhi/d3d12/shader/get-d3d12-bytecode.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# D3D12Shader::GetD3D12Bytecode
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
const D3D12_SHADER_BYTECODE GetD3D12Bytecode() const
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
获取 D3D12 着色器字节码结构。
|
||||
|
||||
## 返回值
|
||||
|
||||
`D3D12_SHADER_BYTECODE` - D3D12 着色器字节码结构
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
D3D12_SHADER_BYTECODE bytecode = shader->GetD3D12Bytecode();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12Shader](shader.md) - 类总览
|
||||
29
docs/api/rhi/d3d12/shader/get-input-layout.md
Normal file
29
docs/api/rhi/d3d12/shader/get-input-layout.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# D3D12Shader::GetInputLayout
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
const InputLayoutDesc& GetInputLayout() const
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
获取着色器输入布局描述。
|
||||
|
||||
## 返回值
|
||||
|
||||
`const InputLayoutDesc&` - 输入布局描述引用
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
const InputLayoutDesc& layout = shader->GetInputLayout();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12Shader](shader.md) - 类总览
|
||||
46
docs/api/rhi/d3d12/shader/set-uniforms.md
Normal file
46
docs/api/rhi/d3d12/shader/set-uniforms.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# D3D12Shader::SetUniforms
|
||||
|
||||
## 函数签名
|
||||
|
||||
```cpp
|
||||
void SetInt(const char* name, int value) override
|
||||
void SetFloat(const char* name, float value) override
|
||||
void SetVec3(const char* name, float x, float y, float z) override
|
||||
void SetVec4(const char* name, float x, float y, float z, float w) override
|
||||
void SetMat4(const char* name, const float* value) override
|
||||
```
|
||||
|
||||
## 中文描述
|
||||
|
||||
设置着色器 uniform 变量。当前实现为空(stub)。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `name` | `const char*` | 变量名称 |
|
||||
| `value` | 各种类型 | 变量值 |
|
||||
| `x, y, z, w` | `float` | 向量分量 |
|
||||
| `value` | `const float*` | 矩阵数据指针 |
|
||||
|
||||
## 返回值
|
||||
|
||||
无
|
||||
|
||||
## 复杂度
|
||||
|
||||
O(1)
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
shader->SetInt("useLighting", 1);
|
||||
shader->SetFloat("scale", 2.0f);
|
||||
shader->SetVec3("lightPos", 1.0f, 2.0f, 3.0f);
|
||||
shader->SetVec4("color", 1.0f, 0.0f, 0.0f, 1.0f);
|
||||
shader->SetMat4("transform", matrixData);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12Shader](shader.md) - 类总览
|
||||
28
docs/api/rhi/d3d12/shader/shader.md
Normal file
28
docs/api/rhi/d3d12/shader/shader.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# D3D12Shader
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: DirectX 12 着色器的 D3D12 实现,继承自 `RHIShader`。
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`CompileFromFile`](../../shader/compile-from-file.md) | 从文件编译着色器 |
|
||||
| [`Compile`](../../shader/compile.md) | 从源码编译着色器 |
|
||||
| [`Shutdown`](../../../threading/task-system/shutdown.md) | 关闭着色器 |
|
||||
| [`GetD3D12Bytecode`](get-d3d12-bytecode.md) | 获取 D3D12 字节码 |
|
||||
| [`GetBytecode`](get-bytecode.md) | 获取字节码 |
|
||||
| [`GetBytecodeSize`](get-bytecode-size.md) | 获取字节码大小 |
|
||||
| [`GetType`](../../command-queue/get-type.md) | 获取着色器类型 |
|
||||
| [`GetInputLayout`](get-input-layout.md) | 获取输入布局 |
|
||||
| [`GetNativeHandle`](../../buffer/get-native-handle.md) | 获取原生句柄 |
|
||||
| [`IsValid`](../../shader/is-valid.md) | 检查是否有效 |
|
||||
| [`Bind`](../../shader/bind.md) | 绑定着色器 |
|
||||
| [`Unbind`](../../shader/unbind.md) | 解绑着色器 |
|
||||
| [`SetUniforms`](set-uniforms.md) | 设置 uniform 变量 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [D3D12 后端总览](../../opengl/overview.md)
|
||||
- [RHIShader](../../shader/shader.md) - 抽象着色器接口
|
||||
Reference in New Issue
Block a user