Complete Rust bindings for the Tracy profiler.
Just add the following to your Cargo.toml:
toml
[dependencies.tracy]
package = "tracy_full"
version = "1.3.0"
To enable profiling for a build, add the enable feature:
toml
[dependencies.tracy]
...
features = ["enable"]
```rust
static ALLOC: tracy::GlobalAllocator = tracy::GlobalAllocator::new();
``
This tracks all allocations, using the defaultSystem` allocator for allocations.
For a custom allocator: ```rust
static ALLOC: tracy::GlobalAllocator
Tracy also supports tracking custom allocators using the allocator_api feature:
toml
[dependencies.tracy]
...
features = ["allocator_api"]
rust
let alloc = TrackedAllocator::new(alloc, tracy::c_str!("TrackedAllocator"));
This creates a memory pool named TrackedAllocator in Tracy.
All the allocators have a *Sampled variant that samples the callstack on each allocation.
Mark the end of the main frame using: ```rust use tracy::frame;
frame!(); ```
Mark the end of a sub-frame using:
rust
frame!("Name");
Mark the scope of a discontinuous frame using:
rust
frame!(discontinuous "Name");
The main frame what is usually thought of as a 'frame'. It is usually placed after the swapchain present call on the main thread.
Sub-frames are parts of the main frame, for example, input gathering, physics, and rendering: ```rust loop { // Gather input frame!("Input"); // Process input frame!("Processing"); // Render frame!("Render");
swapchain.present();
frame!();
} ```
Discontinuous frames are frames that are not in sync with the frame on the main thread. This can be things like async asset loading on different threads.
You can plot graphs in Tracy: ```rust use tracy::plotter;
let plotter = plotter!("MyGraph"); plotter.value(1.0); plotter.value(2.0); ```
```rust use tracy::zone;
zone!(); // Zone with no name zone!("MyZone"); // Zone with name "MyZone" zone!(tracy::color::RED); // Zone with color red zone!("MyZone", true); // Zone with name "MyZone", and enabled with a runtime expression. zone!(tracy::color::RED, true); // Zone with color red, and enabled with a runtime expression. zone!("MyZone", tracy::color::RED, true); // Zone with name "MyZone", color red, and enabled with a runtime expression. ``` All zones profile from creation to the end of the enclosed scope.
Futures can be represented as fibers in Tracy. The futures feature must be enabled.
toml
[dependencies.tracy]
...
features = ["enable", "futures"]
```rust
use tracy::future;
tracefuture!(asyncfunction(), "Async Function").await; ```
The unstable feature allows for optimizations that require a nightly compiler.
toml
[dependencies.tracy]
...
features = ["enable", "unstable"]
bevyEnable the bevy feature to be able to profile Bevy systems.
toml
[dependencies.tracy]
...
features = ["enable", "bevy"]
```rust use tracy::bevy::timeline;
App::new().addsystem(timeline(mysystem)).run(); ```
This creates a separate fiber for the system in the tracy timeline.
tracingEnable the tracing feature to be able to profile tracing spans.
toml
[dependencies.tracy]
...
features = ["enable", "tracing"]
```rust use tracy::tracing::TracyLayer;
tracing::subscriber::setglobaldefault( tracing_subscriber::registry().with(TracyLayer) ); ``` Extra data on spans are currently unsupported.
wgpuEnable the wgpu feature to be able to profile wgpu command encoders and render/compute passes.
toml
[dependencies.tracy]
...
features = ["enable", "wgpu"]
```rust use tracy::wgpu::ProfileContext;
let mut profilecontext = ProfileContext::withname("Name", &adapter, &device, &queue, bufferedframes);
``
bufferedframes: the number of frames of profiling data you want the profiler to buffer.
Note that you must synchronize the host and device accordingly, or else the call toend_frame` will panic.
You also need to have one ProfileContext per host thread.
You can create a profiled command encoder: ```rust use tracy::{wgpucommandencoder, wgpurenderpass, wgpucomputepass};
let mut commandencoder = wgpucommandencoder!(device, profilecontext, desc); { let renderpass = wgpurenderpass!(commandencoder, desc) }
{ let computepass = wgpucomputepass!(commandencoder, desc) } ```
At the end of each frame, you must call end_frame:
rust
profile_context.end_frame(&device, &queue);
This uploads the profiling data to the Tracy.