Xcode フレームデバッガー Unity インテグレーション
GPUパフォーマンスを分析するために、サポートされているプラットフォームでXcodeフレームデバッガーを使用するUnityインテグレーションについて説明します。
読み終わるまでの所要時間 14 分最終更新 7日前
Xcode フレームデバッガーツールを使用すると、アプリケーションのフレームをキャプチャして、GPU がそのフレーム中に実行したコマンドを確認したり、GPU メモリ内のデータを調べたり、シェーダーのボトルネックを特定したりできます。これにより、GPU パフォーマンスを詳細に分析できます。
Unity は以下のように Xcode フレームデバッガーと統合されます。
- macOS、iOS、および tvOS では、Xcode フレームデバッガーを使用して、ターゲットデバイスで実行中のアプリケーションのフレームを分析できます。
- macOS では、Xcode フレームデバッガーを使用して、Unity エディターからフレームを分析できます。
重要:
- フレームデバッグは、Xcode がサポートするプラットフォームとグラフィックス API でアプリケーションを実行している場合にのみ機能します。
- Xcode は Metal グラフィックスの macOS のみをサポートします。
- Unity が別の API を使用する場合、サポートされているグラフィックス API を選択するまで Xcode インテグレーションは無効になります。
アプリケーションからのフレームのキャプチャ
Xcode フレームデバッガーを使用してフレームをキャプチャするには、以下のいずれかを行います。
- Xcode からアプリケーションを起動し、Xcode UI または FrameCapture API を使用してフレームキャプチャをリクエストします。Xcode でフレームキャプチャをすぐに分析したり、ディスクに保存したりできます。このワークフローは、Metal を使用するすべてのプラットフォームでサポートされます。
- Xcode プロジェクトを使用せずにアプリケーションをコマンドラインから直接起動し、FrameCapture API を使用してフレームキャプチャをディスクに保存できます。**注:**iOS はこのワークフローをサポートしません。
Xcode によるアプリケーションからのフレームのキャプチャ
このセクションでは、Xcode UI または FrameCapture API を使用してアプリケーションを起動し、フレームキャプチャを実行する方法について説明します。このワークフローは、Metal を使用するすべてのプラットフォームでサポートされます。
1. Xcode プロジェクトを作成します。
Unity エディターから Xcode プロジェクトを作成するか、その他の Xcode プロジェクトを使用して macOS アプリケーションを起動できます。
Unity エディターから Xcode プロジェクトをビルドする
- ビルドプロファイルウィンドウ (ファイル> ビルドプロファイル) を開きます。
- macOS のみ:Create Xcode Project を有効にします。
- ビルド をクリックします。
別の Xcode プロジェクトを使用して macOS アプリケーションを起動するには、以下を行います。
- Xcode で、新しい空の macOS プロジェクトを作成するか、既存の macOS プロジェクトを開きます。
- Product (製品)> Scheme (スキーム)> Edit scheme (スキームの編集) に移動し、Info (情報) タブを開きます。
- 実行ファイルをビルドした Unity アプリケーションに設定します。
2. フレームキャプチャを実行できるように Xcode プロジェクトスキームを編集します。
どちらか、Xcode GUI を使用します。これを行うには、Xcodeドキュメントのフレームキャプチャの有効化ガイドに従って、プロジェクトスキームのGPUフレームキャプチャ設定をMetalに設定します。
XcScheme API を使用して Xcode プロジェクトススキームを設定することもできます。これは、自動ビルドに役立ちます。詳細については、XcScheme API ドキュメント を参照してください。
3. Xcode からプロジェクトを起動し、フレームキャプチャを実行します。
Xcode で、フレームキャプチャボタン (カメラアアイコン) を押してデータの次のフレームをキャプチャします。
FrameCapture API を使用して、スクリプトからフレーム キャプチャを実行することもできます。Xcode でのフレームキャプチャデータの分析については、Xcode フレームデバッガードキュメント を参照してください。
コマンドラインでアプリケーションからフレームをキャプチャ
このセクションでは、コマンドラインからアプリケーションを起動し、FrameCapture API を使用してフレームキャプチャを実行し、結果をディスクに保存する方法について説明します。**重要:**このワークフローは iOS ではサポートされていません。iOS でフレームキャプチャを実行するには、常に Xcode からアプリケーションを起動する必要があります。
- 必要に応じてフレームキャプチャを実行できるように、コードに FrameCapture.BeginCaptureToFile と EndCapture の呼び出しを追加します。
- コマンドラインから以下のフラグでアプリケーションを起動します。Xcode は、コードの要求に応じてフレームキャプチャを実行し、その結果をディスクに保存します。
-enable-metal-capture.
Xcode でこのデータを分析する方法については、Apple の Xcode フレームデバッガードキュメント を参照してください。
Unity エディターからのフレームのキャプチャ
macOS では、Xcode フレームデバッガーを使用して、Unity エディターからフレームを分析できます。Xcode を使用して Unity エディターを起動する場合は、Unity エディター UI からフレームキャプチャをリクエストできます。
Xcode での Unity エディターからのフレームのキャプチャ
次のステップに従って、Xcode から Unity エディターを起動し、Unity エディター UI、Xcode UI、または FrameCapture API を使用してフレームキャプチャを実行します。フレームキャプチャを即座に分析したり、結果をディスクに保存したりできます。このワークフローは macOS でサポートされています。
**前提条件:**Unity エディターが開いている場合は、閉じます。
-
Xcode で、新しい空の macOS プロジェクトを作成するか、既存の macOS プロジェクトを開きます。
-
Product> Scheme> Edit scheme の順に選択し、Info タブを開きます。
-
実行ファイルを Unity エディターに設定します。
-
Xcode ドキュメントのフレームキャプチャの有効化ガイドに従って、プロジェクトスキームの GPU フレームキャプチャ設定を Metal に設定します。
-
**任意 - Unity Hubがインストールされている場合:**Xcode スキーム設定ウィンドウの「引数」タブに移動し、を使用して Unity プロジェクトへのパスを引数として渡します。これは、Xcode がエディターを起動したときに Unity Hub が開かず、代わりにプロジェクトでエディターを直接デバッグするためです。
-projectPath
The FrameDebug window displaying the project path
-
Xcode プロジェクトを実行して Unity エディターを起動します。
-
以下のいずれかの方法でフレーム キャプチャを実行します。
- Unity エディターシーンビューまたはゲームビューの右にある Xcode キャプチャボタンを使用して、フレームキャプチャを実行します。
- Xcode 15データの次のフレームをキャプチャするには、フレーム キャプチャ ボタン(カメラ アイコン)を選択します。
- ScriptAPI を使用します。詳細については、FrameCapture API のドキュメント を参照してください。Xcode でのフレームキャプチャデータの分析については、Apple の Xcode フレームデバッガードキュメント を参照してください。
FrameCapture
コマンドラインでの Unity エディターからのフレームのキャプチャ
このワークフローでは、コマンドラインから Unity エディターを起動し、FrameCapture API を使用してフレームキャプチャを実行し、フレームキャプチャをディスクに保存する方法について説明します。このワークフローは macOS でサポートされています。
- 必要に応じてフレームキャプチャを実行できるように、コードに FrameCapture.BeginCaptureToFile と EndCapture の呼び出しを追加します。
- 以下のフラグ を付けて、Unity エディターを起動します。Xcode は、コードの要求に応じてフレームキャプチャを実行し、その結果をディスクに保存します。
-enable-metal-capture
Xcode でこのデータを分析する方法については、 Xcode フレームデバッガー ドキュメントを参照してください。