The Xcodeframe 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 integrates with the Xcode frame debugger in the following ways:
Important:
To use the Xcode frame debugger to capture a frame from do one of the following:
This section describes how to launch your application and perform a frame capture using the Xcode UI or the FrameCapture API. This workflow is supported on all platforms that use Metal.
1. Create an Xcode project.
You can either create an Xcode project from the Unity Editor, or use any other Xcode project to launch macOS applications.
To build an Xcode project from the Unity Editor:
To use another Xcode project to launch macOS applications:
2. Edit the Xcode project scheme so that you can perform frame captures.
Either, use the Xcode GUI. To do this, follow the Enabling Frame Capture guide in the Xcode documentation to set your project scheme’s GPU Frame Capture setting to Metal.
You can also use the XcScheme API to configure an Xcode project scheme, which is useful for automated builds. For more information, see the XcScheme API documentation.
3. Launch your project from Xcode, and perform a frame capture.
In Xcode, press the Frame Capture button (camera icon) to capture the next frame of data.
You can also use the FrameCapture API to perform a frame capture from a script. For information on analyzing frame capture data in Xcode, see the Xcode frame debugger documentation.
This section describes how to launch your application from the command line, perform a frame capture using the FrameCapture API, and save the results to disk. Important: This workflow isn’t supported on iOS. To perform frame captures on iOS, you must always launch your application from Xcode.
-enable-metal-capture.
Xcode performs frame captures when your code requests them, and saves the results to disk.For information on how to analyze this data in Xcode, see Apple’s Xcode frame debugger documentation.
在 macOS 上,您可以使用 Xcode 帧调试器从 Unity 编辑器分析帧。如果使用 Xcode 启动 Unity 编辑器,则可以从 Unity 编辑器 UI 请求进行帧捕获。
Follow these steps 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.
Preqrequisite: If the Unity Editor is open, close it.
-projectPath
. This is to prevent the Unity Hub from opening when Xcode launches the Editor and instead directly debug the Editor with your project.
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.This workflow describes how to launch the Unity Editor from the command line, use the FrameCapture API to perform a frame capture, and save the frame capture to disk. This workflow is supported on macOS.
-enable-metal-capture
. Xcode performs frame captures when your code requests them, and saves the results to disk.For information on how to analyze this data in Xcode, see the Xcode frame debugger documentation.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.