Sample Code

Capturing Metal Commands Programmatically

Invoke Metal’s frame capture from your app, then save the resulting GPU trace to a file or view it in Xcode.

Download

Overview

Configure the Sample Code Project

To run the app:

  • Build the project with Xcode 11 or later.

See Also

Capturing a Frame Programmatically

Capturing GPU Command Data Programmatically

Invoke Metal’s frame capture from your app under the specific runtime conditions you choose.

Creating a Custom Capture Scope

Use custom capture scopes to control which commands get captured.

class MTLCaptureManager

An object you use to capture Metal command data in your app.

protocol MTLCaptureScope

An object that defines custom boundaries for a GPU frame capture.

class MTLCaptureDescriptor

A configuration for a Metal capture session.

Beta
enum MTLCaptureDestination

The kinds of destinations for captured command data.

Beta
let MTLCaptureErrorDomain: String

The error domain for capture errors.

Beta
enum MTLCaptureError

Errors returned by capture sessions.

Beta

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software