mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 14:40:19 +00:00
1bb751cb8d
# Objective Fixes #5884 #2879 Alternative to #2988 #5885 #2886 "Immutable" Plugin settings are currently represented as normal ECS resources, which are read as part of plugin init. This presents a number of problems: 1. If a user inserts the plugin settings resource after the plugin is initialized, it will be silently ignored (and use the defaults instead) 2. Users can modify the plugin settings resource after the plugin has been initialized. This creates a false sense of control over settings that can no longer be changed. (1) and (2) are especially problematic and confusing for the `WindowDescriptor` resource, but this is a general problem. ## Solution Immutable Plugin settings now live on each Plugin struct (ex: `WindowPlugin`). PluginGroups have been reworked to support overriding plugin values. This also removes the need for the `add_plugins_with` api, as the `add_plugins` api can use the builder pattern directly. Settings that can be used at runtime continue to be represented as ECS resources. Plugins are now configured like this: ```rust app.add_plugin(AssetPlugin { watch_for_changes: true, ..default() }) ``` PluginGroups are now configured like this: ```rust app.add_plugins(DefaultPlugins .set(AssetPlugin { watch_for_changes: true, ..default() }) ) ``` This is an alternative to #2988, which is similar. But I personally prefer this solution for a couple of reasons: * ~~#2988 doesn't solve (1)~~ #2988 does solve (1) and will panic in that case. I was wrong! * This PR directly ties plugin settings to Plugin types in a 1:1 relationship, rather than a loose "setup resource" <-> plugin coupling (where the setup resource is consumed by the first plugin that uses it). * I'm not a huge fan of overloading the ECS resource concept and implementation for something that has very different use cases and constraints. ## Changelog - PluginGroups can now be configured directly using the builder pattern. Individual plugin values can be overridden by using `plugin_group.set(SomePlugin {})`, which enables overriding default plugin values. - `WindowDescriptor` plugin settings have been moved to `WindowPlugin` and `AssetServerSettings` have been moved to `AssetPlugin` - `app.add_plugins_with` has been replaced by using `add_plugins` with the builder pattern. ## Migration Guide The `WindowDescriptor` settings have been moved from a resource to `WindowPlugin::window`: ```rust // Old (Bevy 0.8) app .insert_resource(WindowDescriptor { width: 400.0, ..default() }) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(WindowPlugin { window: WindowDescriptor { width: 400.0, ..default() }, ..default() })) ``` The `AssetServerSettings` resource has been removed in favor of direct `AssetPlugin` configuration: ```rust // Old (Bevy 0.8) app .insert_resource(AssetServerSettings { watch_for_changes: true, ..default() }) .add_plugins(DefaultPlugins) // New (Bevy 0.9) app.add_plugins(DefaultPlugins.set(AssetPlugin { watch_for_changes: true, ..default() })) ``` `add_plugins_with` has been replaced by `add_plugins` in combination with the builder pattern: ```rust // Old (Bevy 0.8) app.add_plugins_with(DefaultPlugins, |group| group.disable::<AssetPlugin>()); // New (Bevy 0.9) app.add_plugins(DefaultPlugins.build().disable::<AssetPlugin>()); ```
119 lines
3.8 KiB
Rust
119 lines
3.8 KiB
Rust
//! Renders a lot of sprites to allow performance testing.
|
|
//! See <https://github.com/bevyengine/bevy/pull/1492>
|
|
//!
|
|
//! It sets up many sprites in different sizes and rotations, and at different scales in the world,
|
|
//! and moves the camera over them to see how well frustum culling works.
|
|
//!
|
|
//! Add the `--colored` arg to run with color tinted sprites. This will cause the sprites to be rendered
|
|
//! in multiple batches, reducing performance but useful for testing.
|
|
|
|
use bevy::{
|
|
diagnostic::{FrameTimeDiagnosticsPlugin, LogDiagnosticsPlugin},
|
|
prelude::*,
|
|
window::PresentMode,
|
|
};
|
|
|
|
use rand::Rng;
|
|
|
|
const CAMERA_SPEED: f32 = 1000.0;
|
|
|
|
const COLORS: [Color; 3] = [Color::BLUE, Color::WHITE, Color::RED];
|
|
|
|
#[derive(Resource)]
|
|
struct ColorTint(bool);
|
|
|
|
fn main() {
|
|
App::new()
|
|
.insert_resource(ColorTint(
|
|
std::env::args().nth(1).unwrap_or_default() == "--colored",
|
|
))
|
|
// Since this is also used as a benchmark, we want it to display performance data.
|
|
.add_plugin(LogDiagnosticsPlugin::default())
|
|
.add_plugin(FrameTimeDiagnosticsPlugin::default())
|
|
.add_plugins(DefaultPlugins.set(WindowPlugin {
|
|
window: WindowDescriptor {
|
|
present_mode: PresentMode::AutoNoVsync,
|
|
..default()
|
|
},
|
|
..default()
|
|
}))
|
|
.add_startup_system(setup)
|
|
.add_system(print_sprite_count)
|
|
.add_system(move_camera.after(print_sprite_count))
|
|
.run();
|
|
}
|
|
|
|
fn setup(mut commands: Commands, assets: Res<AssetServer>, color_tint: Res<ColorTint>) {
|
|
warn!(include_str!("warning_string.txt"));
|
|
|
|
let mut rng = rand::thread_rng();
|
|
|
|
let tile_size = Vec2::splat(64.0);
|
|
let map_size = Vec2::splat(320.0);
|
|
|
|
let half_x = (map_size.x / 2.0) as i32;
|
|
let half_y = (map_size.y / 2.0) as i32;
|
|
|
|
let sprite_handle = assets.load("branding/icon.png");
|
|
|
|
// Spawns the camera
|
|
|
|
commands.spawn(Camera2dBundle::default());
|
|
|
|
// Builds and spawns the sprites
|
|
let mut sprites = vec![];
|
|
for y in -half_y..half_y {
|
|
for x in -half_x..half_x {
|
|
let position = Vec2::new(x as f32, y as f32);
|
|
let translation = (position * tile_size).extend(rng.gen::<f32>());
|
|
let rotation = Quat::from_rotation_z(rng.gen::<f32>());
|
|
let scale = Vec3::splat(rng.gen::<f32>() * 2.0);
|
|
|
|
sprites.push(SpriteBundle {
|
|
texture: sprite_handle.clone(),
|
|
transform: Transform {
|
|
translation,
|
|
rotation,
|
|
scale,
|
|
},
|
|
sprite: Sprite {
|
|
custom_size: Some(tile_size),
|
|
color: if color_tint.0 {
|
|
COLORS[rng.gen_range(0..3)]
|
|
} else {
|
|
Color::WHITE
|
|
},
|
|
..default()
|
|
},
|
|
..default()
|
|
});
|
|
}
|
|
}
|
|
commands.spawn_batch(sprites);
|
|
}
|
|
|
|
// System for rotating and translating the camera
|
|
fn move_camera(time: Res<Time>, mut camera_query: Query<&mut Transform, With<Camera>>) {
|
|
let mut camera_transform = camera_query.single_mut();
|
|
camera_transform.rotate_z(time.delta_seconds() * 0.5);
|
|
*camera_transform = *camera_transform
|
|
* Transform::from_translation(Vec3::X * CAMERA_SPEED * time.delta_seconds());
|
|
}
|
|
|
|
#[derive(Deref, DerefMut)]
|
|
struct PrintingTimer(Timer);
|
|
|
|
impl Default for PrintingTimer {
|
|
fn default() -> Self {
|
|
Self(Timer::from_seconds(1.0, TimerMode::Repeating))
|
|
}
|
|
}
|
|
|
|
// System for printing the number of sprites on every tick of the timer
|
|
fn print_sprite_count(time: Res<Time>, mut timer: Local<PrintingTimer>, sprites: Query<&Sprite>) {
|
|
timer.tick(time.delta());
|
|
|
|
if timer.just_finished() {
|
|
info!("Sprites: {}", sprites.iter().count(),);
|
|
}
|
|
}
|