refactor(docs): RHI模块文档重构 - 修复18处链接错误并新增RHIFramebuffer/RHIRenderPass文档
- 修复opengl/下13个文件对overview.md的错误引用,改为opengl.md - 修复opengl/shader/下2处get-native-handle.md的错误路径引用 - 修复rhi.md中rhifactory路径错误 - 修复opengl.md中对d3d12.md的错误引用 - 修复opengl/README.md中的overview.md引用 - 新增RHIFramebuffer完整文档(7个文件) - 新增RHIRenderPass完整文档(7个文件) - 更新rhi.md总览页,添加RHIFramebuffer和RHIRenderPass分类
This commit is contained in:
27
docs/api/rhi/framebuffer/is-valid.md
Normal file
27
docs/api/rhi/framebuffer/is-valid.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# RHIFramebuffer::IsValid
|
||||
|
||||
检查帧缓冲是否有效。
|
||||
|
||||
```cpp
|
||||
virtual bool IsValid() const = 0;
|
||||
```
|
||||
|
||||
判断帧缓冲是否已正确初始化且可用于渲染操作。
|
||||
|
||||
**返回:** `bool` - 帧缓冲有效返回 `true`,无效返回 `false`
|
||||
|
||||
**线程安全:** ✅
|
||||
|
||||
**注意:**
|
||||
- 返回 `false` 可能原因:未初始化、初始化失败、已被 `Shutdown`
|
||||
- 在调用 `Initialize` 前调用此方法会返回 `false`
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
if (framebuffer->IsValid()) {
|
||||
// 执行渲染操作
|
||||
} else {
|
||||
// 处理无效帧缓冲
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user