Unreal Insights を設定する
Unreal Insights をビルドするとき、複数の方法を利用することができます。
方法 1:エクスプローラーから Unreal Insights を起動する
「Engine\Binaries\Win64\UnrealInsights.exe」へ移動して、エンジンに Unreal Insights のビルド済みコピーが既にあるかどうかを確認します。
方法 2:Visual Studio からビルドする
Solution Explorer の Program のディレクトリから Unreal Insights をビルドすることができます。
方法 3:コマンド プロンプトからビルドする
[Start (スタート)] > [Command Prompt (コマンドプロンプト)] へ移動して、コマンド ディレクトリから Unreal Insights をビルドします。
cd C:\MyEngineInstallLocation\
Engine\Build\BatchFiles\RunUBT.bat UnrealInsights Win64 Development
方法 4:エディタからビルドする
[Tools] >[Unreal Insights] > [Run Unreal Insights] へ移動して Unreal Editor から Unreal Insights を開始します。Insights は自動的にコンパイルを試みます。
トレースを実行してプロジェクト データのプロファイルを作成する場合、Unreal Engine のビルドとオペレーティング システムに応じて複数のワークフロー オプションを利用できます。
デフォルトのトレース ワークフロー (Win64、バイナリ ランチャー)
1. Unreal Insights を実行します。
「Engine\Binaries\Win64」フォルダに移動して「UnrealInsights.exe」をダブルクリックします。
2. Insights セッション ブラウザ：
[Unreal Insights Session Browser (Unreal Insights セッション ブラウザ)] を起動すると、現時点では、使用可能なライブ セッションがないことがわかります。
3. ゲーム プロジェクトを実行する：
オペレーティング システムで コマンド プロンプト を起動して、Lyra ゲーム サンプルを実行します。
cd C:\MyEngineInstallLocation\
Samples\Games\Lyra\Binaries\Win64\LyraGame.exe
Epic Games Launcher から Lyra のサンプルをダウンロードした場合は、デフォルトのパス UnrealProjects\Lyra\Lyra.uproject から Lyra を実行することができます。
4. ライブの Insights セッション ブラウザ：
Unreal Insights セッション ブラウザに戻ると、新しいセッションが [LIVE (ライブ)] ステータスで表示され、現在レコーディングされていることがわかります。
5. トレース ステータスを確認する：
Lyra でティルダ (`) を 2 回押して、次のコマンドを入力します。
Trace.Status
Gpu、Bookmark、Frame、Cpu、Log の各チャンネルはデフォルトで有効になっています。
プロジェクトを開始する前に Unreal Insights がすでに起動している場合、Unreal Insights は自動的にローカルのトレース サーバーに接続し、デフォルトのトレース チャンネルが有効になります。
6. トレース セッションを開く：
Unreal Insights セッション ブラウザに戻り、.utrace ファイルをダブルクリックして、新しい Unreal Timing Insights ウィンドウで解析するためこのファイルを開きます。
トレース ファイルを開くには、.utrace ファイルをエクスプローラーから Unreal Insights セッション ブラウザにドラッグアンドドロップします。また、[Open Trace (トレースを開く)] の隣にある 矢印 ボタンをクリックし、ドロップダウン メニューから [Open File (ファイルを開く)] を選択すると、特定のフォルダにある .utrace ファイルを開くことができます。
トレースを開くと、Unreal Insights の新しいインスタンスが起動します。Timing Insights はデフォルトで開かれるコンポーネントで、トレース セッションを操作して、プロジェクトがさまざまなタスクに費やした時間を確認することができます。
解析のためのデータ表示方法の詳細については、 Timing Insights に関するドキュメントを参照してください。
トレースの高度なコントロール
Unreal Insights では、データをプロファイルする方法を制御するための複数の Trace コマンドを提供しています。
-
Trace.SnapshotFile <filename>:現在メモリにあるトレース バッファのスナップショットをファイルに書き出します。すでにトレースを実行されている場合、アクティブなトレースは中断されず、このスナップショットのみが第 2 のトレースファイルに並行して記録されます。 -
Trace.Bookmark <name>:これにより、指定した文字列名の Bookmark イベントが発生します。ブックマークは、Timing Insights に垂直ラインとしてブックマークが記録された時刻に表示されます。以前は、API のTRACE_BOOKMARK()でのみこの機能を利用できました。 -
Trace.Screenshot <Name> <bIncludeUI>:上に述べたとおり、このコンソール コマンドを実行して垂直ラインを生成できます。オプションとして、Timing Insights でスクリーンショットに対して true/false を指定することにより UI を含めることができます。
Unreal Insights では、データをプロファイルする方法を制御するための複数の Trace コマンドを提供しています。CPU や GPU プロファイリング データなどの特定のトレース チャンネルを表示したり、チャンネルのトレースを無効にしたりすることができます。Trace コマンドの詳細については、「トレース」と リファレンス を参照してください。
遅延接続
プロジェクトを起動する前に UnrealInsights.exe を実行し忘れたり、最初からトレースせずに記録したい状況を発見したりする場合があります。次の手順を実行すると、Unreal Insights に 遅延接続 することができます。
操作を進める前に、Unreal Insights セッション ブラウザ を確認して、ライブ セッションがすでに実行されていないことを確認します。次のコンソールコマンドを入力すると切断できます Trace.Stop
-
通常通りにプロジェクトを ビルド、クック、実行 します。
-
Unreal Insights を開きます。
-
[Connection (接続)] をクリックして、[Connection] タブを開きます。希望する接続設定を確認して、[Connect (接続)] をクリックします。
正常に接続されたら、[Trace Store (トレース ストア)] タブをクリックします。新しいライブ セッションがセッション リストに表示されます。