NVTX payload enumeration type attributes. More...

#include <nvToolsExtPayload.h>

Data Fields
uint64_t	fieldMask

const char *	name

const nvtxPayloadEnum_t *	entries

size_t	numEntries

size_t	sizeOfEnum
	Size of the enumeration type in bytes. (Mandatory)

uint64_t	schemaId
	Unique identifier for this enum type.

void *	extension

Detailed Description

NVTX payload enumeration type attributes.

A pointer to this struct is passed to nvtxPayloadEnumRegister.

Definition at line 1090 of file nvToolsExtPayload.h.

Field Documentation

◆ entries

const nvtxPayloadEnum_t* nvtxPayloadEnumAttr_t::entries

Entries of the enum. (Mandatory)

Definition at line 1105 of file nvToolsExtPayload.h.

◆ extension

void* nvtxPayloadEnumAttr_t::extension

Reserved for future use.

Definition at line 1129 of file nvToolsExtPayload.h.

◆ fieldMask

uint64_t nvtxPayloadEnumAttr_t::fieldMask

Mask of valid fields in this struct. See NVTX_PAYLOAD_ENUM_ATTR_FIELD_*.

Definition at line 1095 of file nvToolsExtPayload.h.

◆ name

const char* nvtxPayloadEnumAttr_t::name

Name of the enum. (Optional)

Definition at line 1100 of file nvToolsExtPayload.h.

◆ numEntries

size_t nvtxPayloadEnumAttr_t::numEntries

Number of entries in the enum. (Mandatory)

Definition at line 1110 of file nvToolsExtPayload.h.

◆ schemaId

uint64_t nvtxPayloadEnumAttr_t::schemaId

Unique identifier for this enum type.

Same constraints as nvtxPayloadSchemaAttr_t::schemaId.

Definition at line 1126 of file nvToolsExtPayload.h.

◆ sizeOfEnum

size_t nvtxPayloadEnumAttr_t::sizeOfEnum

Size of the enumeration type in bytes. (Mandatory)

Must be set to a non-zero value (typically sizeof(YourEnumType)) for a tool to be able to read enum-typed fields. If zero, the tool cannot determine how many bytes to read and may skip enum-typed entries.

Definition at line 1119 of file nvToolsExtPayload.h.

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

nvToolsExtPayload.h

Data Fields