Xcode フレームデバッガーのインテグレーション
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 プロジェクトをビルドする場合、以下を行います。
- Build Settings ウィンドウを開きます (File > Build Settings)。
- macOS のみ: Create Xcode Project を有効にします。
- Build をクリック。
別の Xcode プロジェクトを使用して macOS アプリケーションを起動するには、以下を行います。
- Xcode で、新しい空の macOS プロジェクトを作成するか、既存の macOS プロジェクトを開きます。
- Product > Scheme > Edit scheme と移動し、Info タブを開きます。
- Executable をビルドした Unity アプリケーションに設定します。
2. Xcode プロジェクトのスキームを編集して、フレームキャプチャを実行できるようにします。
Xcode GUI を使用します。これを行うには、Xcode ドキュメントの Enabling Frame Capture ガイド に従い、プロジェクトスキームの GPU Frame Capture 設定を Metal に設定します。
- また、XcScheme API を使用して、Xcode プロジェクトのスキームを設定できます。これは、自動化されたビルドに役立ちます。詳細は、XcScheme API ドキュメント を参照してください。
3. Xcode からプロジェクトを起動し、フレームキャプチャを実行します。
- Xcode で、Frame Capture ボタン (カメラアイコン) を押すと、次のフレームのデータがキャプチャされます。
また、FrameCapture API を使用して、スクリプトからフレームキャプチャを実行することができます。Xcode でのフレームキャプチャデータの分析については、Xcode フレームデバッガーのドキュメント を参照してください。
コマンドラインでアプリケーションからフレームをキャプチャする
このセクションでは、コマンドラインからアプリケーションを起動し、FrameCapture API を使用してフレームキャプチャを実行し、その結果をディスクに保存する方法を説明します。 重要： このワークフローは、iOS ではサポートされていません。iOS 上でフレームキャプチャを実行するには、常に Xcode からアプリケーションを起動する必要があります。
- FrameCapture.BeginCaptureToFile と EndCapture の呼び出しをコードに加えます。これにより、必要に応じてフレームキャプチャを実行できます。
- アプリケーションをコマンドラインから起動し、フラグ
-enable-metal-captureを設定します。Xcode は、コードが要求するとフレームキャプチャを実行し、その結果をディスクに保存します。
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 タブを開きます。
- Executable をUnity エディターに設定します。
- Xcode ドキュメントの Enabling Frame Capture ガイドに従って、プロジェクトスキームの GPU Frame Capture 設定を Metal に設定します。
-
任意 - Unity Hub をインストールしている場合: Xcode Scheme 設定ウィンドウの Arguments タブに移動し、
-projectPathを使用して Unity プロジェクトへのパスを引数として渡します。これは、Xcode がエディターを起動するときに Unity Hub が開くのを防ぎ、代わりにプロジェクトでエディターを直接デバッグします。
- Xcode プロジェクトを実行して、Unity エディターを起動します。
- 以下のいずれかの方法でフレームキャプチャを行います。
- Unity エディター: シーンビューやゲームビューの右にある Xcode Capture ボタンを使って、フレームキャプチャを行います。
- Xcode: Frame Capture ボタン (カメラアイコン) を押すと、次のフレームのデータがキャプチャされます。
-
スクリプト:
FrameCaptureAPI を使用します。詳細については、FrameCapture API ドキュメントを参照してください。 Xcode でのフレームキャプチャデータの分析については、Apple の Xcode フレームデバッガーに関するドキュメント を参照してください。
Unity エディターからコマンドラインでフレームをキャプチャする
このワークフローは、コマンドラインから Unity エディター を起動し、FrameCapture API を使用してフレームキャプチャを実行し、フレームキャプチャをディスクに保存する方法について説明します。このワークフローは、macOS でサポートされています。
- FrameCapture.BeginCaptureToFile と EndCapture の呼び出しをコードに加えます。これにより、必要に応じてフレームキャプチャを実行できます。
-
Unity エディターをコマンドラインから起動 し、フラグ
-enable-metal-captureを設定します。Xcode は、コードが要求するとフレームキャプチャを実行し、その結果をディスクに保存します。
Xcode でこのデータを解析する方法については、Xcode fフレームデバッガーに関するドキュメント を参照してください。