mirrors/tracy
1
0
Fork 0
mirror of https://github.com/wolfpld/tracy synced 2025-04-29 04:23:51 +00:00
Code Issues Releases Wiki Activity

Improve wording in tracy.tex for automatic lua instrumentation

Browse Source
This commit is contained in:
AnthoFoxo 2025-02-28 23:52:23 -05:00 committed by GitHub
parent 9b3c46dd5e
commit bc7ec5b89b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
manual/tracy.tex
View File

@ -2002,15 +2002,11 @@ Even if Tracy is disabled, you still have to pay the no-op function call cost. T
\subsubsection{Automatic instrumentation} \subsubsection{Automatic instrumentation}
Lua code can be automatically instrumented by using the \texttt{tracy::LuaHook(lua\_State*, lua\_Debug*)} function as or within a lua hook. Lua code can be automatically instrumented by using Lua hooks. The \texttt{tracy::LuaHook(lua\_State*, lua\_Debug*)} function may be used as or within a Lua hook. There is a small performance impact from using Lua hooks since the Lua VM will be required to invoke the hook function.
The Lua hook must have the \texttt{LUA\_HOOKCALL} and \texttt{LUA\_HOOKRET} event mask set.
You may either directly set the function as your hook or chain it to your existing hook.
Use \texttt{lua\_sethook(L, tracy::LuaHook, LUA\_MASKCALL | LUA\_MASKRET, 0)} if you do not already have a Lua hook set. The Lua hook must have the \texttt{LUA\_HOOKCALL} and \texttt{LUA\_HOOKRET} event mask set. You may either directly set the function as your hook or chain it to your existing hook.
If you already have a Lua hook, directly use \texttt{tracy::LuaHook(L, ar)} within the hook. Use \texttt{lua\_sethook(L, tracy::LuaHook, LUA\_MASKCALL | LUA\_MASKRET, 0)} if you do not already have a Lua hook set or directly call \texttt{tracy::LuaHook(L, ar)} within your hook if you already have one set.
Note that since lua will have to invoke the hook for every function call and return. There may be a small performance penalty.
\subsection{C API} \subsection{C API}
\label{capi} \label{capi}