GPU转储文件查看器工具

DumpGPU 是一个不受平台限制的控制台命令，能够将中间渲染资源二进制文件或采集帧转储到磁盘中。转储文件会保存为.json和.bin文件，可以使用轻量级的网页浏览器查看。

该命令具有多个用途：

• 可供所有版本使用，无需安装第三方GPU调试工具，也无需重启编辑器。
• 可从任意支持平台中转储：
• Windows D3D11、D3D12、Vulkan
• Linux Vulkan
• Mac Metal、AGX
• PlayStation 4和PlayStation 5
• XboxOne、Xbox Series X/S
• Nintendo Switch
• iOS和Android
• 可从任意支持Chrome和兼容WebGL 2.0 GPU的平台上浏览
• 使用简单，不受平台限制，任何人都能在遭遇瑕疵时进行GPU转储。
• 当美术师在编辑器中遇到预料之外、难以重现的问题时，适合使用该命令。
• 能减少浏览二进制资源所导致的分歧。
• 平台GPU采集通常需要正确的SDK，并需要开发包来分析资源。GPUDump查看器使开发者能够更好地鉴别错误，还能根据问题的背景环境，在任意平台上分析资源。
• 对编写新渲染功能的图形编程员来说，这项工具提供了更快速的迭代工作流程，方便分析可能发生的情况。

转储流程

要为某一帧启动GPU转储流程，可以在控制台窗口中输入命令 DumpGPU，或者使用键盘快捷键 CTRL+Shift+/。

启动该命令后，它需要将中间渲染资源复制到磁盘里。为了进行处理，采集速度会为内存做出牺牲，以限制内存错误产生。这可以确保转储能够稳定地收集罕见或难以重现的瑕疵数据，并且不会导致重现流程崩溃。

	GlobalDefinitions.Add("ALLOW_CONSOLE_IN_SHIPPING=1");
	GlobalDefinitions.Add("ALLOW_DUMPGPU_IN_SHIPPING=1");

Copy full snippet

GPU转储文件的保存位置

进行GPU转储时，在默认情况下，它会被存储在项目的根目录下的 Saved/GPUDumps 中。在桌面平台上，完成转储后，资源管理器会自动打开转储位置窗口。

对于 暂存（Staged） 版本，它们会保存在该暂存的Saved目录下，路径格式为：[暂存目录] / [平台名称] / [项目名称] / Saved / GPUDumps。

移动平台转储文件的保存位置

在移动平台上，GPU转储文件会保存在以下位置：

转储设置

以下命令可根据你的需求，产生量身定制的GPU转储文件：

DumpGPU命令如何复制GPU转储文件查看器

GPU转储文件查看器源代码位于引擎源代码中，可以在 /Engine/Extras/GPUDumpViewer 下找到。

对于非发布版本，GPU转储文件查看器会在暂存目录下自动复制。在调用DumpGPU以转储该帧时，文件就会从暂存目录中，复制到转储目录下。

如果你拥有发布暂存版本，由于GPU转储文件查看器的HTML源代码在暂存目录中缺失，它可能不会被复制到转储目录下。在这种情况下，你可以将库的 //Engine/Extras/GPUDumpViewer 应用复制到转储目录中，以打开转储文件。

GPU转储文件查看器

GPU转储文件查看器是一个基于网络的HTML应用。你可以在查看器中了解虚幻引擎渲染的运行情况。

首先，在进行GPU转储时，操作系统会打开保存转储文件的文件夹位置。双击 OpenGPUDumpViewer.bat 文件可以在Chrome中打开查看器。

启动后会打开一个新的Chrome窗口，并运行 GPU转储文件查看器。

Chrome无痕式窗口中打开的GPU转储文件查看器网络应用。

GPU转储文件查看器是一个网络应用，功能和其他浏览器页面或应用相似。以下是使用GPU转储文件查看器的小技巧：

• 所有链接都可以点击，并且可以打开自己的标签页，以便快速访问。
• 使用前进和后退按钮导航，可以在之前浏览过的页面之间往返。
• 如果要和其他人分享采集内容，你可以分享#部分后的链接，让他们通过链接直接访面板和转储部分。例如：#display_output_resource(96,'0000000067e1bfa0.mip0');

1. 标题栏和面板 1.通道和资源树 1.查看器

标题栏和面板

主标题栏提供了简单的参考信息，包括项目名称、操作系统、RHI和创建转储时所用的版本。其中还包含了可点击的信息面板，能够生成项目的综合信息、使用的控制台变量，以及项目日志副本。

信息面板

信息 面板包含了GPU转储文件的摘要信息。你可以找到关于系统、驱动和引擎版本的实用信息，以及后台缓冲区中最终图像的截图。

CVars面板

CVars 面板包含了一张可搜索的渲染控制台变量列表（开头为 .r.* 或 .sg.*，或包含RHI关键词），可以在进行转储前运行。

日志面板

日志 面板提供了项目日志的副本，它会在完成转储时，和转储文件一同保存。你也可以在这里检查转储过程中是否发出过警告。

查看器

查看区域会显示选中的各个通道、纹理和缓冲区的信息。

通道查看器

在绘制事件层级中点击一个 通道 时，只会显示该通道读取和修改的资源。它会自动打开第一个输出资源，无论该资源是纹理还是缓冲区。

在通道名称旁（位于查看器顶部），你可以找到 通道参数（Pass Parameters） 按钮。

点击该按钮会显示原始通道参数。通常情况下，通道参数就是着色器参数。例如在使用 FComputerShaderUtils::AddPass() 或 FPixelShaderUtils::AddPass() 的情况下。

通道参数使你能够进行验证，确保来自CPU的非数实例不会通过着色器参数来影响着色器。

纹理查看器

在通道视图的 输入资源 或 输出资源 列表中选择一个 纹理 时，你就可以在查看器中看到它的像素。

WebGL 2.0的画布使你能够加载原始二进制资源（RHI已将其复制到转储目录下）以查看纹理，就可以使用更简单的WebGL像素着色器显示。如果是32位UINT纹理等WebGL不支持的格式，则还需在幕后进行更多处理，才能准确地模拟像素格式。

纹理查看器包含了多个按钮，它们位于显示的纹理上方：

• 设置在查看器中显示纹理的大小，或者使其与窗口大小匹配。

• 复制到粘贴板 可以将当前显示的纹理和相关资源信息复制到粘贴板上。将其粘贴到文本编辑器或电子邮件中时，你会看到图中所示的情况：

  
• 有三个按钮可以更改纹理视图模式：可视化 是标准的纹理视图模式，而 NaN（非数）和 Inf（无穷）视图模式可用于甄别相应类型的像素错误。

将鼠标悬停在纹理上可以返回光标纹素位置当前的RGBA值。左键点击鼠标可以采集并保存纹素RGBA位置值。

如果你想更仔细地查看纹理的某个部分，可以使用鼠标滚轮缩放纹理。放大纹理时，你可以点击右键并拖动纹理。

显示纹理下方的区域提供了纹理的关键信息和渲染方式。

1. 纹理描述符
2. 自定义WebGL 2.0可视化着色器
3. 修改资源的通道
4. 读取资源的通道

纹理描述符

纹理描述符 展示了当前显示纹理的相关信息。这一个使用的设置是 FRDGBuilder::CreateTexture()。

WebGL 2.0可视化着色器

WebGL 2.0可视化着色器 展示了在顶部窗口中显示纹理所编译的代码段。下方的编译日志窗口会显示所有出现的编译错误。

WebGL 2.0画布窗口是一个可编辑的文本框，能够用于编写任意WebGL 2.0 GLSL。它可以通过自定义设置，使图像在每个通道中压缩多个字节的信息时，或者使用不同的色彩空间时，对纹理进行解码和显示。输入此栏的代码会自动重新编译，并显示所有错误。

与虚幻引擎在虚幻着色器格式（.usf）与虚幻着色器头文件（.ush）中用于编写内部HLSL渲染代码所用的语法相比，WebGL 2.0着色器使用的语法并不相同。要了解GLSL语法，WebGL 2.0参考卡片的链接位于编译窗口底部。

修改与读取的通道

在最底部有两个窗口，一个显示了对选定资源进行修改的通道，另一个显示了读取选定资源的通道。在两个通道列表中，点击通道就能使其显示在查看器中。

缓冲区查看器

在通道 输入资源 或 输出资源 列表中选中要查看的纹理之后，缓冲区 视图会列出它的描述符和可视化内容。

缓冲区描述符 列出了选定资源的综合信息，包括名称、大小、说明、使用及其他信息。

缓冲区可视化 会使用十进制或0x前缀的十六进制值列出缓冲区中的地址。

使用 地址 文本栏可以跳转到十进制或0x前缀的特定地址。

列表格式可以自定义，并支持以下类型：

• Float、Half
• Int、short、字符
• Uint、ushort、字符
• Hex()或bin()，分别会以十六进制或二进制显示以上格式。

由于GPU转储文件查看器并不知道数据的解译方式，缓冲区默认对数据可视化使用 hex(uint) 格式，除非其带有 DrawIndirect 使用标志，此时将改为使用 Uint 格式。

模板 FRDGBufferDesc::Create*() 函数可以使用着色器参数架构，创建自己的 FRDGBuffer，方便你浏览缓冲区的内容。