Skip to content

Commit b30b0a7

Browse files
mweatherleydjeedaialice-i-cecilejanhohenheim
authored
Add Mac OS tracy info to profiling docs (#13826)
## Explanation I got kind of lost on this earlier (the Tracy docs are not very helpful) and required some assistance, so I thought it might be helpful to add this somewhere in the profiling docs. The way it's presently inserted is kind of awkward, but I don't know enough about the other operating systems to make similar sections for them, which I think would be helpful, since it's going to be different on each one. --------- Co-authored-by: Jerome Humbert <[email protected]> Co-authored-by: Alice Cecile <[email protected]> Co-authored-by: Jan Hohenheim <[email protected]>
1 parent 7db5dc0 commit b30b0a7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/profiling.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ There are binaries available for Windows, and installation / build instructions
4242

4343
It has a command line capture tool that can record the execution of graphical applications, saving it as a profile file. Tracy has a GUI to inspect these profile files. The GUI app also supports live capture, showing you in real time the trace of your app. The version of tracy must be matched to the version of tracing-tracy used in bevy. A compatibility table can be found on [crates.io](https://crates.io/crates/tracing-tracy) and the version used can be found [here](https://github.com/bevyengine/bevy/blob/latest/crates/bevy_log/Cargo.toml).
4444

45+
On macOS, Tracy can be installed through Homebrew by running `brew install tracy`, and the GUI client can be launched by running `tracy`.
46+
47+
In one terminal, run:
48+
`./capture-release -o my_capture.tracy`
49+
This will sit and wait for a tracy-instrumented application to start, and when it does, it will automatically connect and start capturing.
50+
4551
The name and location of the Tracy command line tool will vary depending on how you installed it - the default executable names are `capture-release` on Linux, `tracy` on macOS and `capture.exe` on Windows. In one terminal, run this tool: `./capture-release -o my_capture.tracy`. This will sit and wait for a tracy-instrumented application to start, and when it does, it will automatically connect and start capturing.
4652

4753
Then run your application, enabling the `trace_tracy` feature: `cargo run --release --features bevy/trace_tracy`. If you also want to track memory allocations, at the cost of increased runtime overhead, then enable the `trace_tracy_memory` feature instead: `cargo run --release --features bevy/trace_tracy_memory`.

0 commit comments

Comments
 (0)