Skip to content

Fix benchmark #577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion bevy_rapier_benches3d/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,23 @@ edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[features]
visual = [
"bevy/x11",
"bevy/tonemapping_luts",
"bevy/bevy_core_pipeline",
"bevy/bevy_pbr",
"bevy/bevy_gizmos",
"rapier3d/debug-render",
"bevy_rapier3d/debug-render-3d",
]

[dependencies]
rapier3d = { features = ["profiler"], version = "0.25" }
bevy_rapier3d = { version = "0.30", path = "../bevy_rapier3d" }
bevy_rapier3d = { version = "0.30", path = "../bevy_rapier3d", default-features = false, features = [
"dim3",
"headless",
] }
bevy = { version = "0.16.0", default-features = false }

[dev-dependencies]
Expand Down
7 changes: 7 additions & 0 deletions bevy_rapier_benches3d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ and outputs them at the end.
cargo run --release --bin bench
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Running cargo run --release --bin bench from the root brings all dependencies, but running this from bevy_rapier_benches3d brings only the needed ones, this may be worth a note (and I'd like to understand why.)

```

To visually make sure your benchmarks setup is correct, you can use the feature `visual`,
and edit `bench.rs` to test only the scene you want.

```sh
cargo run --release --bin bench --features visual
```

## cargo bench

For short-lived benchmarks based on statistical analysis,
Expand Down
2 changes: 1 addition & 1 deletion bevy_rapier_benches3d/src/bin/bench.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ fn pyramid_1_with_height_2() {
}

fn pyramid_2_with_height_20() {
custom_bencher(100, |app| setup_pyramids(app, 3, 20));
custom_bencher(100, |app| setup_pyramids(app, 40, 20));
}

fn main() {
Expand Down
31 changes: 30 additions & 1 deletion bevy_rapier_benches3d/src/common.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
use bevy::{app::PluginsState, prelude::*, time::TimeUpdateStrategy};
use bevy::{app::PluginsState, prelude::*};
use bevy_rapier3d::prelude::*;

#[cfg(not(feature = "visual"))]
pub fn default_app() -> App {
use bevy::time::TimeUpdateStrategy;
let mut app = App::new();

app.add_plugins((
Expand All @@ -17,6 +19,33 @@ pub fn default_app() -> App {
app
}

#[cfg(feature = "visual")]
pub fn default_app() -> App {
use bevy::diagnostic::{FrameTimeDiagnosticsPlugin, LogDiagnosticsPlugin};

let mut app = App::new();
println!("visual mode!");
app.insert_resource(ClearColor(Color::srgb(
0xF9 as f32 / 255.0,
0xF9 as f32 / 255.0,
0xFF as f32 / 255.0,
)));
app.add_plugins((
DefaultPlugins,
RapierPhysicsPlugin::<()>::default(),
RapierDebugRenderPlugin::default(),
FrameTimeDiagnosticsPlugin::default(),
LogDiagnosticsPlugin::default(),
));
app.add_systems(Startup, |mut commands: Commands| {
commands.spawn((
Camera3d::default(),
Transform::from_xyz(-30.0, 30.0, 100.0).looking_at(Vec3::new(0.0, 0.0, 0.0), Vec3::Y),
));
});
app
}

pub fn wait_app_start(app: &mut App) {
while app.plugins_state() != PluginsState::Ready {
bevy::tasks::tick_global_task_pools_on_main_thread();
Expand Down
9 changes: 7 additions & 2 deletions bevy_rapier_benches3d/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,22 @@ use common::wait_app_start;
use bevy::prelude::*;
use bevy_rapier3d::plugin::context::RapierContextSimulation;

pub fn custom_bencher(steps: usize, setup: impl Fn(&mut App)) {
pub fn custom_bencher(_steps: usize, setup: impl Fn(&mut App)) {
let mut app = default_app();
setup(&mut app);
#[cfg(feature = "visual")]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add explaination to readme

{
app.run();
return;
}
wait_app_start(&mut app);

let mut timer_total = rapier3d::counters::Timer::new();
let mut timer_full_update = rapier3d::counters::Timer::new();
let mut rapier_step_times = vec![];
let mut total_update_times = vec![];
timer_total.start();
for _ in 0..steps {
for _ in 0.._steps {
timer_full_update.start();
app.update();
timer_full_update.pause();
Expand Down
3 changes: 2 additions & 1 deletion bevy_rapier_benches3d/src/pyramids.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub fn create_pyramid(commands: &mut Commands, offset: Vect, stack_height: usize
commands.spawn((
RigidBody::Dynamic,
Transform::from_translation(Vec3::new(x, y, 0.0) + offset),
Collider::cuboid(1.0, 1.0, 1.0),
Collider::cuboid(rad, rad, rad),
));
}
}
Expand Down Expand Up @@ -47,6 +47,7 @@ pub fn setup_pyramids(app: &mut App, pyramid_count: usize, stack_height: usize)
/*
* Create the pyramids
*/

for pyramid_index in 0..pyramid_count {
let bottomy = rad;
create_pyramid(
Expand Down
Loading