Guides and Sample Code

Developer

Instruments User Guide

On This Page

OpenGL ES Analyzer Instrument

Overview

Instrument Description

The OpenGL ES Analyzer instrument captures information about OpenGL ES activity. It detects problems and offers solutions based on best practices and knowledge of Apple’s hardware and software platforms.

Supported Platforms

iOS

Related Profiling Templates

OpenGL ES Analysis Profiling Template

Timeline Pane

The timeline pane displays the following information, based on the instrument’s configuration:

Statistic name

Definition

# Batches

The number of batches performed.

# Disables

The number of disables performed.

# Enables

The number of enables performed.

# Flushes

The number of flushes performed.

# GL & Platform Calls

The number of graphics library and platform calls.

# GL Calls

The number of graphics library calls.

# Lines Rendered

The number of lines rendered on the device.

# Platform Calls

The number of platform calls performed.

# Points Rendered

The number of points rendered on the device.

# Redundant State Changes

The number of duplicate state changes.

# Render Passes

The number of passes by the renderer.

# Texture Loads

The number of textures loaded.

# Texture Uploads

The number of textures sent out.

# Triangles Rendered

The number of triangles rendered.

Uploaded Texture Bytes

The number of texture bytes sent out.

Record Settings

Click the Record Settings button (image: ../Art/instruments_recordsettings_button_inline_2x.png) in the inspector pane to customize the following recording options.

Frame Statistics to Observe

Select a statistic to see it graphed in the timeline pane. Click the shape or the color well to change how a statistic is represented.

Select statistics to list

Select the statistics to be displayed in the Frame Statistics to Observe area.

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.

Analyzer Processing

This area indicates whether analysis is occurring. While analyzing an app, click the Cancel Analysis button to stop recording for the OpenGL ES Analyzer instrument. After canceling, any other instruments in the trace document continue to capture data.

Frame Navigation

Use this area to quickly navigate to a specific frame while viewing frame statistics in the detail pane. Click the “Single frame navigation” checkbox and enter the number of the frame you wish to view.

Call Tree

The following call tree display settings filter the call tree in the detail pane.

Setting

State

Separate by Category

On by default.

Separate by Thread

On by default.

Invert Call Tree

On by default.

Hide Missing Symbols

On by default.

Hide System Libraries

On by default.

Show Obj-C Only

On by default.

Flatten Recursion

On by default.

Call Tree Constraints

The following options filter the call tree to display calls that fall within a specific threshold based on the settings below.

Setting

State

Count

Off by default.

Weight

Off by default.

Data Mining

Allows you to filter through the collected data for specific symbols and libraries.

Track Display Settings

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

Setting

Description

Options

Style

How information is presented.

  • Line Graph: All points of information are connected by a line.

  • Filled Line Graph: All points of information are connected by a line. The area under the line is filled by the statistic’s designated color.

  • Block Graph: Information is presented as a horizontal line until the information changes. The area under the line is filled by the statistic’s designated color.

  • Block Baseline Graph: Information is presented as a series of bars, which are filled by the statistic’s designated color.

Detail Pane Columns

Expert Detail Type

The following expert columns are available in the detail pane.

Column name

Definition

Severity

The severity of the event.

Total Occurrences

The total number of recorded events.

Unique Occurrences

The number of distinct recorded events.

Category

The type of event.

Summary

A quick description of the event.

Frame Statistics Detail Type

The following frame statistics columns are available in the detail pane.

Column name

Definition

Frame #

The number of the frame analyzed.

# Triangles Rendered

The number of triangles rendered for the frame.

# Batches

The number of batches that occurred for the frame.

# GL & Platform Calls

The number of GL and platform calls that occurred for the frame.

# Redundant State Changes

The number of redundant state changes that occurred for the frame.

Trace Detail Type

The following trace columns are available in the detail pane.

Column name

Definition

Index

The sequence number of the event.

Context

Hexadecimal representation of the OpenGL context used.

Thread

Hexadecimal representation of the thread that the context is running on.

Trace

The method call associated with the event.

Call Tree Detail Type

The following call tree columns are available in the detail pane.

Column name

Definition

Running Time

The total time the symbol was active.

Running Count

The number of times the symbol was called.

Category

An icon representing the category of the call.

Self %

The percentage of times the symbol called itself.

Total %

The percentage of total calls involving the symbol name.

Self Run %

The percentage of time the symbol was active after calling itself.

Running %

The percentage of time the symbol was active.

# Self

The number of times the symbol has been called.

# Samples

The number of samples collected for the symbol and its children, and the percentage of all symbols.

ms Self Run

The number of milliseconds the symbol was active after calling itself.

ms Running

The number of milliseconds the symbol was active.

Parent %

The percentage of bytes used by the call’s parent.

Library

The name of the library that generated the call.

Source Path

The path to the source file that generated the call.

Symbol Name

The name of the symbol being called.