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 shadersA program that runs on the GPU. More info
See in Glossary. 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.
On macOS, you can use Xcode frame debugger to analyze frames from the Unity Editor. If you use Xcode to launch the Unity Editor, you can request frame captures from the Unity Editor 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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.