Resize mode for Sprite component

Adds a 'resize_mode' field for 'Sprite'. This allows different resize handling based on 'SpriteResizeMode' enum value. Co-authored-by: Marcel Müller <neikos@neikos.email>
bevyengine · Sep 5, 2020 · eba129b · eba129b
1 parent 5f1fef3
commit eba129b
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 33 deletions.
diff --git a/crates/bevy_sprite/src/lib.rs b/crates/bevy_sprite/src/lib.rs
@@ -20,7 +20,7 @@ pub use texture_atlas_builder::*;
 pub mod prelude {
     pub use crate::{
         entity::{SpriteComponents, SpriteSheetComponents},
-        ColorMaterial, Sprite, TextureAtlas, TextureAtlasSprite,
+        ColorMaterial, Sprite, SpriteResizeMode, TextureAtlas, TextureAtlasSprite,
     };
 }
 

diff --git a/crates/bevy_sprite/src/render/sprite.vert b/crates/bevy_sprite/src/render/sprite.vert
@@ -13,12 +13,12 @@ layout(set = 0, binding = 0) uniform Camera {
 layout(set = 2, binding = 0) uniform Transform {
     mat4 Model;
 };
-layout(set = 2, binding = 1) uniform Sprite {
-    vec2 Sprite_size;
+layout(set = 2, binding = 1) uniform Sprite_size {
+    vec2 size;
 };
 
 void main() {
     v_Uv = Vertex_Uv;
-    vec3 position = Vertex_Position * vec3(Sprite_size, 1.0);
+    vec3 position = Vertex_Position * vec3(size, 1.0);
     gl_Position = ViewProj * Model * vec4(position, 1.0);
 }
diff --git a/crates/bevy_sprite/src/sprite.rs b/crates/bevy_sprite/src/sprite.rs
@@ -3,16 +3,37 @@ use bevy_asset::{Assets, Handle};
 use bevy_core::Byteable;
 use bevy_ecs::{Query, Res};
 use bevy_math::Vec2;
-use bevy_render::{
-    renderer::{RenderResource, RenderResources},
-    texture::Texture,
-};
+use bevy_render::{renderer::RenderResources, texture::Texture};
 
 #[repr(C)]
-#[derive(Default, RenderResources, RenderResource)]
-#[render_resources(from_self)]
+#[derive(Default, RenderResources)]
 pub struct Sprite {
     pub size: Vec2,
+    #[render_resources(ignore)]
+    pub resize_mode: SpriteResizeMode,
+}
+
+/// Determines how `Sprite` resize should be handled
+#[derive(Debug)]
+pub enum SpriteResizeMode {
+    Manual,
+    Automatic,
+}
+
+impl Default for SpriteResizeMode {
+    fn default() -> Self {
+        SpriteResizeMode::Automatic
+    }
+}
+
+impl Sprite {
+    /// Creates new `Sprite` with `SpriteResizeMode::Manual` value for `resize_mode`
+    pub fn new(size: Vec2) -> Self {
+        Self {
+            size,
+            resize_mode: SpriteResizeMode::Manual,
+        }
+    }
 }
 
 // SAFE: sprite is repr(C) and only consists of byteables
@@ -24,10 +45,15 @@ pub fn sprite_system(
     mut query: Query<(&mut Sprite, &Handle<ColorMaterial>)>,
 ) {
     for (mut sprite, handle) in &mut query.iter() {
-        let material = materials.get(&handle).unwrap();
-        if let Some(texture_handle) = material.texture {
-            if let Some(texture) = textures.get(&texture_handle) {
-                sprite.size = texture.size;
+        match sprite.resize_mode {
+            SpriteResizeMode::Manual => continue,
+            SpriteResizeMode::Automatic => {
+                let material = materials.get(&handle).unwrap();
+                if let Some(texture_handle) = material.texture {
+                    if let Some(texture) = textures.get(&texture_handle) {
+                        sprite.size = texture.size;
+                    }
+                }
             }
         }
     }

diff --git a/examples/game/breakout.rs b/examples/game/breakout.rs
@@ -49,9 +49,7 @@ fn setup(
         .spawn(SpriteComponents {
             material: materials.add(Color::rgb(0.2, 0.2, 0.8).into()),
             translation: Translation(Vec3::new(0.0, -215.0, 0.0)),
-            sprite: Sprite {
-                size: Vec2::new(120.0, 30.0),
-            },
+            sprite: Sprite::new(Vec2::new(120.0, 30.0)),
             ..Default::default()
         })
         .with(Paddle { speed: 500.0 })
@@ -60,9 +58,7 @@ fn setup(
         .spawn(SpriteComponents {
             material: materials.add(Color::rgb(0.8, 0.2, 0.2).into()),
             translation: Translation(Vec3::new(0.0, -50.0, 1.0)),
-            sprite: Sprite {
-                size: Vec2::new(30.0, 30.0),
-            },
+            sprite: Sprite::new(Vec2::new(30.0, 30.0)),
             ..Default::default()
         })
         .with(Ball {
@@ -100,39 +96,31 @@ fn setup(
         .spawn(SpriteComponents {
             material: wall_material,
             translation: Translation(Vec3::new(-bounds.x() / 2.0, 0.0, 0.0)),
-            sprite: Sprite {
-                size: Vec2::new(wall_thickness, bounds.y() + wall_thickness),
-            },
+            sprite: Sprite::new(Vec2::new(wall_thickness, bounds.y() + wall_thickness)),
             ..Default::default()
         })
         .with(Collider::Solid)
         // right
         .spawn(SpriteComponents {
             material: wall_material,
             translation: Translation(Vec3::new(bounds.x() / 2.0, 0.0, 0.0)),
-            sprite: Sprite {
-                size: Vec2::new(wall_thickness, bounds.y() + wall_thickness),
-            },
+            sprite: Sprite::new(Vec2::new(wall_thickness, bounds.y() + wall_thickness)),
             ..Default::default()
         })
         .with(Collider::Solid)
         // bottom
         .spawn(SpriteComponents {
             material: wall_material,
             translation: Translation(Vec3::new(0.0, -bounds.y() / 2.0, 0.0)),
-            sprite: Sprite {
-                size: Vec2::new(bounds.x() + wall_thickness, wall_thickness),
-            },
+            sprite: Sprite::new(Vec2::new(bounds.x() + wall_thickness, wall_thickness)),
             ..Default::default()
         })
         .with(Collider::Solid)
         // top
         .spawn(SpriteComponents {
             material: wall_material,
             translation: Translation(Vec3::new(0.0, bounds.y() / 2.0, 0.0)),
-            sprite: Sprite {
-                size: Vec2::new(bounds.x() + wall_thickness, wall_thickness),
-            },
+            sprite: Sprite::new(Vec2::new(bounds.x() + wall_thickness, wall_thickness)),
             ..Default::default()
         })
         .with(Collider::Solid);
@@ -158,7 +146,7 @@ fn setup(
                 // brick
                 .spawn(SpriteComponents {
                     material: materials.add(Color::rgb(0.2, 0.2, 0.8).into()),
-                    sprite: Sprite { size: brick_size },
+                    sprite: Sprite::new(brick_size),
                     translation: Translation(brick_position),
                     ..Default::default()
                 })