From 5295ef37186c5b950db733c765ab32817b324a60 Mon Sep 17 00:00:00 2001 From: ssdfasd <2156608475@qq.com> Date: Sat, 4 Apr 2026 17:48:53 +0800 Subject: [PATCH] docs: polish material render metadata docs --- docs/api/XCEngine/Resources/Material/Material/Material.md | 8 ++++---- .../Resources/Material/Material/MaterialRenderQueue.md | 4 ++-- .../Resources/Material/Material/MaterialRenderState.md | 4 ++-- .../XCEngine/Resources/Material/Material/SetShaderPass.md | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/api/XCEngine/Resources/Material/Material/Material.md b/docs/api/XCEngine/Resources/Material/Material/Material.md index bbfa8bef..942be82e 100644 --- a/docs/api/XCEngine/Resources/Material/Material/Material.md +++ b/docs/api/XCEngine/Resources/Material/Material/Material.md @@ -34,8 +34,8 @@ - `shaderPass` 允许材质显式指向目标 shader pass。 - `tags` 则继续承载 `LightMode`、`RenderType` 一类 pass 选择语义。 -`tests/Resources/Material/test_material.cpp` 当前已覆盖默认 render metadata、queue/state 读写、shader pass 读写，以及 tag 的写入/替换/删除/清空语义。 -`tests/Rendering/unit/test_render_scene_extractor.cpp` 当前还依赖 `renderQueue`、`shaderPass` 和 `LightMode` tag 做 pass 选择与排序。 +- `tests/Resources/Material/test_material.cpp` 当前已覆盖默认 render metadata、queue/state 读写、shader pass 读写，以及 tag 的写入/替换/删除/清空语义。 +- `tests/Rendering/unit/test_render_scene_extractor.cpp` 当前还依赖 `renderQueue`、`shaderPass` 和 `LightMode` tag 做 pass 选择与排序。 ## shader schema、默认值与 texture binding @@ -63,8 +63,8 @@ texture binding 当前使用“两层状态”： - `size` - `alignedSize` -有 shader schema 时，布局顺序跟随 shader property 声明顺序。 -没有 shader schema 时，布局顺序退回属性名字典序。 +- 有 shader schema 时，布局顺序跟随 shader property 声明顺序。 +- 没有 shader schema 时，布局顺序退回属性名字典序。 [GetChangeVersion](GetChangeVersion.md) 当前则提供一个轻量 mutation 计数器。大多数公开 setter 最终都会经过内部 `MarkChanged(...)`，从而推进版本号。 diff --git a/docs/api/XCEngine/Resources/Material/Material/MaterialRenderQueue.md b/docs/api/XCEngine/Resources/Material/Material/MaterialRenderQueue.md index 23f59e4b..941b616a 100644 --- a/docs/api/XCEngine/Resources/Material/Material/MaterialRenderQueue.md +++ b/docs/api/XCEngine/Resources/Material/Material/MaterialRenderQueue.md @@ -24,8 +24,8 @@ ## 测试覆盖 -`tests/Resources/Material/test_material.cpp` 当前验证了默认队列是 `Geometry`，并覆盖了枚举与整数两种写入路径。 -`tests/Rendering/unit/test_render_scene_extractor.cpp` 与多组材质状态 integration scene 当前还依赖这些队列值验证排序与透明/不透明分流。 +- `tests/Resources/Material/test_material.cpp` 当前验证了默认队列是 `Geometry`，并覆盖了枚举与整数两种写入路径。 +- `tests/Rendering/unit/test_render_scene_extractor.cpp` 与多组材质状态 integration scene 当前还依赖这些队列值验证排序与透明/不透明分流。 ## 相关文档 diff --git a/docs/api/XCEngine/Resources/Material/Material/MaterialRenderState.md b/docs/api/XCEngine/Resources/Material/Material/MaterialRenderState.md index 1b226323..951f20b6 100644 --- a/docs/api/XCEngine/Resources/Material/Material/MaterialRenderState.md +++ b/docs/api/XCEngine/Resources/Material/Material/MaterialRenderState.md @@ -49,8 +49,8 @@ ## 测试覆盖 -`tests/Resources/Material/test_material.cpp` 当前覆盖了默认值与整结构写入/读回。 -`tests/Rendering/unit/test_render_scene_extractor.cpp` 和多组材质状态 integration scene 当前还依赖它驱动实际渲染状态。 +- `tests/Resources/Material/test_material.cpp` 当前覆盖了默认值与整结构写入/读回。 +- `tests/Rendering/unit/test_render_scene_extractor.cpp` 和多组材质状态 integration scene 当前还依赖它驱动实际渲染状态。 ## 相关文档 diff --git a/docs/api/XCEngine/Resources/Material/Material/SetShaderPass.md b/docs/api/XCEngine/Resources/Material/Material/SetShaderPass.md index a20895e8..f2b1cc73 100644 --- a/docs/api/XCEngine/Resources/Material/Material/SetShaderPass.md +++ b/docs/api/XCEngine/Resources/Material/Material/SetShaderPass.md @@ -20,8 +20,8 @@ void SetShaderPass(const Containers::String& shaderPass); ## 测试覆盖 -`tests/Resources/Material/test_material.cpp` 当前覆盖了 `ForwardLit` 写入与读回。 -`tests/Rendering/unit/test_render_scene_extractor.cpp` 与多组 integration scene 当前还依赖这个入口驱动 `ForwardLit / Unlit / ObjectId` 等 pass 选择。 +- `tests/Resources/Material/test_material.cpp` 当前覆盖了 `ForwardLit` 写入与读回。 +- `tests/Rendering/unit/test_render_scene_extractor.cpp` 与多组 integration scene 当前还依赖这个入口驱动 `ForwardLit / Unlit / ObjectId` 等 pass 选择。 ## 相关文档