Unreal Insights と一緒にシッピングされた多くの機能を活用するために、ユーザーはマクロとコマンド オプションでプロジェクト出力をカスタマイズすることができます。さらに、マウス入力とキーボード入力を使用するとユーザーは効率よく Insights ウィンドウを開くことができます。
トレース
Trace は、実行中のプロセスからインストルメンテーション イベントをトレースするための構造化されたログ フレームワークです。
このオプションの詳細については、「トレース」を参照してください。
マクロ
次の表を参照して、Unreal Insights Tool で表示するデータに基づいて調整するマクロを決定します。
| マクロ名 | デフォルト ステート | ソース ファイル | 領域の説明 |
|---|---|---|---|
UE_TRACE_ENABLED |
On | Engine/Source/Runtime/TraceLog/Public/Trace/Config.h |
システム全体のマスター コントロールです。 |
LOGTRACE_ENABLED |
On | Engine/Source/Runtime/Core/Public/Logging/LogTrace.h |
ログ メッセージを Unreal Insights にレポートするかどうかを制御します。 |
MISCTRACE_ENABLED |
On | Engine/Source/Runtime/Core/Public/ProfilingDebugging/MiscTrace.h |
ブックマーク、フレーム、スレッド、スレッド グループのトレースを制御します。 |
CPUPROFILERTRACE_ENABLED |
On | Engine/Source/Runtime/Core/Public/ProfilingDebugging/CpuProfilerTrace.h |
CPU タイマーおよびタイミング イベントのトレースを制御します。 |
LOADTIMEPROFILERTRACE_ENABLED |
On | Engine/Source/Runtime/CoreUObject/Public/Serialization/LoadTimeTrace.h |
アセットのロードに関連するイベントのトレースを制御します。 |
EXPERIMENTAL_STATSTRACE_ENABLED and STATSTRACE_ENABLED |
Off | Engine/Source/Runtime/Core/Public/Stats/StatsTrace.h |
Stats Counters のトレースを制御します。両方のマクロを「1」として定義してアクティブ化します。 |
PLATFORMFILETRACE_ENABLED |
Off |
Engine/Source/Runtime/Core/Public/ProfilingDebugging/PlatformFileTrace.h |
ファイルを開く、閉じる、読み取る、書き込むなどのファイル アクティビティのトレースを制御します。 |
GPUPROFILERTRACE_ENABLED |
On | Engine/Source/Runtime/RHI/Public/GpuProfilerTrace.h |
GPU のタイマーおよびタイミング イベントを制御します。 |
UE_NET_TRACE_ENABLED |
On | Engine\Source\Runtime\Net\Core\Public\Net\Core\Trace\NetTrace.h Engine\Source\Runtime\Net\Core\Public\Net\Core\Trace\Config.h |
GPU のタイマーおよびタイミング イベントを制御します。 |
コマンドライン オプション
マクロを組み合わせることで、次のコマンドライン オプションはトレース データを有効にします。
| コマンドライン オプション | 使用方法 | 説明 |
|---|---|---|
-statnamedevents |
CPUPROFILERTRACE_ENABLED |
-trace=cpu と組み合わせた場合、このオプションはさらに多くの CPU タイミング イベントを起動します。 . |
-trace |
-trace=channel1,channel2,... |
ユーザーは名前付きグループにイベントを分類することで生成するトレース データ量の管理ができるようになります。-trace=cpu,frame,bookmark を使うと CPU プロファイラ イベント、フレームマーカー、ブックマークが可能になります。 |
-tracehost |
tracehost=X |
-tracehost については、Unreal Insights の概要 を参照してください。 |
使用可能なトレース チャンネルには以下が含まれます。
- Log
- Bookmark
- Frame
- CPU
- GPU
- LoadTime
- File
- Net
除去されたコマンドライン オプション
以下のコマンドライン オプションは除去されました。
| コマンドライン オプション | 必要なマクロ | 効果 |
|---|---|---|
-cpuprofilertrace |
CPUPROFILERTRACE_ENABLED |
このオプションを指定して実行すると、タイミング イベントを含む複数の CPU スレッド トラックがタイミング ビューに表示されます。 |
-filetrace |
PLATFORMFILETRACE_ENABLED |
このオプションを使用して生成されたトレースの場合、2 つの I/O アクティビティ トラックを持ち、それらは Unreal Insights Tool の [imer] タブで「I」キーを押すか、[Tracks] ドロップダウンで [I/O Tracks] を有効にすることで表示できます。この機能は 4.23 では実験的機能です。 |
-loadtimetrace |
LOADTIMEPROFILERTRACE_ENABLED |
このオプションを選択すると、[Asset Loading Insights] ウィンドウに「Loading - Main Thread」トラックと「Loading - Main Thread」トラックが表示されます。 |
UnrealInsights.exe のコマンドライン オプション
| コマンドライン オプション | 使用方法 | 説明 |
|---|---|---|
-OpenTraceId |
-OpenTraceId=id |
Unreal Insights に [Viewer mode] で指定した ID の解析を開始させます。 |
-OpenTraceFile |
-OpenTraceFile=file.utrace |
Unreal Insights に [Viewer mode] で指定したファイルの解析を開始させます。 |
-Store |
-Store=address:port |
指定したトレース ストアとブラウザを接続します。-StoreHost=address と -StorePort=port も使用可能です。 |
実験的機能の Stats and Counters
Counters タブは 2 つの API ソースから表示することができます。
| API ソース | 例 | コマンドライン引数 | 注釈 |
|---|---|---|---|
| Stats | TRACE_STAT_* macros |
-trace=frame,stats,... -statstrace. |
Enable within Engine\Source\Runtime\Core\Public\Stats\StatsTrace.h の #define EXPERIMENTAL_STATSTRACE_ENABLED 1 で有効にします。 |
| Counters | TRACE_COUNTER_* macros |
-trace=frame,counters,... -counterstrace. |
Source\Runtime\Core\Public\ProfilingDebugging\CountersTrace.h を参照してください。 |
入力ショートカット
Timing Insights ウィンドウ
次のマウス コマンドとキーボード コマンドを使用すると、Timing Insights を効率的に開くことができます。
フレーム パネル
| 入力のショートカット | 機能 |
|---|---|
| マウスの左クリック | フレームを選択します。 |
| マウスの右クリック | コンテキスト メニューが開きます。 |
| 左/右マウスを押してドラッグ | 水平ズーム |
| マウスホイール | 水平ズーム |
| Shift + マウスホイール | 垂直ズーム |
タイミング パネル
| 入力のショートカット | 機能 |
|---|---|
| マウスの右/左を押してドラッグ | 水平または垂直パン |
| Ctrl + マウスの右/左を押してドラッグ | 水平パン |
| Shift + マウスの右/左を押してドラッグ | 垂直パン |
| マウス ホイール | ズーム |
| Ctrl + マウス ホイール | 水平スクロール |
| Shift + マウス ホイール | 垂直スクロール |
| マウスを右クリック | コンテキスト メニューが開きます。 |
| Timing Event 上でマウスを左クリック | タイミング イベントを選択します。 |
| 空いている領域でマウスを左クリック | 選択を解除します。 |
| Ctrl + マウスを左ダブルクリック | 選択したタイミング イベントの時間範囲を選択します。 |
| 左/右 マウスを押しながらタイム ルーラー上をドラッグ | 時間範囲 |
| F | 最後に選択したものをフレーミングして、時間範囲またはタイミング イベントのフレーミングを交互に行います。 |
| G | グラフ トラック、レンダリング フレームの可視性を切り替えます (Counter シリーズ用のプレースホルダーを含む)。. |
| Y | GPU タイミング トラックの可視性を切り替えます。 |
| U | CPU タイミング トラックの可視性を切り替えます。 |
| I | I/O Overview と Activity トラックの可視性を切り替えます。 |
| O | I/O Activity トラックのファイル アクティビティのバックグラウンド イベントの可視性を切り替えます。 |
| L | アセット ローディング トラックの可視性を切り替えます。 |
| C | 通常モードとコンパクト モードを切り替えて、タイミング イベントの可視性を調整します。 |
| V | 空のタイムラインを自動的に非表示にします。 |
| B | ブックマークの可視性を切り替えます。 |
| M | タイム マーカーの可視性を切り替えます (ブックマークのみではなくすべてのトレース ログ) |
| D | ダウンサンプリングを有効にします。 |
| -/+ | ズームします。 |
| Ctrl + 左/右/上/下向きの矢印 | 水平パンおよび垂直パンを行います。 |
| 左/右/上/下向きの矢印 | 前または次の兄弟/親/一番大きい子であるタイム イベントを選択します。 |
| Enter | 選択したタイミング イベントの時間範囲を選択します。 |
Networking Insights ウィンドウ
次のマウス コマンドとキーボード コマンドを使用すると、Networking Insights を効率的に開くことができます。
| 入力ショートカット | 機能 |
|---|---|
| Timing Event 上でマウスを左クリック | 各パケットを選択します。 |
| 異なるパケット上で Shift を押しながらマウスの左クリック | パケットを範囲で選択します。 |
| Ctrl + A | すべてのパケットを選択します。 |
| 左/右向き矢印 | 前/次のパケットを選択します。 |
| Shift を押しながら左/右向き矢印 | 選択を左/右方向に拡張します (複数のパッケージを選択)。 |
| Ctrl と Shift を押しながら左/右向き矢印 | 選択を左/右方向に縮小 (複数のパッケージを選択)。 |
| イベントをダブルクリック | その他すべてのイベントをマスクして、パケット コンテンツ ビューに含まれるすべてのパケットを強調表示します。 |