archive-gh-me/maplibre-rs
1
0
Fork 0
mirror of https://github.com/maplibre/maplibre-rs.git synced 2025-12-08 19:05:57 +00:00
Code Issues Projects Releases Wiki Activity
maplibre-rs/docs/src/development-guide/debugging.md
karisair a8f704a31a
Fixes #138 - upgraded tracy-client to 0.14.* and tracing-tracy to 0.10.* (#156) 
* Fixes #138 - upgraded tracy-client to 0.14.* and tracing-tracy to 0.10.* as per README

* Convert set_thread_name to a macro (set_thread_name!), to permit non-web tracing.

* Updated docs to briefly explain the connection to tracy and the appropriate crate versions.

Co-authored-by: Max Ammann <max@maxammann.org>
2022-09-08 18:17:22 +02:00

1.6 KiB
Raw Blame History

Debugging

  • log crate

GPU Debugging

  • For WebGL there is SpectorJS is enabled by default right now. For debugging on a desktop environment you can use RenderDoc.

Frame Profiling

maplibre-rs is set up to use the Tracy profiler (https://github.com/wolfpld/tracy). It's mainly designed for C++ but has some Rust support.

The connection to Rust uses a project that connects to the tracing crate (https://github.com/nagisa/rust_tracy_client). This uses a set of three crates (tracing-tracy, tracy-client, tracy-client-sys).

Unfortunately, the Tracy project does not use semantic versioning, whereas tracing-tracy, tracy-client, tracy-client sys do.

The current version of the Rust client is at v0.8.1 of Tracy. See the correlating versions in the table below (original at https://github.com/nagisa/rust_tracy_client#version-support-table):

Tracy tracy-client-sys tracy-client tracing-tracy
0.7.1 0.9.0 0.8.0 0.2.0
0.7.3 0.10.0 0.9.0 0.3.0
0.7.4 0.11.0 0.10.0 0.4.0
0.7.5 0.12.0 0.11.0 0.5.0
0.7.6 0.13.0, 0.14.0 0.12.* 0.6.*
v0.7.7 0.15.0 0.12.* 0.6.*
v0.7.8 0.16.0 0.12.* 0.6.*
v0.7.8 0.16.0 0.12.* 0.7.*
v0.7.8 0.16.0 0.12.* 0.8.*
v0.8.1 0.17.* 0.13.* 0.9.*
v0.8.1 0.17.* 0.14.* 0.10.*