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/opengl/render-target-view/bind-framebuffer.md
Normal file
20
docs/api/rhi/opengl/render-target-view/bind-framebuffer.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# OpenGLRenderTargetView::BindFramebuffer
|
||||
|
||||
```cpp
|
||||
static void BindFramebuffer(unsigned int framebuffer)
|
||||
```
|
||||
|
||||
静态方法,将指定帧缓冲区绑定为当前渲染目标。
|
||||
|
||||
**参数:**
|
||||
- `framebuffer` - 帧缓冲区 ID(0 表示解除绑定)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLRenderTargetView::BindFramebuffer(rtv.GetFramebuffer());
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLRenderTargetView](render-target-view.md) - 返回类总览
|
||||
19
docs/api/rhi/opengl/render-target-view/get-framebuffer.md
Normal file
19
docs/api/rhi/opengl/render-target-view/get-framebuffer.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLRenderTargetView::GetFramebuffer
|
||||
|
||||
```cpp
|
||||
unsigned int GetFramebuffer() const
|
||||
```
|
||||
|
||||
获取帧缓冲区对象 ID。
|
||||
|
||||
**返回:** `unsigned int` - 帧缓冲区 ID
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
unsigned int fbo = rtv.GetFramebuffer();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLRenderTargetView](render-target-view.md) - 返回类总览
|
||||
19
docs/api/rhi/opengl/render-target-view/get-mip-level.md
Normal file
19
docs/api/rhi/opengl/render-target-view/get-mip-level.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLRenderTargetView::GetMipLevel
|
||||
|
||||
```cpp
|
||||
int GetMipLevel() const
|
||||
```
|
||||
|
||||
获取 mipmap 级别。
|
||||
|
||||
**返回:** `int` - mip 级别
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
int mipLevel = rtv.GetMipLevel();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLRenderTargetView](render-target-view.md) - 返回类总览
|
||||
19
docs/api/rhi/opengl/render-target-view/get-texture.md
Normal file
19
docs/api/rhi/opengl/render-target-view/get-texture.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# OpenGLRenderTargetView::GetTexture
|
||||
|
||||
```cpp
|
||||
unsigned int GetTexture() const
|
||||
```
|
||||
|
||||
获取关联的纹理对象 ID。
|
||||
|
||||
**返回:** `unsigned int` - 纹理 ID
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
unsigned int tex = rtv.GetTexture();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLRenderTargetView](render-target-view.md) - 返回类总览
|
||||
25
docs/api/rhi/opengl/render-target-view/initialize-cubemap.md
Normal file
25
docs/api/rhi/opengl/render-target-view/initialize-cubemap.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# OpenGLRenderTargetView::InitializeCubemap
|
||||
|
||||
```cpp
|
||||
bool InitializeCubemap(unsigned int cubemap, int face, int mipLevel = 0)
|
||||
```
|
||||
|
||||
初始化立方体贴图的渲染目标视图。
|
||||
|
||||
**参数:**
|
||||
- `cubemap` - 立方体贴图对象 ID
|
||||
- `face` - 立方体贴面索引(0-5)
|
||||
- `mipLevel` - mipmap 级别(默认为 0)
|
||||
|
||||
**返回:** `bool` - 成功返回 true,失败返回 false
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLRenderTargetView rtv;
|
||||
rtv.InitializeCubemap(cubemapTexture, 0, 0);
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLRenderTargetView](render-target-view.md) - 返回类总览
|
||||
26
docs/api/rhi/opengl/render-target-view/render-target-view.md
Normal file
26
docs/api/rhi/opengl/render-target-view/render-target-view.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# OpenGLRenderTargetView
|
||||
|
||||
**命名空间**: `XCEngine::RHI`
|
||||
|
||||
**描述**: OpenGL 渲染目标视图实现。
|
||||
|
||||
## 方法列表
|
||||
|
||||
| 方法 | 文档 |
|
||||
|------|------|
|
||||
| `Initialize` | [详细文档](../../../threading/task-system/initialize.md) |
|
||||
| `InitializeCubemap` | [详细文档](initialize-cubemap.md) |
|
||||
| `Shutdown` | [详细文档](../../../threading/task-system/shutdown.md) |
|
||||
| `Bind` | [详细文档](../../shader/bind.md) |
|
||||
| `Unbind` | [详细文档](../../shader/unbind.md) |
|
||||
| `Clear` | [详细文档](../../../memory/linear-allocator/clear.md) |
|
||||
| `GetFramebuffer` | [详细文档](get-framebuffer.md) |
|
||||
| `GetTexture` | [详细文档](get-texture.md) |
|
||||
| `GetMipLevel` | [详细文档](get-mip-level.md) |
|
||||
| `GetWidth` / `GetHeight` | [详细文档](../../buffer/get-size.md) |
|
||||
| `BindFramebuffer` | [详细文档](bind-framebuffer.md) |
|
||||
| `UnbindFramebuffer` | [详细文档](unbind-framebuffer.md) |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGL 后端总览](../overview.md)
|
||||
17
docs/api/rhi/opengl/render-target-view/unbind-framebuffer.md
Normal file
17
docs/api/rhi/opengl/render-target-view/unbind-framebuffer.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# OpenGLRenderTargetView::UnbindFramebuffer
|
||||
|
||||
```cpp
|
||||
static void UnbindFramebuffer()
|
||||
```
|
||||
|
||||
静态方法,解除当前渲染目标帧缓冲区的绑定。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
OpenGLRenderTargetView::UnbindFramebuffer();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [OpenGLRenderTargetView](render-target-view.md) - 返回类总览
|
||||
Reference in New Issue
Block a user