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

34 lines
1.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
# OpenGLShader
**命名空间**: `XCEngine::RHI`
**描述**: OpenGL 着色器实现，继承自 `RHIShader`。
## 方法列表
| 方法 | 文档 |
|------|------|
| `CompileFromFile` | [详细文档](../../shader/compile-from-file.md) |
| `Compile` | [详细文档](../../shader/compile.md) |
Fix RHI documentation discrepancies and add missing doc files Fixed incorrect links in OpenGL documentation: - Fixed wrong links to threading/task-system docs for Initialize/Shutdown methods - Fixed wrong links to buffer docs for GetNativeHandle methods - Fixed wrong links to shader docs for Bind/Unbind methods - Fixed wrong links to command-list docs for Clear/Reset/Close methods - Fixed wrong links to buffer/get-size.md for width/height methods Added missing documentation files: - OpenGL buffer: bind.md, unbind.md, get-type.md, initialize.md - OpenGL fence: initialize.md, reset.md - OpenGL swap-chain: get-size.md, initialize.md - OpenGL render-target-view: initialize.md, shutdown.md, bind.md, unbind.md, clear.md, get-size.md - OpenGL depth-stencil-view: initialize.md, shutdown.md, bind.md, unbind.md, get-size.md - OpenGL command-list: clear.md All links validated with fix_links.py - no broken references.
2026-03-19 00:54:54 +08:00
| `Shutdown` | [详细文档](../../shader/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
| `Use` | [详细文档](use.md) |
Fix RHI documentation discrepancies and add missing doc files Fixed incorrect links in OpenGL documentation: - Fixed wrong links to threading/task-system docs for Initialize/Shutdown methods - Fixed wrong links to buffer docs for GetNativeHandle methods - Fixed wrong links to shader docs for Bind/Unbind methods - Fixed wrong links to command-list docs for Clear/Reset/Close methods - Fixed wrong links to buffer/get-size.md for width/height methods Added missing documentation files: - OpenGL buffer: bind.md, unbind.md, get-type.md, initialize.md - OpenGL fence: initialize.md, reset.md - OpenGL swap-chain: get-size.md, initialize.md - OpenGL render-target-view: initialize.md, shutdown.md, bind.md, unbind.md, clear.md, get-size.md - OpenGL depth-stencil-view: initialize.md, shutdown.md, bind.md, unbind.md, get-size.md - OpenGL command-list: clear.md All links validated with fix_links.py - no broken references.
2026-03-19 00:54:54 +08:00
| `Bind` | [详细文档](../../shader/bind.md) |
| `Unbind` | [详细文档](../../shader/unbind.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
| `SetInt` | [详细文档](../../shader/set-int.md) |
| `SetIntArray` | [详细文档](set-int-array.md) |
| `SetFloat` | [详细文档](../../shader/set-float.md) |
| `SetFloatArray` | [详细文档](set-float-array.md) |
| `SetVec3` | [详细文档](../../shader/set-vec3.md) |
| `SetVec4` | [详细文档](../../shader/set-vec4.md) |
| `SetMat4` | [详细文档](../../shader/set-mat4.md) |
| `GetUniformLocation` | [详细文档](get-uniform-location.md) |
| `GetID` | [详细文档](get-id.md) |
Fix RHI documentation discrepancies and add missing doc files Fixed incorrect links in OpenGL documentation: - Fixed wrong links to threading/task-system docs for Initialize/Shutdown methods - Fixed wrong links to buffer docs for GetNativeHandle methods - Fixed wrong links to shader docs for Bind/Unbind methods - Fixed wrong links to command-list docs for Clear/Reset/Close methods - Fixed wrong links to buffer/get-size.md for width/height methods Added missing documentation files: - OpenGL buffer: bind.md, unbind.md, get-type.md, initialize.md - OpenGL fence: initialize.md, reset.md - OpenGL swap-chain: get-size.md, initialize.md - OpenGL render-target-view: initialize.md, shutdown.md, bind.md, unbind.md, clear.md, get-size.md - OpenGL depth-stencil-view: initialize.md, shutdown.md, bind.md, unbind.md, get-size.md - OpenGL command-list: clear.md All links validated with fix_links.py - no broken references.
2026-03-19 00:54:54 +08:00
| `GetNativeHandle` | [详细文档](../../shader/get-native-handle.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
| `IsValid` | [详细文档](../../shader/is-valid.md) |
| `GetType` | [详细文档](../../shader/get-type.md) |
## 相关文档
- [OpenGL 后端总览](../overview.md)
- [RHIShader](../../shader/shader.md) - 抽象着色器接口
Reference in New Issue Copy Permalink