Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 1.58 KB

profiling.md

File metadata and controls

26 lines (22 loc) · 1.58 KB

Optional Tracy CPU profiling

HIGHMAP_ENABLE_TRACY defaults to OFF; normal builds do not require Tracy. To enable it, install a Tracy client built with TRACY_ENABLE=ON, then configure with -DHIGHMAP_ENABLE_TRACY=ON -DTracy_DIR=/path/to/lib/cmake/Tracy. Use matching client and capture/profiler versions. On-demand clients are supported.

The highmap CMake target publicly propagates both the client target and HIGHMAP_ENABLE_TRACY, so consumers instantiate the public tile templates with the same instrumentation as the library. Do not manually enable the macro in only some translation units. Link a single client into the final executable. Disabled hooks discard metadata expressions; enabled metadata is evaluated only while connected.

Zones cover VirtualArray conversion/write-back, overlap synchronization, VirtualTexture conversion, shared tiled and full-array dispatch, HydraulicBlur stages and asset mesh generation/export. Tile dispatch separates storage acquire, callback and release; full-array dispatch separates gather, callback and scatter. The downscaled scatter includes high-frequency reconstruction. No per-cell zones are emitted. Many small tiles can still generate substantial capture traffic.

These are CPU durations, including any synchronous library work and waits. They are not GPU kernel/transfer timing or allocation tracking. Nested times include their children. Distributed tile zones run on worker threads, so their sum is not dispatch wall time. Conversion callbacks also appear as tile algorithms; interpret them using the enclosing conversion zone and thread context.