RenderDoc

RenderDoc是可用于执行单帧采集并进行检查的standalone开源图形调试器。

Windows
MacOS
Linux

RenderDoc是一款免费的standalone开源图形调试器,可用于对虚幻引擎4(UE4)等应用程序执行单帧采集。采集内容将被载入到RenderDoc中,并通过事件、API等内容全面检查GPU上的情况。

安装RenderDoc

RenderDoc是一款开源图形调试器,可从RenderDoc.org 免费下载和安装。

以下列表指明了RenderDoc当前支持的操作系统和API,它们与UE4的支持可能有所不同。欲知最新更新,请参阅RenderDoc的FAQ 页面。

支持操作系统

Windows 7和10

Linux

Android

Google Stadia

Nintendo Switch

支持API

Vulkan

D3D11

D3D12

Open GL3.2+

Open GL ES 2.0 - 3.2

启用RenderDoc插件

无需启用RenderDoc插件即可将其与虚幻引擎项目一同使用。Standalone RenderDoc可兼容UE4可执行文件。请参阅RenderDoc文档 ,了解设置指南。

虚幻引擎4自带了一个在编辑器中执行下一帧采集并在RenderDoc中自动打开该采集的简易插件。使用以下步骤即可在您的项目中将其启用:

  1. 导航到主菜单,选择 编辑(Edit) > 插件(Plugins) 打开插件浏览器。

  2. 您可在 渲染(Rendering) 类目下找到 RenderDoc插件(RenderDoc Plugin),也可直接使用插件浏览器窗口顶部的搜索栏。

    EnablingRenderDoc_1.png

  3. 勾选 启用(Enabled) 旁边的复选框,并在出现提示后重新启动编辑器。

编辑器重新启动后,关卡视口的右上角将包含新的UI按钮。您可使用它来执行采集。

EnablingRenderDoc_2.png

执行帧采集

以下步骤详细介绍如何使用集成的RenderDoc插件或直接在RenderDoc应用程序中对UE4项目执行单帧采集。

欲知RenderDoc功能和使用的详细信息,请参阅RenderDoc文档

RenderDoc插件

以下是使用UE4的RenderDoc插件采集帧的步骤:

  1. 为您的项目启用RenderDoc插件。

  2. 打开需要执行采集的项目和场景。

  3. 在关卡视口中点击 RenderDoc采集(RenderDoc Capture) 按钮。

    点击查看大图。

RenderDoc应用程序

以下介绍使用UE4和standalone RenderDoc可执行文件采集帧需要执行的高级步骤:

  1. 使用对应的命令行参数来配置RenderDoc启动游戏或UE4Editor.exe。

    启动UE4Editor.exe时启用 采集子进程(Capture Child Processes)

  2. 启动可执行文件。

  3. 按下 F12 热键执行帧采集。

欲知设置RenderDoc、启动应用程序和执行帧采集的详细信息,请参阅RenderDoc入门指南

项目设置

利用项目设置(Project Settings)窗口来设置RenderDoc插件的其他设置。在主菜单中,选择 编辑(Edit) > 项目设置(Project Settings),然后在 插件(Plugins) 类目下选择 RenderDoc

RenderDoc_ProjectSettings.png

属性

描述

帧采集设置(Frame Capture Settings)

采集所有活动(Capture all activity)

启用后,RenderDoc将采集整个帧过程中所有视口和编辑器窗口中的所有活动,而不仅是当前视口中的活动。

采集所有调用堆栈(Capture all call stacks)

启用后,RenderDoc将采集所有API调用的调用堆栈。

参考所有资源(Reference all resources)

启用后,RenderDoc将包括采集中的所有渲染资源,甚至包括帧过程期间未使用的资源。

启用此属性会极大增加采集内容的容量。

保存所有初始状态(Save all initial states)

启用后,RenderDoc将始终采集所有渲染资源的初始状态,即使这些渲染资源不大可能在帧过程中使用也同样如此。

启用此属性会极大增加采集内容的容量。

高级设置(Advanced Settings)

启动时显示帮助(Show help on startup)

启用后,RenderDoc的帮助窗口将在编辑器启动时显示。

使用RenderDoc崩溃处理器(Use the RenderDoc crash handler)

启用后,发生崩溃时将使用RenderDoc崩溃处理器。

建议在您了解RenderDoc应用程序存在问题并想要通知RenderDoc开发人员时才使用此设置。

RenderDoc可执行文件路径(RenderDoc executable path)

设置要使用的RenderDoc可执行文件的路径。

安装RenderDoc时,它应自动填写正确路径。

其他注释和资源

  • 欲知有关RenderDoc使用和帧采集分析的更多内容,请参阅RenderDoc文档

  • RenderDoc插件由Fredrik Lindh(“Temaran”)为UE4独家开发。欲知更多信息,请参阅RenderDoc的GitHub元库

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback