docs(rendering): realign api docs to module structure

This commit is contained in:
2026-04-10 16:55:33 +08:00
parent 8cde4e0649
commit 4d8a51aee2
95 changed files with 1136 additions and 1585 deletions

View File

@@ -0,0 +1,31 @@
# ObjectIdRenderRequest::IsRequested
检查当前是否请求了 object-id 辅助输出。
```cpp
bool IsRequested() const;
```
## 行为说明
当前头文件内联实现只有一条判断:
```cpp
return !surface.GetColorAttachments().empty();
```
## 返回值
- 只要 `surface` 上至少挂了一个颜色附件,就返回 `true`
- 否则返回 `false`
## 注意事项
- 这不是完整性校验;颜色附件数组非空并不代表第一个附件非空,也不代表深度附件和 render area 合法。
- 真正更严格的检查在 [IsValid](IsValid.md)。
## 相关文档
- [返回类型总览](ObjectIdRenderRequest.md)
- [IsValid](IsValid.md)
- [CameraRenderRequest](../CameraRenderRequest.md)