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;
}