Unreal Engine で RenderDoc を使用する

RenderDoc はオープンソースのスタンドアローン型グラフィックス デバッガーです。GPU 上で実行される単一のフレームを簡単にキャプチャし、調べることができます。

RenderDoc はオープンソースのスタンドアローン型グラフィックス デバッガーです。Unreal Engine などのアプリケーションの単一のフレームを簡単にキャプチャし、調べることができます。キャプチャしたデータは RenderDoc に取り込まれ、イベント、API などを用いて GPU で起こっていることを詳細に調査します。

RenderDoc をインストールする

RenderDoc は無料オープンソースのスタンドアローン型グラフィックス デバッガーです。RenderDoc.org からダウンロードしインストールすることができます。

以下は RenderDoc が現在サポートしているオペレーション システムと PAI のリストなので、Unreal Engine のサポート対象と異なる場合があります。最新の情報は RenderDoc's FAQ を参照してください。

RenderDoc は次のオペレーティング システムをサポートしています。

  • Windows 7、10、11

  • Linux

  • Android

  • Nintendo Switch

RenderDoc は次の API をサポートしています。

  • Vulkan

  • D3D11

  • D3D12

  • OpenGL 3.2+

  • OpenGL ES 2.0 — 3.2

プロジェクトで RenderDoc を有効にする

RenderDoc プラグインはエンジンに含まれており、デフォルトで有効になっています。プロジェクトで RenderDoc を有効にするには、コマンドライン引数かプロジェクト設定を使用する 2 通りの方法があります。

起動時に RenderDoc がアタッチされると、レベル ビューポートの右上角に RenderDoc アイコンが表示されます。

RenderDoc Level Viewport Icon

以下はそれぞれの方法で有効にする手順です。

プラグイン プロジェクト設定を使用する

[Advanced Settings (詳細設定)][Plugins] > [RenderDoc] の [Project Settings (プロジェクト設定)] で Auto attach on startup を有効にします。プロジェクトがロードされる都度、起動時に RenderDoc を実行する場合に最適な方法です。

RenderDoc Plugin Settings

コマンドラインを使用する

エディタ ショートカットを使ってコマンドライン引数を有効にします。Shortcut タブで -AttachRenderDocTarget に追加します。RenderDoc を一定時間だけ実行したい場合に最適な方法です。

RenderDoc Project Shortcut Example

フレーム キャプチャを実行する

以下の手順は、ご使用の Unreal Engine プロジェクトで統合された RenderDoc プラグインを使って、または直接 RenderDoc アプリケーションで単一フレームのキャプチャを実行する方法の概要です。

機能の詳細および RenderDoc の使用方法は、RenderDoc Documentation を参照してください。

RenderDoc プラグイン

Unreal Engine の RenderDoc プラグインを使ってフレームをキャプチャするには、以下の手順に従います。

  1. プロジェクト用に適切な RenderDoc プラグインを有効にします。

  2. キャプチャを実行するプロジェクトとシーンを開きます。

  3. レベル ビューポートで [RenderDoc Capture] ボタンをクリックします。

    クリックしてフルサイズ表示

RenderDoc アプリケーション

スタンドアローン型 RenderDoc 実行ファイルで Unreal Engine を使ってフレームをキャプチャするための手順の概要です。

  1. ゲームを起動するように RenderDoc を設定します (例えば、正しいコマンドライン引数を使った UEEditor.exe などで)。

    [Capture Child Processes (子プロセスをキャプチャする)] when launching with the UEEditor.exe で起動する時に Capture Child Processes を有効にします。

  2. 実行ファイルを起動します。

  3. F12 ホットキーを押して、フレーム キャプチャを実行します。

RenderDoc の設定、アプリケーションの起動、フレーム キャプチャの実行の詳細については、RenderDoc Getting Started Guide を参照してください。

プロジェクト設定

[Project Settings (プロジェクト設定)] ウィンドウから追加の RenderDoc プラグイン設定を行います。メイン メニューから [Edit (編集)] > [Project Settings (プロジェクト設定)] を選択し、Plugins カテゴリで RenderDoc を選択します。

RenderDoc_ProjectSettings.png

プロパティ

説明

フレーム キャプチャ設定

Capture all activity

有効にすると、RenderDoc は現在のビューポートのみではなく、フレーム全体に対してすべてのビューポートとエディタ ウィンドウにあるすべてのアクティビティをキャプチャします。.

Capture all call stacks

有効にすると、RenderDoc はすべての API コールに対するコール スタックをキャプチャします。

Reference all resources

有効にすると、RenderDoc はレンダリングされたすべてのリソースをキャプチャ内に含みます (フレーム中に使用されなかった場合でも)。

このプロパティを有効いすると、キャプチャ サイズが大幅に増加します。

Save all initial states

有効にすると、RenderDoc はレンダリングされたすべてのリソースの初期ステートを常にキャプチャします (フレーム中に使用されてないであろう場合も)。

このプロパティを有効にすると、キャプチャ サイズが大幅に増加します。

詳細設定

Show help on startup

有効にすると、RenderDoc をによるヘルプ ウィンドウがエディタの起動時に表示されます。

Use the RenderDoc crash handler

有効にすると、クラッシュが発生した場合に RenderDoc クラッシュ ハンドラが使用されます。

問題の原因が RenderDoc アプリケーションであることが分かり、RenderDoc デベロッパーに通知したい場合に使用します。

RenderDoc executable path

RenderDoc 実行ファイルを使用するようにパスを設定します。

RenderDoc のインストール時にパスが正しければ、自動的に入力されます。

追記およびリソース

  • RenderDoc の使用方法およびフレーム キャプチャの分析については『RenderDoc Documentation』を参照してください。

  • RenderDoc プラグインは Unreal Engine 向けに Fredrik Lindh ("Temaran") が設計開発を行いました。詳細は、『RenderDoc GitHub respository』を参照してください。

Unreal Engine のドキュメントを改善するために協力をお願いします!どのような改善を望んでいるかご意見をお聞かせください。
調査に参加する
キャンセル