 b3aff9a7b1
			
		
	
	
		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`.
		
	
			
		
			
				
	
	
		
			74 lines
		
	
	
		
			2.5 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			74 lines
		
	
	
		
			2.5 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| use bevy::{prelude::*, tasks::prelude::*};
 | |
| use rand::random;
 | |
| 
 | |
| #[derive(Component)]
 | |
| struct Velocity(Vec2);
 | |
| 
 | |
| fn spawn_system(mut commands: Commands, asset_server: Res<AssetServer>) {
 | |
|     commands.spawn_bundle(OrthographicCameraBundle::new_2d());
 | |
|     let texture = asset_server.load("branding/icon.png");
 | |
|     for _ in 0..128 {
 | |
|         commands
 | |
|             .spawn_bundle(SpriteBundle {
 | |
|                 texture: texture.clone(),
 | |
|                 transform: Transform::from_scale(Vec3::splat(0.1)),
 | |
|                 ..default()
 | |
|             })
 | |
|             .insert(Velocity(
 | |
|                 20.0 * Vec2::new(random::<f32>() - 0.5, random::<f32>() - 0.5),
 | |
|             ));
 | |
|     }
 | |
| }
 | |
| 
 | |
| // Move sprites according to their velocity
 | |
| fn move_system(pool: Res<ComputeTaskPool>, mut sprites: Query<(&mut Transform, &Velocity)>) {
 | |
|     // Compute the new location of each sprite in parallel on the
 | |
|     // ComputeTaskPool using batches of 32 sprites
 | |
|     //
 | |
|     // This example is only for demonstrative purposes.  Using a
 | |
|     // ParallelIterator for an inexpensive operation like addition on only 128
 | |
|     // elements will not typically be faster than just using a normal Iterator.
 | |
|     // See the ParallelIterator documentation for more information on when
 | |
|     // to use or not use ParallelIterator over a normal Iterator.
 | |
|     sprites.par_for_each_mut(&pool, 32, |(mut transform, velocity)| {
 | |
|         transform.translation += velocity.0.extend(0.0);
 | |
|     });
 | |
| }
 | |
| 
 | |
| // Bounce sprites outside the window
 | |
| fn bounce_system(
 | |
|     pool: Res<ComputeTaskPool>,
 | |
|     windows: Res<Windows>,
 | |
|     mut sprites: Query<(&Transform, &mut Velocity)>,
 | |
| ) {
 | |
|     let window = windows.primary();
 | |
|     let width = window.width();
 | |
|     let height = window.height();
 | |
|     let left = width / -2.0;
 | |
|     let right = width / 2.0;
 | |
|     let bottom = height / -2.0;
 | |
|     let top = height / 2.0;
 | |
|     sprites
 | |
|         // Batch size of 32 is chosen to limit the overhead of
 | |
|         // ParallelIterator, since negating a vector is very inexpensive.
 | |
|         .par_for_each_mut(&pool, 32, |(transform, mut v)| {
 | |
|             if !(left < transform.translation.x
 | |
|                 && transform.translation.x < right
 | |
|                 && bottom < transform.translation.y
 | |
|                 && transform.translation.y < top)
 | |
|             {
 | |
|                 // For simplicity, just reverse the velocity; don't use realistic bounces
 | |
|                 v.0 = -v.0;
 | |
|             }
 | |
|         });
 | |
| }
 | |
| 
 | |
| fn main() {
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_startup_system(spawn_system)
 | |
|         .add_system(move_system)
 | |
|         .add_system(bounce_system)
 | |
|         .run();
 | |
| }
 |