General

Data Structures
union	nvtxMessageValue_t

Enumerations
enum	nvtxColorType_t { NVTX_COLOR_UNKNOWN = 0 , NVTX_COLOR_ARGB = 1 }
enum	nvtxMessageType_t { NVTX_MESSAGE_UNKNOWN = 0 , NVTX_MESSAGE_TYPE_ASCII = 1 , NVTX_MESSAGE_TYPE_UNICODE = 2 , NVTX_MESSAGE_TYPE_REGISTERED = 3 }
NVTX_DECLSPEC void NVTX_API	nvtxInitialize (const void *reserved)
	Force initialization (optional) .

Detailed Description

Enumeration Type Documentation

nvtxColorType_t

enum nvtxColorType_t

---

Color Types

Enumerator
NVTX_COLOR_UNKNOWN	Color attribute is unused.
NVTX_COLOR_ARGB	An ARGB color is provided.

Definition at line 438 of file nvToolsExt.h.

nvtxMessageType_t

enum nvtxMessageType_t

---

Message Types

Enumerator
NVTX_MESSAGE_UNKNOWN	Message attribute is unused.
NVTX_MESSAGE_TYPE_ASCII	A character sequence is used as payload.
NVTX_MESSAGE_TYPE_UNICODE	A wide character sequence is used as payload.
NVTX_MESSAGE_TYPE_REGISTERED	A unique string handle that was registered with nvtxDomainRegisterStringA() or nvtxDomainRegisterStringW().

Definition at line 447 of file nvToolsExt.h.

Function Documentation

nvtxInitialize()

NVTX_DECLSPEC void NVTX_API nvtxInitialize

(

const void *

reserved

)

Force initialization (optional) .

Force NVTX library to initialize. The first call to any NVTX API function will automatically initialize the entire API. This can make the first call much slower than subsequent calls. In applications where the first call to NVTX may be in a performance-critical section, calling nvtxInitialize before any performance-critical sections will ensure NVTX initialization occurs at an acceptable time. Since nvtxInitialize takes no parameters and has no expected behavior besides initialization, it is convenient to add a call to nvtxInitialize in NVTX-instrumented applications that need to force earlier initialization without changing any other code. For example, if an app's first NVTX call is nvtxDomainCreate, and it is difficult to move that call earlier because the domain handle must be stored in an object only created at that point, adding a call to nvtxInitialize at the top of main() will ensure the later call to nvtxDomainCreate is as fast as possible.

Version

NVTX_VERSION_3

Parameters

reserved

- must be zero or NULL.