Version: 2021.3
言語: 日本語

Xcode フレームデバッガーのインテグレーション

The Xcode frame debugger tool lets you capture a frame of your application to see the commands that the GPU performed during that frame, examine data in GPU memory, and identify bottlenecks in your shaders. This lets you analyze GPU performance in fine detail.

Unity は、Xcode のフレームデバッガーと以下のように統合されています。

  • macOS、iOS、tvOS では、Xcode のフレームデバッガーを使って、ターゲットデバイス上でアプリケーションを実行中に、アプリケーションからフレームを解析することができます。
  • macOS では、Xcode のフレームデバッガーを使って、Unity エディターからフレームを解析することができます。

Frame debugging only works if the application is running on a platform and graphics API that Xcode supports. Xcode only supports macOS with Metal graphics. If Unity uses another API, the Xcode integration is disabled until you select a supported graphics API.


Xcode のフレームデバッガーを使ってフレームをキャプチャするには、以下のいずれかを行います。

  • Xcode からアプリケーションを起動し、Xcode UI または FrameCapture API を使用してフレームキャプチャを要求します。フレームキャプチャは Xcode ですぐに解析することも、ディスクに保存することも可能です。このワークフローは、Metal を使用するすべてのプラットフォームでサポートされます。
  • Launch your application directly from the command line without an Xcode project, and use the FrameCapture API to save frame captures to disk. Note: This workflow isn’t supported on iOS.

Xcode でアプリケーションのフレームをキャプチャ

このセクションでは、Xcode UI または FrameCapture API を使用してアプリケーションを起動し、フレームキャプチャを実行する方法について説明します。このワークフローは、Metal を使用するすべてのプラットフォームに適用できます。

1. Xcode のプロジェクトを作成します。

Unity エディターから Xcode プロジェクトを作成するか、他の Xcode プロジェクトを使用して macOS アプリケーションを起動することができます。

Unity エディターから Xcode プロジェクトをビルドする場合、以下を行います。

  1. Build Settings ウィンドウを開きます (File > Build Settings)。
  2. macOS のみ: Create Xcode Project を有効にします。
  3. Build をクリック。

別の Xcode プロジェクトを使用して macOS アプリケーションを起動するには、以下を行います。

  1. Xcode で、新しい空の macOS プロジェクトを作成するか、既存の macOS プロジェクトを開きます。
  2. Product > Scheme > Edit scheme と移動し、Info タブを開きます。
  3. Executable をビルドした Unity アプリケーションに設定します。

2. Xcode プロジェクトのスキームを編集して、フレームキャプチャを実行できるようにします。

Xcode GUI を使用します。これを行うには、Xcode ドキュメントの Enabling Frame Capture ガイド に従い、プロジェクトスキームの GPU Frame Capture 設定を Metal に設定します。

  1. また、XcScheme API を使用して、Xcode プロジェクトのスキームを設定できます。これは、自動化されたビルドに役立ちます。詳細は、XcScheme API ドキュメント を参照してください。

3. Xcode からプロジェクトを起動し、フレームキャプチャを実行します。

  1. Xcode で、Frame Capture ボタン (カメラアイコン) を押すと、次のフレームのデータがキャプチャされます。

また、FrameCapture API を使用して、スクリプトからフレームキャプチャを実行することができます。Xcode でのフレームキャプチャデータの分析については、Xcode フレームデバッガーのドキュメント を参照してください。


このセクションでは、コマンドラインからアプリケーションを起動し、FrameCapture API を使用してフレームキャプチャを実行し、その結果をディスクに保存する方法を説明します。 重要: このワークフローは、iOS ではサポートされていません。iOS 上でフレームキャプチャを実行するには、常に Xcode からアプリケーションを起動する必要があります。

  1. FrameCapture.BeginCaptureToFileEndCapture の呼び出しをコードに加えます。これにより、必要に応じてフレームキャプチャを実行できます。
  2. アプリケーションをコマンドラインから起動し、フラグ -enable-metal-capture を設定します。Xcode は、コードが要求するとフレームキャプチャを実行し、その結果をディスクに保存します。

Xcode でこのデータを分析する方法については、Apple の Xcode フレームデバッガーに関するドキュメント を参照してください。

Unity エディターからのフレームのキャプチャ

macOS では、Xcode のフレームデバッガーを使って、Unity エディターからフレームを解析することができます。Xcodeを使用してUnity エディターを起動した場合、Unity エディターの UI からフレームキャプチャを要求することができます。

Xcode で Unity エディターからフレームをキャプチャ

This section describes how to launch the Unity Editor from Xcode and perform a frame capture using the Unity Editor UI, the Xcode UI, or the FrameCapture API. You can analyze the frame capture immediately, or save the results to disk. This workflow is supported on macOS.

  1. If the Unity Editor is open, close it.
  2. In Xcode, create a new, empty macOS project, or open an existing macOS project.
  3. Go to Product > Scheme > Edit scheme, and open the Info tab.
  4. Set Executable to the Unity Editor.
  5. Follow the Enabling Frame Capture guide in the Xcode documentation to set your project scheme’s GPU Frame Capture setting to Metal.
  6. Xcode プロジェクトを実行して、Unity エディターを起動します。
  7. Perform a frame capture, either via the Unity Editor UI, the Xcode UI, or via a script:
    • Unity エディター: シーンビューやゲームビューの右にある Xcode Capture ボタンを使って、フレームキャプチャを行います。
    • Xcode: Frame Capture ボタン (カメラアイコン) を押すと、次のフレームのデータがキャプチャされます。
    • Script: Use the FrameCapture API. For more information, see the FrameCapture API documentation.

For information on analyzing frame capture data in Xcode, see Apple’s Xcode frame debugger documentation.

Unity エディターからコマンドラインでフレームをキャプチャ

このワークフローは、コマンドラインから Unity エディター を起動し、FrameCapture API を使用してフレームキャプチャを実行し、フレームキャプチャをディスクに保存する方法について説明します。このワークフローは、macOS でサポートされています。

  1. FrameCapture.BeginCaptureToFileEndCapture の呼び出しをコードに加えます。これにより、必要に応じてフレームキャプチャを実行できます。
  2. Unity エディターをコマンドラインから起動 し、フラグ -enable-metal-capture を設定します。Xcode は、コードが要求するとフレームキャプチャを実行し、その結果をディスクに保存します。

Xcode でこのデータを解析する方法については、Xcode fフレームデバッガーに関するドキュメント を参照してください。