- Main Page
- Modules
- Data Structures
- Related Pages

Resource Naming

## Functions for NVTX Resource Naming

NVTX_DECLSPEC void NVTX_API | nvtxNameCategoryA (uint32_t category, const char *name)
| Annotate an NVTX category.
NVTX_DECLSPEC void NVTX_API | nvtxNameCategoryW (uint32_t category, const wchar_t *name)
| Annotate an NVTX category.

## Functions for OS Resource Naming

NVTX_DECLSPEC void NVTX_API | nvtxNameOsThreadA (uint32_t threadId, const char *name)
| Annotate an OS thread.
NVTX_DECLSPEC void NVTX_API | nvtxNameOsThreadW (uint32_t threadId, const wchar_t *name)
| Annotate an OS thread.

## Functions for CUDA Resource Naming

NVTX_DECLSPEC void NVTX_API | nvtxNameCuDeviceA (CUdevice device, const char *name)
| Annotates a CUDA device.
NVTX_DECLSPEC void NVTX_API | nvtxNameCuDeviceW (CUdevice device, const wchar_t *name)
| Annotates a CUDA device.
NVTX_DECLSPEC void NVTX_API | nvtxNameCuContextA (CUcontext context, const char *name)
| Annotates a CUDA context.
NVTX_DECLSPEC void NVTX_API | nvtxNameCuContextW (CUcontext context, const wchar_t *name)
| Annotates a CUDA context.
NVTX_DECLSPEC void NVTX_API | nvtxNameCuStreamA (CUstream stream, const char *name)
| Annotates a CUDA stream.
NVTX_DECLSPEC void NVTX_API | nvtxNameCuStreamW (CUstream stream, const wchar_t *name)
| Annotates a CUDA stream.
NVTX_DECLSPEC void NVTX_API | nvtxNameCuEventA (CUevent event, const char *name)
| Annotates a CUDA event.
NVTX_DECLSPEC void NVTX_API | nvtxNameCuEventW (CUevent event, const wchar_t *name)
| Annotates a CUDA event.

## Functions for CUDA Resource Naming

NVTX_DECLSPEC void NVTX_API | nvtxNameCudaDeviceA (int device, const char *name)
| Annotates a CUDA device.
NVTX_DECLSPEC void NVTX_API | nvtxNameCudaDeviceW (int device, const wchar_t *name)
| Annotates a CUDA device.
NVTX_DECLSPEC void NVTX_API | nvtxNameCudaStreamA (cudaStream_t stream, const char *name)
| Annotates a CUDA stream.
NVTX_DECLSPEC void NVTX_API | nvtxNameCudaStreamW (cudaStream_t stream, const wchar_t *name)
| Annotates a CUDA stream.
NVTX_DECLSPEC void NVTX_API | nvtxNameCudaEventA (cudaEvent_t event, const char *name)
| Annotates a CUDA event.
NVTX_DECLSPEC void NVTX_API | nvtxNameCudaEventW (cudaEvent_t event, const wchar_t *name)
| Annotates a CUDA event.

## Functions for OpenCL Resource Naming

NVTX_DECLSPEC void NVTX_API | nvtxNameClDeviceA (cl_device_id device, const char *name)
| Annotates an OpenCL device.
NVTX_DECLSPEC void NVTX_API | nvtxNameClDeviceW (cl_device_id device, const wchar_t *name)
| Annotates an OpenCL device.
NVTX_DECLSPEC void NVTX_API | nvtxNameClContextA (cl_context context, const char *name)
| Annotates an OpenCL context.
NVTX_DECLSPEC void NVTX_API | nvtxNameClContextW (cl_context context, const wchar_t *name)
| Annotates an OpenCL context.
NVTX_DECLSPEC void NVTX_API | nvtxNameClCommandQueueA (cl_command_queue command_queue, const char *name)
| Annotates an OpenCL command queue.
NVTX_DECLSPEC void NVTX_API | nvtxNameClCommandQueueW (cl_command_queue command_queue, const wchar_t *name)
| Annotates an OpenCL command queue.
NVTX_DECLSPEC void NVTX_API | nvtxNameClMemObjectA (cl_mem memobj, const char *name)
| Annotates an OpenCL memory object.
NVTX_DECLSPEC void NVTX_API | nvtxNameClMemObjectW (cl_mem memobj, const wchar_t *name)
| Annotates an OpenCL memory object.
NVTX_DECLSPEC void NVTX_API | nvtxNameClSamplerA (cl_sampler sampler, const char *name)
| Annotates an OpenCL sampler.
NVTX_DECLSPEC void NVTX_API | nvtxNameClSamplerW (cl_sampler sampler, const wchar_t *name)
| Annotates an OpenCL sampler.
NVTX_DECLSPEC void NVTX_API | nvtxNameClProgramA (cl_program program, const char *name)
| Annotates an OpenCL program.
NVTX_DECLSPEC void NVTX_API | nvtxNameClProgramW (cl_program program, const wchar_t *name)
| Annotates an OpenCL program.
NVTX_DECLSPEC void NVTX_API | nvtxNameClEventA (cl_event evnt, const char *name)
| Annotates an OpenCL event.
NVTX_DECLSPEC void NVTX_API | nvtxNameClEventW (cl_event evnt, const wchar_t *name)
| Annotates an OpenCL event.

## Detailed Description

This section covers calls that allow to annotate objects with user-provided names in order to allow for a better analysis of complex trace data. All of the functions take the handle or the ID of the object to name and the name. The functions can be called multiple times during the execution of an application, however, in that case it is implementation dependent which name will be reported by the tool.

# NVTX Resource Naming

The NVIDIA Tools Extension library allows to attribute events with additional information such as category IDs. These category IDs can be annotated with user-provided names using the respective resource naming functions.

# OS Resource Naming

In order to enable a tool to report system threads not just by their thread identifier, the NVIDIA Tools Extension library allows to provide user-given names to these OS resources.

# CUDA Resource Naming

This section covers the API functions that allow to annotate CUDA resources with user-provided names.

# OpenCL Resource Naming

This section covers the API functions that allow to annotate OpenCL resources with user-provided names.