mirror of
https://github.com/bevyengine/bevy
synced 2024-09-20 22:42:08 +00:00
1ba7429371
# Objective Provide a starting point for #3951, or a partial solution. Providing a few comment blocks to discuss, and hopefully find better one in the process. ## Solution Since I am pretty new to pretty much anything in this context, I figured I'd just start with a draft for some file level doc blocks. For some of them I found more relevant details (or at least things I considered interessting), for some others there is less. ## Changelog - Moved some existing comments from main() functions in the 2d examples to the file header level - Wrote some more comment blocks for most other 2d examples TODO: - [x] 2d/sprite_sheet, wasnt able to come up with something good yet - [x] all other example groups... Also: Please let me know if the commit style is okay, or to verbose. I could certainly squash these things, or add more details if needed. I also hope its okay to raise this PR this early, with just a few files changed. Took me long enough and I dont wanted to let it go to waste because I lost motivation to do the whole thing. Additionally I am somewhat uncertain over the style and contents of the commets. So let me know what you thing please.
65 lines
2 KiB
Rust
65 lines
2 KiB
Rust
//! Illustrates how to change window settings and shows how to affect
|
|
//! the mouse pointer in various ways.
|
|
|
|
use bevy::{prelude::*, window::PresentMode};
|
|
|
|
fn main() {
|
|
App::new()
|
|
.insert_resource(WindowDescriptor {
|
|
title: "I am a window!".to_string(),
|
|
width: 500.,
|
|
height: 300.,
|
|
present_mode: PresentMode::Fifo,
|
|
..default()
|
|
})
|
|
.add_plugins(DefaultPlugins)
|
|
.add_system(change_title)
|
|
.add_system(toggle_cursor)
|
|
.add_system(cycle_cursor_icon)
|
|
.run();
|
|
}
|
|
|
|
/// This system will then change the title during execution
|
|
fn change_title(time: Res<Time>, mut windows: ResMut<Windows>) {
|
|
let window = windows.primary_mut();
|
|
window.set_title(format!(
|
|
"Seconds since startup: {}",
|
|
time.seconds_since_startup().round()
|
|
));
|
|
}
|
|
|
|
/// This system toggles the cursor's visibility when the space bar is pressed
|
|
fn toggle_cursor(input: Res<Input<KeyCode>>, mut windows: ResMut<Windows>) {
|
|
let window = windows.primary_mut();
|
|
if input.just_pressed(KeyCode::Space) {
|
|
window.set_cursor_lock_mode(!window.cursor_locked());
|
|
window.set_cursor_visibility(!window.cursor_visible());
|
|
}
|
|
}
|
|
|
|
/// This system cycles the cursor's icon through a small set of icons when clicking
|
|
fn cycle_cursor_icon(
|
|
input: Res<Input<MouseButton>>,
|
|
mut windows: ResMut<Windows>,
|
|
mut index: Local<usize>,
|
|
) {
|
|
const ICONS: &[CursorIcon] = &[
|
|
CursorIcon::Default,
|
|
CursorIcon::Hand,
|
|
CursorIcon::Wait,
|
|
CursorIcon::Text,
|
|
CursorIcon::Copy,
|
|
];
|
|
let window = windows.primary_mut();
|
|
if input.just_pressed(MouseButton::Left) {
|
|
*index = (*index + 1) % ICONS.len();
|
|
window.set_cursor_icon(ICONS[*index]);
|
|
} else if input.just_pressed(MouseButton::Right) {
|
|
*index = if *index == 0 {
|
|
ICONS.len() - 1
|
|
} else {
|
|
*index - 1
|
|
};
|
|
window.set_cursor_icon(ICONS[*index]);
|
|
}
|
|
}
|