UE 4.27 添加自定义ShadingModel

一个专注音视频领域问答的小圈子

基于 UE 4.27 的版本添加自定义的 ShadingModel ，大致分为两步：

1. 在 UE Editor 中添加自定义的 ShadingModel 入口。这样在创建材质时可以选择对应的 ShadingModel 。

2. 在 Shader 中对自定义的 ShadingModel 做渲染上的处理。比如自定义的 BxDF 函数，以及对光照的特殊处理等。

Editor 中添加 ShadingModel 入口

定义 ShadingModel 宏

首先是找到 EngineTypes.h 文件，在这里添加自定义 ShadingModel 对应的宏。

同时要注意下面红框中的内容，提示 ShadingModel 数量要小于等于 16 个，这样一来留给我们拓展的数量就有限了。

通过全局搜索，可以找到 ShadingModel 对应的宏都在哪里被引用了，比如 MSM_ThinTranslucent 的搜索结果：

照着这个引用方式进行处理就可以。

材质添加自定义数据

接下来为自定义的 ShadingModel 添加额外的自定义数据，会在创建材质时多出额外的连接节点。

找到 Material.cpp 文件 IsPropertyActive_Internal 的函数，添加如下代码：

在 MP_CustomData1 和 MP_CustomData0 中添加自定义 ShadingModel 的宏。

同时在 MaterialShared.cpp 文件的 GetAttributeOverrideForMaterial 函数中添加如下代码：

这一步是为自定义的数据添加相关的描述，添加好了之后编译引擎会得到如下效果。

ShadingModel 中有了我们定义的宏，连接节点中有了我们自定义的数据。

定义材质中的宏

添加了自定义 ShadingModel 的宏之外，还需要添加一个材质的宏，可以在材质中进行对该 ShadingModel 进行判断处理。

找到 HLSLMaterialTranslator.cpp 文件中的 GetMaterialEnvironment 函数，添加如下代码：

ShadingModel 渲染处理

添加 ShadingModelID

除了 Editor 中添加自定义 ShadingModel 的宏之外，还需要添加 ShadingModelID ，在后续的 Shader 中更多的是用这个宏来做判断，找到 ShadingCommmon.ush 文件，添加如下代码：

定义 ShadingModel 的调试显示颜色

在 ShadingCommon.ush 文件中还可以定义 ShadingModel 调试时的显示颜色，在 GetShadingModelColor 函数中，添加如下代码：

默认的 DEFAULT_LIT 调试颜色是绿色，上面定义的是黄色，效果如下：

自定义数据写入 GBuffer

要是 ShadingModel 中添加了自定义数据节点，要把它添加到 GBuffer 上，需要开启对应的选项才行，在 BassPassCommon.ush 文件中，添加如下代码：

WRITES_CUSTOMDATA_TO_GBUFFER 宏定义中添加预先定义好的数据。

除此之外，在 DeferredShadingModel.ush 文件的 HasCustomGBufferData 函数中增加自定义的 ShadingModelID 。

HasCustomGBufferData 函数是在解码 GBuffer 数据时根据 ShadingModelID 判断该 GBuffer 上有没有自定义的数据内容。

接下来就是往 GBuffer 中写入自定义数据，在 ShadingModelsMaterial.ush 文件的 SetGBufferForShadingModel 函数中添加如下代码：

该代码会先判断材质中有没有定义相应的宏，其次是判断 ShadingModelID 对不对，所以这两个宏都是必须要定义的。

通过 GetMaterialCustomData0 函数去获取蓝图连接点上的数据并且通过 saturate 函数将返回值限定在 0~1 之间，如果小于 0 就返回 0 ，如果大于 1 就返回 1 。

SetGBufferForShadingModel 函数会在 BasePassPixelShader.usf 中进行调用，写入 GBuffer 数据为延迟渲染使用。

自定义渲染效果 BxDF

接下来是最重要也最灵活多变的自定义渲染效果了，核心在于定义 BxDF 函数。


在 DeferredLightPixelShaders.usf 文件中的如下代码：

FRectTexture RectTexture = InitRectTexture(DeferredLightUniforms.SourceTexture);
float SurfaceShadow = 1.0f;

const float4 Radiance = GetDynamicLighting(WorldPosition, CameraVector, HairScreenSpaceData.GBuffer, HairScreenSpaceData.AmbientOcclusion, HairScreenSpaceData.GBuffer.ShadingModelID, LightData, LightAttenuation, Dither, PixelCoord, RectTexture, SurfaceShadow);

const float  Attenuation = ComputeLightProfileMultiplier(WorldPosition, DeferredLightUniforms.Position, -DeferredLightUniforms.Direction, DeferredLightUniforms.Tangent);

GeyDynamicLighting 函数中的 GetDynamicLightingSplit 函数会调用 IntegrateBxDF 来计算各个 ShadingModelID 对应的 BxDF 函数。

这里作为对比，定义了一个简单的 BxDF 函数，将漫反射颜色设置为 0 。

FDirectLighting CustomBxDF(FGBufferData GBuffer, half3 N, half3 V, half3 L, float Falloff, float NoL, FAreaLight AreaLight, FShadowTerms Shadow )
{
	BxDFContext Context;
	
	Init(Context, N, V, L);
	SphereMaxNoH(Context, AreaLight.SphereSinAlpha, true);
	
	Context.NoV = saturate(abs( Context.NoV ) + 1e-5);

	FDirectLighting Lighting;
	// Lighting.Diffuse  = AreaLight.FalloffColor * (Falloff * NoL) * Diffuse_Lambert( GBuffer.DiffuseColor );
	Lighting.Diffuse  = 0;
	
	Lighting.Specular = AreaLight.FalloffColor * (Falloff * NoL) * SpecularGGX(GBuffer.Roughness, GBuffer.SpecularColor, Context, NoL, AreaLight);
	Lighting.Transmission = 0;
	return Lighting;
}

在只有 DirectionalLight 光照情况下的效果如下：

可以看到高光效果还是有的，缺少了漫反射效果，整个物体都偏黑了。

作为对比，把高光颜色设置为 0 ，正常使用漫反射颜色效果如下：

可以看到有正常的颜色，但是没有了高光效果。

更多效果都可以在 BxDF 函数中去定义了，作为添加自定义 ShadingModel 的流程基本就完成了。

一个专注音视频领域问答的小圈子

公众号音视频开发进阶对应的知识星球，一个编程开发领域的专业圈子，贩卖知识和技巧！

※ 入群须知：了解该星球能提供的价值和帮助，在提问时务必阐述好背景，附带相关的信息。

iOS 用户可以加我微信 ezglumes 邀请你进星球，有疑问也可以加我微信咨询。

※ 星球内容：

基础教程：

在知识星球连载的干货教程，可以在专栏中找到，随着时间的推移，教程也会越来越多：

- 音视频基础概念
- WebRTC 入门教程及源码实践
- 播放器教程及源码实践
- OpenGL 和特效开发教程
- Vulkan 入门教程

部分内容可以在博客 https://glumes.com 中检索到，后面会在星球里持续更新.

干货分享：

涵盖了移动开发和音视频工程领域的绝大部分，从项目实战角度出发，提升能力，包括但不限于以下领域：

- Android/iOS 移动开发
- Camera 开发
- 短视频编辑 SDK 项目实践
- 在线直播和推流
- WebRTC 开发
- 播放器基础和提高
- OpenGL 图像渲染及特效开发
- C++ 基础和提高
- FFmpeg 使用和分析
- 干货资源和书籍分享

不止于技术方面的，各种 IT 新闻、茶余饭后、生活趣事也欢迎大家分享！！！

技术答疑解惑：

针对上述基础教程和干货分享的答疑，另外还有音视频和 IT 开发中的各种交流讨论。

- 基础知识点答疑
- 工业项目实践答疑
- 问题排查思路分析

一个 BUG 排查很久，不如来星球里提个问题，效率提升百倍。

求职和面试辅导：

一站式职场服务，每份工作都值得用心对待！！！

- 面试题和面试经验分享
- 简历修改和模拟面试
- 大厂内推和信息同步
- 职场经验分享
- 职业规划和发展分析

※ 星主和合伙人介绍

星主是公众号音视频开发进阶的作者，也是网站 https://glumes.com 的作者，曾参与过抖音、剪映等头部音视频 APP 底层 SDK 的开发。

合伙人也是在头条、快手从事音视频架构师的职位，具有多年的音视频开发经验，能力圈覆盖了音视频的绝大多数领域，资深音视频从业人员为你保驾护航。

微信公众号

扫描下面的二维码关注我的微信公众号《音视频开发进阶》，推送更多精彩内容！

添加我的微信 ezglumes 拉你入音视频与图形图像技术群一起交流学习~

原创文章，转载请注明来源:    UE 4.27 添加自定义ShadingModel