History

Benjamin Brienen 4df8b1998e Allow or fix dead code in `benches` (#16282 ) # Objective Fixes #15806 ## Solution Fix an undeclared module and expect `dead_code`. ## Testing Run this command and see no `dead_code` warnings. `cargo +nightly check --benches --target-dir ../target --manifest-path ./benches/Cargo.toml`		2024-11-07 22:19:07 +00:00
..
benches	Allow or fix dead code in `benches` (#16282 )	2024-11-07 22:19:07 +00:00
Cargo.toml	Add mesh picking backend and `MeshRayCast` system parameter (#15800 )	2024-10-13 17:24:19 +00:00
README.md	Add README to benches (#11508 )	2024-01-24 17:11:28 +00:00

README.md

Bevy Benchmarks

This is a crate with a collection of benchmarks for Bevy, separate from the rest of the Bevy crates.

Running the benchmarks

Setup everything you need for Bevy with the setup guide.
Move into the benches directory (where this README is located).
```
bevy $ cd benches
```
Run the benchmarks with cargo (This will take a while)
```
bevy/benches $ cargo bench
```
If you'd like to only compile the benchmarks (without running them), you can do that like this:
```
bevy/benches $ cargo bench --no-run
```

Criterion

Bevy's benchmarks use Criterion. If you want to learn more about using Criterion for comparing performance against a baseline or generating detailed reports, you can read the Criterion.rs documentation.