NVTX C API Reference v3
NVIDIA Tools Extension Library
Loading...
Searching...
No Matches
Data Fields
nvtxCounterAttr_t Struct Reference

Attributes of a counter or counter group. More...

#include <nvToolsExtCounters.h>

Data Fields

size_t structSize
 
uint64_t schemaId
 
const char * name
 
const char * description
 
uint64_t scopeId
 
const nvtxSemanticsHeader_tsemantics
 
uint64_t counterId
 

Detailed Description

Attributes of a counter or counter group.

Definition at line 95 of file nvToolsExtCounters.h.

Field Documentation

◆ counterId

uint64_t nvtxCounterAttr_t::counterId

A static counter ID must be unique within the domain, >= NVTX_COUNTER_ID_STATIC_START, and < NVTX_COUNTER_ID_DYNAMIC_START. Use NVTX_COUNTER_ID_NONE to let the tool create a (dynamic) counter ID.

Definition at line 136 of file nvToolsExtCounters.h.

◆ description

const char* nvtxCounterAttr_t::description

Optional detailed description of the counter (group). A description for individual counters can be set in the schema registration.

Definition at line 112 of file nvToolsExtCounters.h.

◆ name

const char* nvtxCounterAttr_t::name

Name of the counter (group).

Definition at line 106 of file nvToolsExtCounters.h.

◆ schemaId

uint64_t nvtxCounterAttr_t::schemaId

A schema ID referring to the data layout of the counter group or a predefined NVTX payloads number type.

Definition at line 103 of file nvToolsExtCounters.h.

◆ scopeId

uint64_t nvtxCounterAttr_t::scopeId

Identifier of the counters' scope. A valid scope ID is either a predefined scope or the value returned by nvtxScopeRegister called for the same NVTX domain as nvtxCounterRegister. An invalid scope ID will be handled like NVTX_SCOPE_NONE.

Definition at line 120 of file nvToolsExtCounters.h.

◆ semantics

const nvtxSemanticsHeader_t* nvtxCounterAttr_t::semantics

Optional semantics for a counter (group). The specified semantics apply to all counters in a group. If the semantics should only refer to a single counter in a group, the semantics field of the payload entry has to be used. Accepted semantics are nvtxSemanticsCounter_t and nvtxSemanticsTime_t.

Definition at line 129 of file nvToolsExtCounters.h.

◆ structSize

size_t nvtxCounterAttr_t::structSize

Definition at line 97 of file nvToolsExtCounters.h.


The documentation for this struct was generated from the following file: