Intel® Graphics Performance Analyzers User Guide

Download PDF
ID 767266
Date 9/28/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
Intel® Graphics Performance Analyzers User Guide
Intel® Graphics Performance Analyzers User Guide x
Introduction to Intel® Graphics Performance Analyzers Game Optimization Methodology Install and Launch Intel® GPA Enable GPU Metrics Collection Launch Application for Analysis Configure Analysis Settings Analyze Desktop Graphics Applications Quick Start with Profiling Unreal Engine* Games Instrumentation and Tracing Technology API Support Intel® GPA Reference Notices and Disclaimers
Introduction to Intel® Graphics Performance Analyzers x
Get Help
Launch Application for Analysis x
Start a Desktop Application with Graphics Monitor Start a Windows* Mixed Reality Application Connect to a Running Application (Windows* only) Analyze Applications in the Network Mode
Configure Analysis Settings x
Configure a Metric Set Customize Keyboard Shortcuts Set Up a Trigger Set Up Tracing Options Set Up Stream Options Set Frame Delimiters
Analyze Desktop Graphics Applications x
Manage Analysis with Graphics Monitor Monitor Real-Time Performance with System Analyzer Identify Issues in Graphics Application Execution with Trace Analyzer Analyze GPU-bound Applications with Graphics Frame Analyzer Optimize Specific Domains
Monitor Real-Time Performance with System Analyzer x
Pause and Resume a Running Application Export Metrics Data with System Analyzer
Analyze GPU-bound Applications with Graphics Frame Analyzer x
Run Render State Experiments with Frame Analyzer Use Advanced Profiling Mode Graphics Frame Analyzer Plugins
Graphics Frame Analyzer Plugins x
Create a Custom Plugin for Graphics Frame Analyzer
Optimize Specific Domains x
Optimize Shaders Analyze Textures Minimize Overdraw Optimize Graphic API States Identify Graphics Elements with Complex Geometry Visualize Color Distribution
Instrumentation and Tracing Technology API Support x
Compile and Link with ITT API Instrument Your Application Minimize ITT API Overhead Clock Domain API Counter API Domain API Marker API Metadata API Relation API String Handle API Thread Naming API Task API
Intel® GPA Reference x
Performance Metrics Reference User Interface Reference
Performance Metrics Reference x
CPU Metrics Device I/O Metrics GPU Metrics Graphics API Metrics Memory Metrics
User Interface Reference x
Graphics Monitor UI Reference Heads-Up Display (HUD) UI Reference System Analyzer UI Reference Graphics Frame Analyzer UI Reference Graphics Trace Analyzer UI Reference
Graphics Monitor UI Reference x
Graphics Monitor Context Menu Graphics Monitor Configuration Window Graphics Monitor Control Panel Graphics Monitor Window: Desktop Applications Tab Graphics Monitor Window: Universal Windows Applications Tab (Windows* only) Graphics Monitor Window: Options Dialog Box
Graphics Frame Analyzer UI Reference x
Graphics Frame Analyzer Window: Open Frame Capture Graphics Frame Analyzer Window: Multiframe View Graphics Frame Analyzer Window: Profiling View Graphics Frame Analyzer Window: Dependency Viewer
Graphics Frame Analyzer Window: Profiling View x
Main Toolbar Visualization Pane API Log Pane Resources Pane Metrics Pane Experiments Pane
Graphics Trace Analyzer UI Reference x
Graphics Trace Analyzer Window: Open Trace Capture Graphics Trace Analyzer Window: Platform View
Intel® Graphics Performance Analyzers User Guide

Metadata API

Metadata is extra information, generic data which can be attached to a task, a thread, a process, etc. Metadata has a type, name, and value. The value encoding depends on a metadata type. It may contain either string data or a number of integer or floating point values.

To create metadata, use the following primitives:

void __itt_metadata_add(const __itt_domain *domain, __itt_id id, __itt_string_handle *key, __itt_metadata_type type, size_t count, void *data)

void __itt_metadata_str_addA(const __itt_domain *domain, __itt_id id, __itt_string_handle *key, const char *data, size_t length)

void __itt_metadata_str_addW(const __itt_domain *domain, __itt_id id, __itt_string_handle *key, const wchar_t *data, size_t length)

void __itt_metadata_add_with_scope(const __itt_domain *domain, __itt_scope scope, __itt_string_handle *key, __itt_metadata_type type, size_t count, void *data)

void __itt_metadata_str_add_with_scopeA(const __itt_domain *domain, __itt_scope scope, __itt_string_handle *key, const char *data, size_t length)

void __itt_metadata_str_add_with_scopeW(const __itt_domain *domain, __itt_scope scope, __itt_string_handle *key, const wchar_t *data, size_t length)

The following table defines the parameters used in the Metadata API primitives.

Type Parameter Description
[in] __itt_domain* domain Metadata domain
[in] __itt_scope scope Metadata scope: task, thread, process, and global. If a scope is undefined, metadata belongs to the last task in the thread.
[in] __itt_string_handle* name Metadata name
[in] __itt_metadata_type type Metadata type; used only for numeric metadata
[in] size_t count Number of numeric metadata items [in] size_t length
[in] size_t length

Number of symbols a metadata string

[in] void *data Actual metadata (array of numerics or string)
const char *data
const wchar_t *data
Parent topic: Instrumentation and Tracing Technology API Support
Level Two Title