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

Helper struct to submit a batch of counters. More...

#include <nvToolsExtCounters.h>

Data Fields

uint64_t counterId
 
const void * counters
 
size_t countersSize
 
uint64_t flags
 
const int64_t * timestamps
 
size_t timestampsSize
 

Detailed Description

Helper struct to submit a batch of counters.

The size of one sample is specified via the payloadStaticSize field of the counter's data layout schema or the size of the predefined payload entry type and must include padding. There should be no remainder when dividing countersSize by nvtxPayloadSchemaAttr_t::payloadStaticSize.

Definition at line 147 of file nvToolsExtCounters.h.

Field Documentation

◆ counterId

uint64_t nvtxCounterBatch_t::counterId

Identifier of a counter group (data layout, scope, etc.). All counter samples in the batch have the same layout and size.

Definition at line 153 of file nvToolsExtCounters.h.

◆ counters

const void* nvtxCounterBatch_t::counters

Batch of counter (group) samples.

Definition at line 156 of file nvToolsExtCounters.h.

◆ countersSize

size_t nvtxCounterBatch_t::countersSize

Size of the counter batch (in bytes).

Definition at line 159 of file nvToolsExtCounters.h.

◆ flags

uint64_t nvtxCounterBatch_t::flags

Timestamp ordering, timestamp style, etc. See NVTX_BATCH_FLAG_* and NVTX_COUNTER_BATCH_FLAG_*.

Definition at line 165 of file nvToolsExtCounters.h.

◆ timestamps

const int64_t* nvtxCounterBatch_t::timestamps

Array of timestamps or a timestamp/interval pair. This field can be NULL, if timestamps are included in the counter samples as part of the counter group layout. By default, one timestamp per sample is assumed. The timestamp source is specified via time semantics passed during the counter group registration. This overrides the timestamps embedded in counter samples.

Definition at line 175 of file nvToolsExtCounters.h.

◆ timestampsSize

size_t nvtxCounterBatch_t::timestampsSize

Size of the timestamps array or timestamp/interval pair (in bytes).

Definition at line 178 of file nvToolsExtCounters.h.


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