mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +00:00
206c7ce219
Huge thanks to @maniwani, @devil-ira, @hymm, @cart, @superdump and @jakobhellermann for the help with this PR. # Objective - Followup #6587. - Minimal integration for the Stageless Scheduling RFC: https://github.com/bevyengine/rfcs/pull/45 ## Solution - [x] Remove old scheduling module - [x] Migrate new methods to no longer use extension methods - [x] Fix compiler errors - [x] Fix benchmarks - [x] Fix examples - [x] Fix docs - [x] Fix tests ## Changelog ### Added - a large number of methods on `App` to work with schedules ergonomically - the `CoreSchedule` enum - `App::add_extract_system` via the `RenderingAppExtension` trait extension method - the private `prepare_view_uniforms` system now has a public system set for scheduling purposes, called `ViewSet::PrepareUniforms` ### Removed - stages, and all code that mentions stages - states have been dramatically simplified, and no longer use a stack - `RunCriteriaLabel` - `AsSystemLabel` trait - `on_hierarchy_reports_enabled` run criteria (now just uses an ad hoc resource checking run condition) - systems in `RenderSet/Stage::Extract` no longer warn when they do not read data from the main world - `RunCriteriaLabel` - `transform_propagate_system_set`: this was a nonstandard pattern that didn't actually provide enough control. The systems are already `pub`: the docs have been updated to ensure that the third-party usage is clear. ### Changed - `System::default_labels` is now `System::default_system_sets`. - `App::add_default_labels` is now `App::add_default_sets` - `CoreStage` and `StartupStage` enums are now `CoreSet` and `StartupSet` - `App::add_system_set` was renamed to `App::add_systems` - The `StartupSchedule` label is now defined as part of the `CoreSchedules` enum - `.label(SystemLabel)` is now referred to as `.in_set(SystemSet)` - `SystemLabel` trait was replaced by `SystemSet` - `SystemTypeIdLabel<T>` was replaced by `SystemSetType<T>` - The `ReportHierarchyIssue` resource now has a public constructor (`new`), and implements `PartialEq` - Fixed time steps now use a schedule (`CoreSchedule::FixedTimeStep`) rather than a run criteria. - Adding rendering extraction systems now panics rather than silently failing if no subapp with the `RenderApp` label is found. - the `calculate_bounds` system, with the `CalculateBounds` label, is now in `CoreSet::Update`, rather than in `CoreSet::PostUpdate` before commands are applied. - `SceneSpawnerSystem` now runs under `CoreSet::Update`, rather than `CoreStage::PreUpdate.at_end()`. - `bevy_pbr::add_clusters` is no longer an exclusive system - the top level `bevy_ecs::schedule` module was replaced with `bevy_ecs::scheduling` - `tick_global_task_pools_on_main_thread` is no longer run as an exclusive system. Instead, it has been replaced by `tick_global_task_pools`, which uses a `NonSend` resource to force running on the main thread. ## Migration Guide - Calls to `.label(MyLabel)` should be replaced with `.in_set(MySet)` - Stages have been removed. Replace these with system sets, and then add command flushes using the `apply_system_buffers` exclusive system where needed. - The `CoreStage`, `StartupStage, `RenderStage` and `AssetStage` enums have been replaced with `CoreSet`, `StartupSet, `RenderSet` and `AssetSet`. The same scheduling guarantees have been preserved. - Systems are no longer added to `CoreSet::Update` by default. Add systems manually if this behavior is needed, although you should consider adding your game logic systems to `CoreSchedule::FixedTimestep` instead for more reliable framerate-independent behavior. - Similarly, startup systems are no longer part of `StartupSet::Startup` by default. In most cases, this won't matter to you. - For example, `add_system_to_stage(CoreStage::PostUpdate, my_system)` should be replaced with - `add_system(my_system.in_set(CoreSet::PostUpdate)` - When testing systems or otherwise running them in a headless fashion, simply construct and run a schedule using `Schedule::new()` and `World::run_schedule` rather than constructing stages - Run criteria have been renamed to run conditions. These can now be combined with each other and with states. - Looping run criteria and state stacks have been removed. Use an exclusive system that runs a schedule if you need this level of control over system control flow. - For app-level control flow over which schedules get run when (such as for rollback networking), create your own schedule and insert it under the `CoreSchedule::Outer` label. - Fixed timesteps are now evaluated in a schedule, rather than controlled via run criteria. The `run_fixed_timestep` system runs this schedule between `CoreSet::First` and `CoreSet::PreUpdate` by default. - Command flush points introduced by `AssetStage` have been removed. If you were relying on these, add them back manually. - Adding extract systems is now typically done directly on the main app. Make sure the `RenderingAppExtension` trait is in scope, then call `app.add_extract_system(my_system)`. - the `calculate_bounds` system, with the `CalculateBounds` label, is now in `CoreSet::Update`, rather than in `CoreSet::PostUpdate` before commands are applied. You may need to order your movement systems to occur before this system in order to avoid system order ambiguities in culling behavior. - the `RenderLabel` `AppLabel` was renamed to `RenderApp` for clarity - `App::add_state` now takes 0 arguments: the starting state is set based on the `Default` impl. - Instead of creating `SystemSet` containers for systems that run in stages, simply use `.on_enter::<State::Variant>()` or its `on_exit` or `on_update` siblings. - `SystemLabel` derives should be replaced with `SystemSet`. You will also need to add the `Debug`, `PartialEq`, `Eq`, and `Hash` traits to satisfy the new trait bounds. - `with_run_criteria` has been renamed to `run_if`. Run criteria have been renamed to run conditions for clarity, and should now simply return a bool. - States have been dramatically simplified: there is no longer a "state stack". To queue a transition to the next state, call `NextState::set` ## TODO - [x] remove dead methods on App and World - [x] add `App::add_system_to_schedule` and `App::add_systems_to_schedule` - [x] avoid adding the default system set at inappropriate times - [x] remove any accidental cycles in the default plugins schedule - [x] migrate benchmarks - [x] expose explicit labels for the built-in command flush points - [x] migrate engine code - [x] remove all mentions of stages from the docs - [x] verify docs for States - [x] fix uses of exclusive systems that use .end / .at_start / .before_commands - [x] migrate RenderStage and AssetStage - [x] migrate examples - [x] ensure that transform propagation is exported in a sufficiently public way (the systems are already pub) - [x] ensure that on_enter schedules are run at least once before the main app - [x] re-enable opt-in to execution order ambiguities - [x] revert change to `update_bounds` to ensure it runs in `PostUpdate` - [x] test all examples - [x] unbreak directional lights - [x] unbreak shadows (see 3d_scene, 3d_shape, lighting, transparaency_3d examples) - [x] game menu example shows loading screen and menu simultaneously - [x] display settings menu is a blank screen - [x] `without_winit` example panics - [x] ensure all tests pass - [x] SubApp doc test fails - [x] runs_spawn_local tasks fails - [x] [Fix panic_when_hierachy_cycle test hanging](https://github.com/alice-i-cecile/bevy/pull/120) ## Points of Difficulty and Controversy **Reviewers, please give feedback on these and look closely** 1. Default sets, from the RFC, have been removed. These added a tremendous amount of implicit complexity and result in hard to debug scheduling errors. They're going to be tackled in the form of "base sets" by @cart in a followup. 2. The outer schedule controls which schedule is run when `App::update` is called. 3. I implemented `Label for `Box<dyn Label>` for our label types. This enables us to store schedule labels in concrete form, and then later run them. I ran into the same set of problems when working with one-shot systems. We've previously investigated this pattern in depth, and it does not appear to lead to extra indirection with nested boxes. 4. `SubApp::update` simply runs the default schedule once. This sucks, but this whole API is incomplete and this was the minimal changeset. 5. `time_system` and `tick_global_task_pools_on_main_thread` no longer use exclusive systems to attempt to force scheduling order 6. Implemetnation strategy for fixed timesteps 7. `AssetStage` was migrated to `AssetSet` without reintroducing command flush points. These did not appear to be used, and it's nice to remove these bottlenecks. 8. Migration of `bevy_render/lib.rs` and pipelined rendering. The logic here is unusually tricky, as we have complex scheduling requirements. ## Future Work (ideally before 0.10) - Rename schedule_v3 module to schedule or scheduling - Add a derive macro to states, and likely a `EnumIter` trait of some form - Figure out what exactly to do with the "systems added should basically work by default" problem - Improve ergonomics for working with fixed timesteps and states - Polish FixedTime API to match Time - Rebase and merge #7415 - Resolve all internal ambiguities (blocked on better tools, especially #7442) - Add "base sets" to replace the removed default sets.
267 lines
7.7 KiB
Rust
267 lines
7.7 KiB
Rust
//! This example provides a 2D benchmark.
|
|
//!
|
|
//! Usage: spawn more entities by clicking on the screen.
|
|
|
|
use bevy::{
|
|
diagnostic::{Diagnostics, FrameTimeDiagnosticsPlugin, LogDiagnosticsPlugin},
|
|
prelude::*,
|
|
window::{PresentMode, WindowResolution},
|
|
};
|
|
use rand::{thread_rng, Rng};
|
|
|
|
const BIRDS_PER_SECOND: u32 = 10000;
|
|
const GRAVITY: f32 = -9.8 * 100.0;
|
|
const MAX_VELOCITY: f32 = 750.;
|
|
const BIRD_SCALE: f32 = 0.15;
|
|
const HALF_BIRD_SIZE: f32 = 256. * BIRD_SCALE * 0.5;
|
|
|
|
#[derive(Resource)]
|
|
struct BevyCounter {
|
|
pub count: usize,
|
|
pub color: Color,
|
|
}
|
|
|
|
#[derive(Component)]
|
|
struct Bird {
|
|
velocity: Vec3,
|
|
}
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins.set(WindowPlugin {
|
|
primary_window: Some(Window {
|
|
title: "BevyMark".into(),
|
|
resolution: (800., 600.).into(),
|
|
present_mode: PresentMode::AutoNoVsync,
|
|
..default()
|
|
}),
|
|
..default()
|
|
}))
|
|
.add_plugin(FrameTimeDiagnosticsPlugin::default())
|
|
.add_plugin(LogDiagnosticsPlugin::default())
|
|
.insert_resource(BevyCounter {
|
|
count: 0,
|
|
color: Color::WHITE,
|
|
})
|
|
.add_startup_system(setup)
|
|
.add_system(mouse_handler.in_set(CoreSet::Update))
|
|
.add_system(movement_system.in_set(CoreSet::Update))
|
|
.add_system(collision_system.in_set(CoreSet::Update))
|
|
.add_system(counter_system)
|
|
.add_system_to_schedule(CoreSchedule::FixedUpdate, scheduled_spawner)
|
|
.insert_resource(FixedTime::new_from_secs(0.2))
|
|
.run();
|
|
}
|
|
|
|
#[derive(Resource)]
|
|
struct BirdScheduled {
|
|
wave: usize,
|
|
per_wave: usize,
|
|
}
|
|
|
|
fn scheduled_spawner(
|
|
mut commands: Commands,
|
|
windows: Query<&Window>,
|
|
mut scheduled: ResMut<BirdScheduled>,
|
|
mut counter: ResMut<BevyCounter>,
|
|
bird_texture: Res<BirdTexture>,
|
|
) {
|
|
let window = windows.single();
|
|
|
|
if scheduled.wave > 0 {
|
|
spawn_birds(
|
|
&mut commands,
|
|
&window.resolution,
|
|
&mut counter,
|
|
scheduled.per_wave,
|
|
bird_texture.clone_weak(),
|
|
);
|
|
|
|
let mut rng = thread_rng();
|
|
counter.color = Color::rgb_linear(rng.gen(), rng.gen(), rng.gen());
|
|
scheduled.wave -= 1;
|
|
}
|
|
}
|
|
|
|
#[derive(Resource, Deref)]
|
|
struct BirdTexture(Handle<Image>);
|
|
|
|
#[derive(Component)]
|
|
struct StatsText;
|
|
|
|
fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
|
|
warn!(include_str!("warning_string.txt"));
|
|
|
|
let texture = asset_server.load("branding/icon.png");
|
|
|
|
let text_section = move |color, value: &str| {
|
|
TextSection::new(
|
|
value,
|
|
TextStyle {
|
|
font: asset_server.load("fonts/FiraSans-Bold.ttf"),
|
|
font_size: 40.0,
|
|
color,
|
|
},
|
|
)
|
|
};
|
|
|
|
commands.spawn(Camera2dBundle::default());
|
|
commands.spawn((
|
|
TextBundle::from_sections([
|
|
text_section(Color::GREEN, "Bird Count"),
|
|
text_section(Color::CYAN, ""),
|
|
text_section(Color::GREEN, "\nFPS (raw): "),
|
|
text_section(Color::CYAN, ""),
|
|
text_section(Color::GREEN, "\nFPS (SMA): "),
|
|
text_section(Color::CYAN, ""),
|
|
text_section(Color::GREEN, "\nFPS (EMA): "),
|
|
text_section(Color::CYAN, ""),
|
|
])
|
|
.with_style(Style {
|
|
position_type: PositionType::Absolute,
|
|
position: UiRect {
|
|
top: Val::Px(5.0),
|
|
left: Val::Px(5.0),
|
|
..default()
|
|
},
|
|
..default()
|
|
}),
|
|
StatsText,
|
|
));
|
|
|
|
commands.insert_resource(BirdTexture(texture));
|
|
commands.insert_resource(BirdScheduled {
|
|
per_wave: std::env::args()
|
|
.nth(1)
|
|
.and_then(|arg| arg.parse::<usize>().ok())
|
|
.unwrap_or_default(),
|
|
wave: std::env::args()
|
|
.nth(2)
|
|
.and_then(|arg| arg.parse::<usize>().ok())
|
|
.unwrap_or(1),
|
|
});
|
|
}
|
|
|
|
fn mouse_handler(
|
|
mut commands: Commands,
|
|
time: Res<Time>,
|
|
mouse_button_input: Res<Input<MouseButton>>,
|
|
windows: Query<&Window>,
|
|
bird_texture: Res<BirdTexture>,
|
|
mut counter: ResMut<BevyCounter>,
|
|
) {
|
|
let window = windows.single();
|
|
|
|
if mouse_button_input.just_released(MouseButton::Left) {
|
|
let mut rng = thread_rng();
|
|
counter.color = Color::rgb_linear(rng.gen(), rng.gen(), rng.gen());
|
|
}
|
|
|
|
if mouse_button_input.pressed(MouseButton::Left) {
|
|
let spawn_count = (BIRDS_PER_SECOND as f64 * time.delta_seconds_f64()) as usize;
|
|
spawn_birds(
|
|
&mut commands,
|
|
&window.resolution,
|
|
&mut counter,
|
|
spawn_count,
|
|
bird_texture.clone_weak(),
|
|
);
|
|
}
|
|
}
|
|
|
|
fn spawn_birds(
|
|
commands: &mut Commands,
|
|
primary_window_resolution: &WindowResolution,
|
|
counter: &mut BevyCounter,
|
|
spawn_count: usize,
|
|
texture: Handle<Image>,
|
|
) {
|
|
let bird_x = (primary_window_resolution.width() / -2.) + HALF_BIRD_SIZE;
|
|
let bird_y = (primary_window_resolution.height() / 2.) - HALF_BIRD_SIZE;
|
|
let mut rng = thread_rng();
|
|
|
|
for count in 0..spawn_count {
|
|
let bird_z = (counter.count + count) as f32 * 0.00001;
|
|
commands.spawn((
|
|
SpriteBundle {
|
|
texture: texture.clone(),
|
|
transform: Transform {
|
|
translation: Vec3::new(bird_x, bird_y, bird_z),
|
|
scale: Vec3::splat(BIRD_SCALE),
|
|
..default()
|
|
},
|
|
sprite: Sprite {
|
|
color: counter.color,
|
|
..default()
|
|
},
|
|
..default()
|
|
},
|
|
Bird {
|
|
velocity: Vec3::new(
|
|
rng.gen::<f32>() * MAX_VELOCITY - (MAX_VELOCITY * 0.5),
|
|
0.,
|
|
0.,
|
|
),
|
|
},
|
|
));
|
|
}
|
|
counter.count += spawn_count;
|
|
}
|
|
|
|
fn movement_system(time: Res<Time>, mut bird_query: Query<(&mut Bird, &mut Transform)>) {
|
|
for (mut bird, mut transform) in &mut bird_query {
|
|
transform.translation.x += bird.velocity.x * time.delta_seconds();
|
|
transform.translation.y += bird.velocity.y * time.delta_seconds();
|
|
bird.velocity.y += GRAVITY * time.delta_seconds();
|
|
}
|
|
}
|
|
|
|
fn collision_system(windows: Query<&Window>, mut bird_query: Query<(&mut Bird, &Transform)>) {
|
|
let window = windows.single();
|
|
|
|
let half_width = window.width() * 0.5;
|
|
let half_height = window.height() * 0.5;
|
|
|
|
for (mut bird, transform) in &mut bird_query {
|
|
let x_vel = bird.velocity.x;
|
|
let y_vel = bird.velocity.y;
|
|
let x_pos = transform.translation.x;
|
|
let y_pos = transform.translation.y;
|
|
|
|
if (x_vel > 0. && x_pos + HALF_BIRD_SIZE > half_width)
|
|
|| (x_vel <= 0. && x_pos - HALF_BIRD_SIZE < -(half_width))
|
|
{
|
|
bird.velocity.x = -x_vel;
|
|
}
|
|
if y_vel < 0. && y_pos - HALF_BIRD_SIZE < -half_height {
|
|
bird.velocity.y = -y_vel;
|
|
}
|
|
if y_pos + HALF_BIRD_SIZE > half_height && y_vel > 0.0 {
|
|
bird.velocity.y = 0.0;
|
|
}
|
|
}
|
|
}
|
|
|
|
fn counter_system(
|
|
diagnostics: Res<Diagnostics>,
|
|
counter: Res<BevyCounter>,
|
|
mut query: Query<&mut Text, With<StatsText>>,
|
|
) {
|
|
let mut text = query.single_mut();
|
|
|
|
if counter.is_changed() {
|
|
text.sections[1].value = counter.count.to_string();
|
|
}
|
|
|
|
if let Some(fps) = diagnostics.get(FrameTimeDiagnosticsPlugin::FPS) {
|
|
if let Some(raw) = fps.value() {
|
|
text.sections[3].value = format!("{raw:.2}");
|
|
}
|
|
if let Some(sma) = fps.average() {
|
|
text.sections[5].value = format!("{sma:.2}");
|
|
}
|
|
if let Some(ema) = fps.smoothed() {
|
|
text.sections[7].value = format!("{ema:.2}");
|
|
}
|
|
};
|
|
}
|