docs(rendering): sync render surface state and sample docs
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
# RenderSurface::GetSampleQuality
|
||||
|
||||
返回当前 surface 的 sample quality。
|
||||
```cpp
|
||||
uint32_t GetSampleQuality() const;
|
||||
```
|
||||
|
||||
## 返回值
|
||||
|
||||
- 返回内部保存的 quality 值;默认值是 `0`。
|
||||
|
||||
## 当前语义
|
||||
|
||||
- 这个值会被 `RenderSurfacePipelineUtils` 继续写入 `GraphicsPipelineDesc.sampleQuality`。
|
||||
- 当前实现保证单采样 surface 的 quality 总是 `0`;只有多采样时这里才可能返回调用方显式设置的非零值。
|
||||
- `CameraRenderRequest` 的 surface 合法性检查也依赖“单采样时 quality 必须为 `0`”这条约束。
|
||||
|
||||
## 调用方影响
|
||||
|
||||
- 如果后端只识别 `sampleCount`,调用方仍可以保留统一的 `RenderSurface` 描述,而把 `sampleQuality` 当作由具体 RHI 选择性消费的附加信息。
|
||||
- 对 fullscreen post-process / final-output 链路而言,`sampleCount == 1 && sampleQuality == 0` 才是当前允许的输入形态。
|
||||
|
||||
## 测试覆盖
|
||||
|
||||
- `tests/Rendering/unit/test_builtin_forward_pipeline.cpp`
|
||||
- `tests/Rendering/unit/test_camera_scene_renderer.cpp`
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [RenderSurface](RenderSurface.md)
|
||||
- [SetSampleDesc](SetSampleDesc.md)
|
||||
- [GetSampleCount](GetSampleCount.md)
|
||||
- [CameraRenderRequest](../Planning/CameraRenderRequest/CameraRenderRequest.md)
|
||||
Reference in New Issue
Block a user