docs: rebuild Rendering API content
This commit is contained in:
32
docs/api/XCEngine/Rendering/RenderContext/IsValid.md
Normal file
32
docs/api/XCEngine/Rendering/RenderContext/IsValid.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# RenderContext::IsValid
|
||||
|
||||
检查当前渲染上下文是否具备最基础的执行条件。
|
||||
|
||||
```cpp
|
||||
bool IsValid() const;
|
||||
```
|
||||
|
||||
## 行为说明
|
||||
|
||||
当前实现直接检查:
|
||||
|
||||
```cpp
|
||||
return device != nullptr && commandList != nullptr && commandQueue != nullptr;
|
||||
```
|
||||
|
||||
## 返回值
|
||||
|
||||
- 当 `device`、`commandList` 和 `commandQueue` 都非空时返回 `true`。
|
||||
- 否则返回 `false`。
|
||||
|
||||
## 当前实现限制
|
||||
|
||||
- 当前不会检查这些对象之间是否匹配同一后端。
|
||||
- 当前不会检查命令列表是否已 `Reset()`、命令队列是否可提交,或设备是否已正确初始化。
|
||||
- `backendType` 不参与这个判定。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类型总览](RenderContext.md)
|
||||
- [SceneRenderer::Render](../SceneRenderer/Render.md)
|
||||
- [RenderPipeline::Initialize](../RenderPipeline/Initialize.md)
|
||||
Reference in New Issue
Block a user