Helper struct to submit a batch of events (marks or ranges). More...

#include <nvToolsExtPayload.h>

Data Fields
uint64_t	eventSchemaId

size_t	size

const void *	events

uint64_t	scope

uint64_t	flags

const void *	flexData

size_t	flexDataSize

size_t	flexDataOffset

Detailed Description

Helper struct to submit a batch of events (marks or ranges).

By default, events are assumed to be chronologically sorted by the first timestamp in the event (start time in a range). If the events are not sorted, the flags field must be set accordingly (see NVTX_BATCH_FLAG_*).

Definition at line 989 of file nvToolsExtPayload.h.

Field Documentation

◆ events

const void* nvtxEventBatch_t::events

Pointer to the array of deferred events.

Definition at line 1004 of file nvToolsExtPayload.h.

◆ eventSchemaId

uint64_t nvtxEventBatch_t::eventSchemaId

Identifier of the data layout of a deferred event in the array of events. Only layouts with static payload size are allowed. The size of an event in the array is specified by the static payload size during the schema registration. The time domain of event timestamps is provided via time semantics in the schema registration.

Definition at line 998 of file nvToolsExtPayload.h.

◆ flags

uint64_t nvtxEventBatch_t::flags

Timestamp ordering (sorted, partially sorted, unsorted), etc.

Definition at line 1010 of file nvToolsExtPayload.h.

◆ flexData

const void* nvtxEventBatch_t::flexData

Flexible data which can be referenced by events in the batch.

Definition at line 1013 of file nvToolsExtPayload.h.

◆ flexDataOffset

size_t nvtxEventBatch_t::flexDataOffset

Offset from the flexData pointer to the begin of the flexible data in bytes.

Definition at line 1022 of file nvToolsExtPayload.h.

◆ flexDataSize

size_t nvtxEventBatch_t::flexDataSize

Size of the flexible data memory blob.

Definition at line 1016 of file nvToolsExtPayload.h.

◆ scope

uint64_t nvtxEventBatch_t::scope

Scope of all events or counters in the batch.

Definition at line 1007 of file nvToolsExtPayload.h.

◆ size

size_t nvtxEventBatch_t::size

Size of the array of deferred events (in bytes).

Definition at line 1001 of file nvToolsExtPayload.h.

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

nvToolsExtPayload.h

Data Fields