kvikio::NvtxManager Class Reference

Utility singleton class for NVTX annotation. More...

#include <nvtx.hpp>

Public Member Functions
	NvtxManager (NvtxManager const &)=delete
NvtxManager &	operator= (NvtxManager const &)=delete
	NvtxManager (NvtxManager &&)=delete
NvtxManager &	operator= (NvtxManager &&)=delete

Static Public Member Functions
static NvtxManager &	instance () noexcept
static const nvtx_color_type &	default_color () noexcept
	Return the default color. More...
static const nvtx_color_type &	get_color_by_index (std::uint64_t idx) noexcept
	Return the color at the given index from the internal color palette whose size n is a power of 2. The index may exceed the size of the color palette, in which case it wraps around, i.e. (idx mod n). More...
static void	rename_current_thread (std::string_view new_name) noexcept
	Rename the current thread under the KvikIO NVTX domain. More...

Detailed Description

Utility singleton class for NVTX annotation.

Definition at line 88 of file nvtx.hpp.

Member Function Documentation

default_color()

static const nvtx_color_type& kvikio::NvtxManager::default_color ( )

staticnoexcept

Return the default color.

Returns

Default color.

get_color_by_index()

static const nvtx_color_type& kvikio::NvtxManager::get_color_by_index ( std::uint64_t  idx )

staticnoexcept

Return the color at the given index from the internal color palette whose size n is a power of 2. The index may exceed the size of the color palette, in which case it wraps around, i.e. (idx mod n).

Parameters

idx	The index value.

Returns

The color picked from the internal color palette.

rename_current_thread()

static void kvikio::NvtxManager::rename_current_thread ( std::string_view  new_name )

staticnoexcept

Rename the current thread under the KvikIO NVTX domain.

Note

This NVTX feature is currently not supported by the Nsight System profiler. As a result, the OS thread will not be renamed in the nsys-ui.

---

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

• nvtx.hpp