UE4 调试着色器编译过程

1623 篇文章 22 订阅
1277 篇文章 12 订阅
Debugging Shaders

调试着色器编译过程

  April 19, 2016 | 
启用 CVAR 以允许转储中间着色器

在 ConsoleVariables.ini 文件(通常位于 Engine/Config/ConsoleVariables.ini)中,启用下列 Cvar:

cVar

在调试时构建 SHADERCOMPILEWORKER

默认情况下,UnrealBuildTool (UBT) 将为工具生成项目,以便始终在开发时进行编译。要在调试时构建项目,请将 ShaderCompileWorker 的解决方案属性(Visual Studio:生成 -> 配置管理器)更改为 Debug_Program:

解决方案配置

生成中间文件

此刻,您想要生成可调试的文件;启用 Cvar 将允许后续编译转储所生成的文件;要强制重建所有着色器,请在Engine/Shaders/Common.usf 中添加一个空格或进行更改,然后重新运行编辑器。这将重新编译着色器并转储Project/Saved/ShaderDebugInfo 文件夹中的所有中间文件。

转储的着色器的文件夹结构

让我们分析转储的文件的完整路径:

D:\UE4\Samples\Games\TappyChicken\Saved\ShaderDebugInfo\PCD3D_SM5\M_Egg\LocalVF\BPPSFNoLMPolicy\BasePassPixelShader.usf

项目的根路径:

D:\UE4\Samples\Games\TappyChicken\Saved\ShaderDebugInfo\PCD3D_SM5\M_Egg\LocalVF\BPPSFNoLMPolicy\BasePassPixelShader.usf

转储着色器的根路径:

D:\UE4\Samples\Games\TappyChicken\Saved\ShaderDebugInfo\PCD3D_SM5\M_Egg\LocalVF\BPPSFNoLMPolicy\BasePassPixelShader.usf

现在,对于每种着色器格式/平台,您可找到一个子文件夹,在本例中,这是 PC D3D Shader Model 5:

D:\UE4\Samples\Games\TappyChicken\Saved\ShaderDebugInfo\PCD3D_SM5\M_Egg\LocalVF\BPPSFNoLMPolicy\BasePassPixelShader.usf

现在,对于每个材质名称都有一个对应的文件夹,并且有一个名为 Global 的特殊文件夹。在本例中,我们在 M_Egg 材质内:

D:\UE4\Samples\Games\TappyChicken\Saved\ShaderDebugInfo\PCD3D_SM5\M_Egg\LocalVF\BPPSFNoLMPolicy\BasePassPixelShader.usf

着色器分组在贴图内并按顶点工厂排序,而这些顶点工厂通常最终对应于网格/元件类型;在本例中,有一个“本地顶点工厂”:

D:\UE4\Samples\Games\TappyChicken\Saved\ShaderDebugInfo\PCD3D_SM5\M_Egg\LocalVF\BPPSFNoLMPolicy\BasePassPixelShader.usf

最后,下一路径是特性的排列;因为我们早先已启用 r.DumpShaderDebugShortNames=1,所以名称已压缩(以减小路径长度)。如果将其设置为 0,那么完整路径将是:

D:\UE4\Samples\Games\TappyChicken\Saved\ShaderDebugInfo\PCD3D_SM5\M_Egg\FLocalVertexFactory\TBasePassPSFNoLightMapPolicy\BasePassPixelShader.usf

在该文件夹中,有一个批处理文件和一个 usf 文件。这个 usf 文件就是要提供给平台编译器的最终着色器代码。您可通过这个批处理文件来调用平台编译器,以查看中间代码。

使用 SHADERCOMPILEWORKER 进行调试

从 4.11 版开始,我们为 ShaderCompileWorker (SCW) 添加了一项功能,使其能够调试平台编译器调用;命令行如下所示:

PathToGeneratedUsfFile -directcompile -format=ShaderFormat -ShaderType -entry=EntryPoint

  • PathToGeneratedUsfFile 是 ShaderDebugInfo 文件夹中的最终 usf 文件
  • ShaderFormat 是您想要调试的着色器平台格式(在本例中,这是 PCD3D_SM5)
  • ShaderType 是 vs/ps/gs/hs/ds/cs 中的一项,分别对应于“顶点”、“像素”、“几何体”、“物体外壳”、“域”和“计算”着色器类型
  • EntryPoint 是 usf 文件中此着色器的入口点的函数名称

例如,D:\UE4\Samples\Games\TappyChicken\Saved\ShaderDebugInfo\PCD3D_SM5\M_Egg\LocalVF\BPPSFNoLMPolicy\BasePassPixelShader.usf-format=PCD3D_SM5 -ps -entry=Main

现在,您可以对 D3D11ShaderCompiler.cpp 中的 CompileD3D11Shader() 函数设置断点,通过命令行运行 SCW,并且应该能够开始了解如何调用平台编译器。

有关此主题的更多信息,请参阅虚幻引擎文档的以下两个页面:

内容

  • 2
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
要设置UE源码编译平台,需要按照以下步骤进行操作。 1. 获取Unreal Engine源代码。可以通过Epic Games的GitHub仓库或者Unreal Engine官网下载源代码压缩包。 2. 解压缩源代码到本地计算机的合适位置。 3. 安装必要的软件和工具。编译Unreal Engine需要一些依赖软件和工具,例如Visual Studio(推荐使用VS2017或更高版本)、Windows SDK、DirectX、CMake等。根据Unreal Engine版本和所需功能进行适当安装。 4. 打开解压缩后的源代码目录,找到Setup.bat文件并运行。此脚本将执行一系列设置和配置操作,以确保编译环境的正确性。 5. 选择要编译的目标平台。根据项目需求,使用Setup.bat脚本提供的选项选择要编译的目标平台,例如Windows、Mac、Linux等。 6. 使用CMake生成项目文件。在源代码目录中,找到GenerateProjectFiles.bat文件并运行。此脚本将使用CMake生成项目文件。 7. 打开生成的项目文件。根据所用的开发工具,例如Visual Studio,使用生成的项目文件打开Unreal Engine。这将加载Unreal Engine的代码,并准备进行编译。 8. 编译Unreal Engine。使用开发工具进行编译,确保选择正确的编译配置和目标平台。编译过程可能需要一些时间,具体时间取决于计算机性能和项目大小。 9. 完成编译后,可以开始使用编译后的Unreal Engine。根据需要,可以运行自己的项目或者使用Unreal Engine进行开发或测试。 需要注意的是,UE源码编译平台的设置过程可能会因个人计算机的配置和项目需求而略有差异。建议在参考官方文档和社区参考资料的基础上进行设置,并根据实际情况调整。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值