Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/wolfpld/tracy.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorSimonas Kazlauskas <git@kazlauskas.me>2021-09-18 14:39:19 +0300
committerSimonas Kazlauskas <git@kazlauskas.me>2021-09-18 14:54:00 +0300
commit173a165a57ce392dd1364465600b9ed08e516337 (patch)
tree0c35eac006595516958b647818a83bfc3f030848 /manual
parent54ee3d8a949e9694518141d51b1b8bc94317ac66 (diff)
Add `startup/shutdown_profiler` to the manual
Also remove the documentation for the now-gone `___tracy_init_thread` function.
Diffstat (limited to 'manual')
-rw-r--r--manual/tracy.tex8
1 files changed, 2 insertions, 6 deletions
diff --git a/manual/tracy.tex b/manual/tracy.tex
index aa67bba0..c7db9f22 100644
--- a/manual/tracy.tex
+++ b/manual/tracy.tex
@@ -1793,7 +1793,8 @@ You can collect call stacks of zones and memory allocation events, as described
Tracy C API exposes functions with the \texttt{\_\_\_tracy} prefix that may be used to write bindings to other programming languages. Most of the functions available are a counterpart to macros described in section~\ref{capi}. Some functions do not have macro equivalents and are dedicated expressly for binding implementation purposes. This includes the following:
\begin{itemize}
-\item \texttt{\_\_\_tracy\_init\_thread(void)}
+\item \texttt{\_\_\_tracy\_startup\_profiler(void)}
+\item \texttt{\_\_\_tracy\_shutdown\_profiler(void)}
\item \texttt{\_\_\_tracy\_alloc\_srcloc(uint32\_t line, const char* source, size\_t sourceSz, const char* function, size\_t functionSz)}
\item \texttt{\_\_\_tracy\_alloc\_srcloc\_name(uint32\_t line, const char* source, size\_t sourceSz, const char* function, size\_t functionSz, const char* name, size\_t nameSz)}
\end{itemize}
@@ -1809,11 +1810,6 @@ location}. As these functions do not require for the provided string data to be
return, calling code is free to deallocate them at any time afterwards. This way the string
lifetime requirements described in section~\ref{textstrings} are relaxed.
-Before the \texttt{\_\_\_tracy\_alloc\_*} functions are called on a non-main thread for the first
-time, care should be taken to ensure that \texttt{\_\_\_tracy\_init\_thread} has been called first.
-The \texttt{\_\_\_tracy\_init\_thread} function initializes per-thread structures Tracy uses and
-can be safely called multiple times.
-
The \texttt{uint64\_t} return value from allocation functions must be passed to one of the zone
begin functions: