Home ⌂Doc Index ◂Up ▴
Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
Markers

Enumerations

enum  __itt_scope {
  __itt_scope_unknown = 0, __itt_scope_global, __itt_scope_track_group, __itt_scope_track,
  __itt_scope_task, __itt_scope_marker
}
 Describes the scope of an event object in the trace. More...
 

Functions

void ITTAPI __itt_marker (const __itt_domain *domain, __itt_id id, __itt_string_handle *name, __itt_scope scope)
 Create a marker instance. More...
 
void ITTAPI __itt_marker_ex (const __itt_domain *domain, __itt_clock_domain *clock_domain, unsigned long long timestamp, __itt_id id, __itt_string_handle *name, __itt_scope scope)
 Create a marker instance. More...
 

Detailed Description

Markers represent a single discreet event in time. Markers have a scope, described by an enumerated type __itt_scope. Markers are created by the API call __itt_marker. A marker instance can be given an ID for use in adding metadata.

Enumeration Type Documentation

◆ __itt_scope

Describes the scope of an event object in the trace.

Enumerator
__itt_scope_unknown 
__itt_scope_global 
__itt_scope_track_group 
__itt_scope_track 
__itt_scope_task 
__itt_scope_marker 

Definition at line 2341 of file ittnotify.h.

Function Documentation

◆ __itt_marker()

void ITTAPI __itt_marker ( const __itt_domain *  domain,
__itt_id  id,
__itt_string_handle *  name,
__itt_scope  scope 
)

Create a marker instance.

Parameters
[in]domainThe domain for this marker
[in]idThe instance ID for this marker or __itt_null
[in]nameThe name for this marker
[in]scopeThe scope for this marker

◆ __itt_marker_ex()

void ITTAPI __itt_marker_ex ( const __itt_domain *  domain,
__itt_clock_domain *  clock_domain,
unsigned long long  timestamp,
__itt_id  id,
__itt_string_handle *  name,
__itt_scope  scope 
)

Create a marker instance.

Parameters
[in]domainThe domain for this marker
[in]clock_domainThe clock domain controlling the execution of this call.
[in]timestampThe user defined timestamp.
[in]idThe instance ID for this marker, or __itt_null
[in]nameThe name for this marker
[in]scopeThe scope for this marker

Copyright © 2005-2020 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.