Guides and Sample Code

Developer

Instruments User Guide

On This Page

Metal Application Instrument

Overview

Instrument Description

Records Metal application events.

Supported Platforms

iOS

Related Profiling Templates

Metal Application Instrument

Timeline Pane

The timeline pane displays a graph indicating Metal application events.

Record Settings

This instrument doesn’t have any record settings you can configure.

Display Settings

Click the Display Settings button (image: ../Art/instruments_displaysettings_button_inline_2x.png) in the inspector pane to customize the following display settings.

Track Display Settings

These settings control how information is displayed in the timeline pane.

Setting

Description

Options

Style

How information is presented. This is a fixed setting, which can’t be changed.

  • Nested Data

Detail Pane Columns

Metal Command Buffer Submissions Detail Type

The following Metal command buffer submissions columns are available in the detail pane.

Column name

Definition

Command Buffer

The command buffer being profiled.

Submission

The time at which the command buffer was submitted.

Process

The process that created the command buffer.

Thread

The thread in which the command buffer resides.

Frame

The frame in which the command buffer was consumed.

Metal Encoder List Detail Type

The following Metal encoder list columns are available in the detail pane.

Column name

Definition

Encoder

The command encoder being profiled.

Creation

The time at which the command encoder was created.

Submission

The time at which the command encoder was submitted.

Duration

The time elapsed between creation and submission.

Process

The process that created the command encoder.

Thread

The thread in which the command encoder resides.

Frame

The frame in which the command encoder was consumed.

Command Buffer

The command buffer into which commands are encoded.

Metal Command Buffer Scheduling Detail Type

The following Metal command buffer scheduling columns are available in the detail pane.

Column name

Definition

Command Buffer

Timestamp

Submission ID

Event

Frame

Process

Thread

CmdBuffer ID

Narrative Heuristics Detail Type

The following narrative heuristics columns are available in the detail pane.

Column name

Definition

Timestamp

The time an interesting event occurred.

Narrative

Information about an interesting event that occurred.

Metal Command Buffer User Callback Detail Type

The following Metal command buffer user callback columns are available in the detail pane.

Column name

Definition

Command Buffer

The command buffer being profiled.

Start Time

End Time

Duration

The time elapsed between start time and end time.

Submission

Callback Type

Frame

Process

Thread

The thread in which the command buffer resides.

CmdBuffer ID

Metal Encoder Hierarchy Detail Type

The following Metal encoder hierarchy columns are available in the detail pane.

Column name

Definition

Process/Frame/Command Buffer/Encoder

The process attached to the Metal System Trace and its specific frame, command buffer, and command encoder being profiled.

Creation

Submission