UE4 调试着色器编译过程

ゝ一纸荒年。 2022-08-23 00:33 350阅读 0赞

![Debugging Shaders][]

# 调试着色器编译过程 #

Rolando Caloca 在 April 19, 2016 | [学习][Link 1][编程][Link 2]

*  [Share on Facebook][]
 *  [Share on Twitter][]
 *  [Share on Google+][Share on Google]
 *  [Share on LinkedIn][]

#### 启用 CVAR 以允许转储中间着色器 ####

在 ConsoleVariables.ini 文件（通常位于 Engine/Config/ConsoleVariables.ini）中，启用下列 Cvar：

![cVar][]

#### 在调试时构建 SHADERCOMPILEWORKER ####

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

![解决方案配置][image2-700x443-555743536.jpg]

#### 生成中间文件 ####

此刻，您想要生成可调试的文件；启用 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，并且应该能够开始了解如何调用平台编译器。

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

*  [着色器开发][Link 3]
 *  [HLSL 交叉编译器][HLSL]

# 内容 #

[Debugging Shaders]: /images/20220722/1a3975dac6b344ecaf4803caae8ad8a6.png
[Link 1]: https://www.unrealengine.com/zh-CN/blog?category=%E5%AD%A6%E4%B9%A0
[Link 2]: https://www.unrealengine.com/zh-CN/blog?category=%E7%BC%96%E7%A8%8B
[Share on Facebook]: http://www.facebook.com/sharer.php?u=
[Share on Twitter]: http://twitter.com/share
[Share on Google]: https://plus.google.com/share?url=
[Share on LinkedIn]: http://www.linkedin.com/shareArticle?mini=true&url=
[cVar]: /images/20220722/aa0af68b9eaf48b98aaa83e5c4204370.png
[image2-700x443-555743536.jpg]: /images/20220722/8a40ac5df58b4d40ab8339b82b2e4fdf.png
[Link 3]: https://docs.unrealengine.com/latest/INT/Programming/Rendering/ShaderDevelopment/index.html
[HLSL]: https://docs.unrealengine.com/latest/INT/Programming/Rendering/ShaderDevelopment/HLSLCrossCompiler/index.html

发表评论取消回复

表情：

评论列表（有 0 条评论，350人围观）

还没有评论，来说两句吧...

相关阅读

相关顶点着色器和片元着色器

管线也称渲染管线，因为 OpenGL ES在渲染处理过程中会顺序执行一系列操作，这一系列相关的处理阶段就被称为OpenGL ES 渲染管线。OpenGL ES 渲染过程

心已赠人/ 2023年03月03日 11:14/ 0 赞/ 20 阅读

相关 UE4的编译配置说明

通常我们按照官网文档或者教程，在第一次编译UE4的时候都会让我们选择编译Development Editor。但是你又没有想过除了这个选项之外还有很多选项，他们是干什么的。

柔情只为你懂/ 2023年02月23日 10:59/ 0 赞/ 1 阅读

相关 UE4 调试着色器编译过程

![Debugging Shaders][] 调试着色器编译过程 Rolando Caloca 在 April 19, 2016 | [学习][Link 1][编程]

ゝ一纸荒年。/ 2022年08月23日 00:33/ 0 赞/ 351 阅读

相关 RM_砖块着色器

案例效果图： ![20150421131735148][] 顶点着色器： uniform vec3 LightPosition; cons

刺骨的言语ヽ痛彻心扉/ 2022年08月07日 17:32/ 0 赞/ 204 阅读

相关【OpenGL】着色器 Shader

写在前面前面的几个例子使用的都是固定管线，又叫立即渲染模式，这个模式下 opengl 把渲染的细节封装隐藏起来，开发人员使用起来非常容易，但效率比较低且不够灵活。现代

秒速五厘米/ 2022年06月10日 12:29/ 0 赞/ 352 阅读

相关 Vulkan【12】着色器

着色器本节的代码是 `11-init_shaders.cpp` 编译 GLSL 着色器为 SPIR-V Vulkan的底层着色器代码是SPIR-V。示例程序将

我不是女神ヾ/ 2022年05月14日 11:18/ 0 赞/ 413 阅读

相关 UE4 编译错误集棉

UE4 编译错误集棉 Error ：MSB3075 code 5 Error ：c2061 语法错误或引用错误 error CS0122 CS005

落日映苍穹つ/ 2022年03月30日 02:54/ 0 赞/ 426 阅读

相关 Qt+OpenGL——着色器

定义与结构着色器是使用一种叫GLSL的类C语言写成的运行在GPU上的小程序。这些小程序为图形渲染管线的某个特定部分而运行。从基本意义上来说，着色器只是一种把输入转化为输

小鱼儿/ 2022年01月28日 15:15/ 0 赞/ 490 阅读

相关无光照着色器

这是一个Unity简单的无光照着色器的简单编写---修改物体的颜色; 说明一点：Unity着色语言是CG语言和ShaderLab语言的混合； CGPROGRAM---END

阳光穿透心脏的1/2处/ 2021年10月29日 06:48/ 0 赞/ 352 阅读

相关物体着色过程

物体着色过程： 1、顶点和相关数据发送到顶点着色器； 2、顶点着色器在每个顶点上运行； 3、顶点着色器为每个顶点输出一个数据结构体，包括顶点在最终图像上的颜色； 4、顶

川长思鸟来/ 2021年10月20日 00:28/ 0 赞/ 338 阅读