From ecb05f787e02e3c91bdd85000db2cb0961afec40 Mon Sep 17 00:00:00 2001 From: Bartosz Taudul Date: Sat, 3 Aug 2024 20:33:43 +0200 Subject: [PATCH] Document thread group hints. --- manual/tracy.tex | 2 ++ 1 file changed, 2 insertions(+) diff --git a/manual/tracy.tex b/manual/tracy.tex index 458cc5ad..6228e066 100644 --- a/manual/tracy.tex +++ b/manual/tracy.tex @@ -914,6 +914,8 @@ The graphic server application will adapt to the system DPI scaling. If for some Remember to set thread names for proper identification of threads. You should do so by using the function \texttt{tracy::SetThreadName(name)} exposed in the \texttt{public/common/TracySystem.hpp} header, as the system facilities typically have limited functionality. +It is also possible to specify a thread group hint with \texttt{tracy::SetThreadNameWithHint(name, int32\_t groupHint)}. This hint is an arbitrary number that is used to group threads together in the profiler UI. The default value and the value for the main thread is zero. + Tracy will try to capture thread names through operating system data if context switch capture is active. However, this is only a fallback mechanism, and it shouldn't be relied upon. \subsubsection{Source location data customization}