perf Reference

Module defined in lua/common/utils/perf.lua. Performance profiler that tracks function execution times using debug hooks, with windowed statistics and CSV export.

---

Exports

Functions

M.enable(_windowSize, _guiHook, _srcData)

Enable performance profiling.

• Parameters:
  • _windowSize - number - Number of frames to average over
  • _guiHook - string|nil - GUI hook name for display
  • _srcData - table|nil - External data source

M.disable()

Disable performance profiling and remove debug hooks.

M.update()

Process accumulated profiling data for the current frame. Call each frame.

M.getData()

Get the current profiling statistics.

• Returns: table - Statistics data table

M.saveDataToCSV(filename)

Export profiling data to a CSV file.

• Parameters:
  • filename - string - Output CSV file path

Variables

M.data

• Type: table
• Description: Current frame statistics including frameCount, size (window size), memory (Lua memory usage), and per-function timing data

Internal Notes

• Uses debug.sethook with "cr" (call/return) events for timing
• start(name) / stop(name) internal functions bracket timed sections
• _update computes windowed averages each frame
• Memory tracked via gcinfo()