mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 15:14:50 +00:00
b3aff9a7b1
# Objective
- Improve documentation.
- Provide helper functions for common uses of `Windows` relating to getting the primary `Window`.
- Reduce repeated `Window` code.
# Solution
- Adds infallible `primary()` and `primary_mut()` functions with standard error text. This replaces the commonly used `get_primary().unwrap()` seen throughout bevy which has inconsistent or nonexistent error messages.
- Adds `scale_factor(WindowId)` to replace repeated code blocks throughout.
# Considerations
- The added functions can panic if the primary window does not exist.
- It is very uncommon for the primary window to not exist, as seen by the regular use of `get_primary().unwrap()`. Most users will have a single window and will need to reference the primary window in their code multiple times.
- The panic provides a consistent error message to make this class of error easy to spot from the panic text.
- This follows the established standard of short names for infallible-but-unlikely-to-panic functions in bevy.
- Removes line noise for common usage of `Windows`.
81 lines
2.9 KiB
Rust
81 lines
2.9 KiB
Rust
use bevy::prelude::*;
|
|
|
|
/// This example illustrates how to customize the default window settings
|
|
fn main() {
|
|
App::new()
|
|
.insert_resource(WindowDescriptor {
|
|
width: 500.,
|
|
height: 300.,
|
|
..default()
|
|
})
|
|
.add_plugins(DefaultPlugins)
|
|
.add_startup_system(setup)
|
|
.add_system(toggle_override)
|
|
.add_system(change_scale_factor)
|
|
.run();
|
|
}
|
|
|
|
fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
|
|
// ui camera
|
|
commands.spawn_bundle(UiCameraBundle::default());
|
|
// root node
|
|
commands
|
|
.spawn_bundle(NodeBundle {
|
|
style: Style {
|
|
size: Size::new(Val::Percent(100.0), Val::Percent(100.0)),
|
|
justify_content: JustifyContent::SpaceBetween,
|
|
..default()
|
|
},
|
|
color: Color::NONE.into(),
|
|
..default()
|
|
})
|
|
.with_children(|parent| {
|
|
// left vertical fill (border)
|
|
parent
|
|
.spawn_bundle(NodeBundle {
|
|
style: Style {
|
|
size: Size::new(Val::Px(200.0), Val::Percent(100.0)),
|
|
border: Rect::all(Val::Px(2.0)),
|
|
..default()
|
|
},
|
|
color: Color::rgb(0.65, 0.65, 0.65).into(),
|
|
..default()
|
|
})
|
|
.with_children(|parent| {
|
|
parent.spawn_bundle(TextBundle {
|
|
style: Style {
|
|
align_self: AlignSelf::FlexEnd,
|
|
..default()
|
|
},
|
|
text: Text::with_section(
|
|
"Example text",
|
|
TextStyle {
|
|
font: asset_server.load("fonts/FiraSans-Bold.ttf"),
|
|
font_size: 30.0,
|
|
color: Color::WHITE,
|
|
},
|
|
Default::default(),
|
|
),
|
|
..default()
|
|
});
|
|
});
|
|
});
|
|
}
|
|
|
|
/// This system toggles scale factor overrides when enter is pressed
|
|
fn toggle_override(input: Res<Input<KeyCode>>, mut windows: ResMut<Windows>) {
|
|
let window = windows.primary_mut();
|
|
if input.just_pressed(KeyCode::Return) {
|
|
window.set_scale_factor_override(window.scale_factor_override().xor(Some(1.)));
|
|
}
|
|
}
|
|
|
|
/// This system changes the scale factor override when up or down is pressed
|
|
fn change_scale_factor(input: Res<Input<KeyCode>>, mut windows: ResMut<Windows>) {
|
|
let window = windows.primary_mut();
|
|
if input.just_pressed(KeyCode::Up) {
|
|
window.set_scale_factor_override(window.scale_factor_override().map(|n| n + 1.));
|
|
} else if input.just_pressed(KeyCode::Down) {
|
|
window.set_scale_factor_override(window.scale_factor_override().map(|n| (n - 1.).max(1.)));
|
|
}
|
|
}
|