Untoon Engine

Home

本页目录

Untoon Engine Wiki

这个 Wiki 记录 untoon 分支的结构、渲染管线和维护规则，主要给三类人看：

  • 引擎维护者：理解分支结构、核心改动、上游合并策略
  • 图形程序员：理解 Untoon 渲染管线、材质节点和渲染集成点
  • 技术美术与美术：理解材质制作、灯光参数和调参工作流

Untoon Engine 基于 Unreal Engine 5.8 源码。相对 release，分支增加了原生 MSM_Untoon Shading Model、专用 Render Pass、GBufferToon、自定义材质节点、灯光 Light|Toon 参数和后处理 Untoon 控制。

新增相机侧局部优先显示，复用现有 MSM_Untoon 与 GBuffer 编码。首版支持桌面 Deferred 的普通静态／骨骼 Opaque、Masked Toon 材质；Nanite 保留普通遮挡，暂不参与新功能。用法见材质指南，支持边界与未完成的运行验证见优先显示验收。

Wiki 导航

建议阅读路径

第一次接触这个分支，可以按这个顺序读：

  1. 概览与定位
  2. 快速开始
  3. Untoon 渲染管线总览
  4. 材质编写指南
  5. 灯光与后处理指南

要继续维护这个引擎分支，重点看：

  1. 维护者规则
  2. 分支与版本策略
  3. 渲染器架构说明
  4. 追踪宏速查
  5. 上游合并检查清单

核心能力摘要

  • 原生 MSM_Untoon Shading Model
  • Untoon 专用 GBuffer 数据编码
  • 保留但当前禁用的 Untoon Base Pass 入口
  • Untoon Light Pass
  • Untoon Shadow Mask 生成与模糊
  • Nanite 专用 ToonShadowMask / ToonLight 后置导出
  • Untoon Outline 合成
  • Toon Light、ToonShadowMask、ToonPassSwitch 材质节点
  • Light|Toon 灯光参数
  • Untoon Diffuse 场景/后处理控制

核心维护规则

Untoon 在上游引擎文件中的源码改动必须用 Untoon Engine Start/End 包裹。两个 Untoon 自有目录例外：

  • Engine/Shaders/Private/Untoon
  • Engine/Source/Runtime/Renderer/Private/Untoon

marker 只保留一层。如果改动位置已经在现有 marker 内，直接修改该 marker 内代码，不要再嵌套一层。完整规则见 维护者规则。

文档维护约定

  • 面向使用者的页面先讲用途再讲步骤，面向维护者的页面要给出实际代码路径。
  • 架构文档要写清相对 release 改了什么。
  • 新增 Untoon 功能时，同时更新 Maintainer-Rules、Toon-Rendering-Pipeline、Material-Authoring-Guide、Renderer-Architecture、Upstream-Merge-Checklist。