 336fddb101
			
		
	
	
		336fddb101
		
			
		
	
	
	
	
		
			
			# Objective In Bevy 0.13, `BackgroundColor` simply tinted the image of any `UiImage`. This was confusing: in every other case (e.g. Text), this added a solid square behind the element. #11165 changed this, but removed `BackgroundColor` from `ImageBundle` to avoid confusion, since the semantic meaning had changed. However, this resulted in a serious UX downgrade / inconsistency, as this behavior was no longer part of the bundle (unlike for `TextBundle` or `NodeBundle`), leaving users with a relatively frustrating upgrade path. Additionally, adding both `BackgroundColor` and `UiImage` resulted in a bizarre effect, where the background color was seemingly ignored as it was covered by a solid white placeholder image. Fixes #13969. ## Solution Per @viridia's design: > - if you don't specify a background color, it's transparent. > - if you don't specify an image color, it's white (because it's a multiplier). > - if you don't specify an image, no image is drawn. > - if you specify both a background color and an image color, they are independent. > - the background color is drawn behind the image (in whatever pixels are transparent) As laid out by @benfrankel, this involves: 1. Changing the default `UiImage` to use a transparent texture but a pure white tint. 2. Adding `UiImage::solid_color` to quickly set placeholder images. 3. Changing the default `BorderColor` and `BackgroundColor` to transparent. 4. Removing the default overrides for these values in the other assorted UI bundles. 5. Adding `BackgroundColor` back to `ImageBundle` and `ButtonBundle`. 6. Adding a 1x1 `Image::transparent`, which can be accessed from `Assets<Image>` via the `TRANSPARENT_IMAGE_HANDLE` constant. Huge thanks to everyone who helped out with the design in the linked issue and [the Discord thread](https://discord.com/channels/691052431525675048/1255209923890118697/1255209999278280844): this was very much a joint design. @cart helped me figure out how to set the UiImage's default texture to a transparent 1x1 image, which is a much nicer fix. ## Testing I've checked the examples modified by this PR, and the `ui` example as well just to be sure. ## Migration Guide - `BackgroundColor` no longer tints the color of images in `ImageBundle` or `ButtonBundle`. Set `UiImage::color` to tint images instead. - The default texture for `UiImage` is now a transparent white square. Use `UiImage::solid_color` to quickly draw debug images. - The default value for `BackgroundColor` and `BorderColor` is now transparent. Set the color to white manually to return to previous behavior.
		
			
				
	
	
		
			93 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			93 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! This example illustrates how to create a button that changes color and text based on its
 | |
| //! interaction state.
 | |
| 
 | |
| use bevy::{color::palettes::basic::*, prelude::*, winit::WinitSettings};
 | |
| 
 | |
| fn main() {
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         // Only run the app when there is user input. This will significantly reduce CPU/GPU use.
 | |
|         .insert_resource(WinitSettings::desktop_app())
 | |
|         .add_systems(Startup, setup)
 | |
|         .add_systems(Update, button_system)
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| const NORMAL_BUTTON: Color = Color::srgb(0.15, 0.15, 0.15);
 | |
| const HOVERED_BUTTON: Color = Color::srgb(0.25, 0.25, 0.25);
 | |
| const PRESSED_BUTTON: Color = Color::srgb(0.35, 0.75, 0.35);
 | |
| 
 | |
| fn button_system(
 | |
|     mut interaction_query: Query<
 | |
|         (&Interaction, &mut UiImage, &mut BorderColor, &Children),
 | |
|         (Changed<Interaction>, With<Button>),
 | |
|     >,
 | |
|     mut text_query: Query<&mut Text>,
 | |
| ) {
 | |
|     for (interaction, mut image, mut border_color, children) in &mut interaction_query {
 | |
|         let mut text = text_query.get_mut(children[0]).unwrap();
 | |
|         match *interaction {
 | |
|             Interaction::Pressed => {
 | |
|                 text.sections[0].value = "Press".to_string();
 | |
|                 image.color = PRESSED_BUTTON;
 | |
|                 border_color.0 = RED.into();
 | |
|             }
 | |
|             Interaction::Hovered => {
 | |
|                 text.sections[0].value = "Hover".to_string();
 | |
|                 image.color = HOVERED_BUTTON;
 | |
|                 border_color.0 = Color::WHITE;
 | |
|             }
 | |
|             Interaction::None => {
 | |
|                 text.sections[0].value = "Button".to_string();
 | |
|                 image.color = NORMAL_BUTTON;
 | |
|                 border_color.0 = Color::BLACK;
 | |
|             }
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
 | |
|     // ui camera
 | |
|     commands.spawn(Camera2dBundle::default());
 | |
|     commands
 | |
|         .spawn(NodeBundle {
 | |
|             style: Style {
 | |
|                 width: Val::Percent(100.0),
 | |
|                 height: Val::Percent(100.0),
 | |
|                 align_items: AlignItems::Center,
 | |
|                 justify_content: JustifyContent::Center,
 | |
|                 ..default()
 | |
|             },
 | |
|             ..default()
 | |
|         })
 | |
|         .with_children(|parent| {
 | |
|             parent
 | |
|                 .spawn(ButtonBundle {
 | |
|                     style: Style {
 | |
|                         width: Val::Px(150.0),
 | |
|                         height: Val::Px(65.0),
 | |
|                         border: UiRect::all(Val::Px(5.0)),
 | |
|                         // horizontally center child text
 | |
|                         justify_content: JustifyContent::Center,
 | |
|                         // vertically center child text
 | |
|                         align_items: AlignItems::Center,
 | |
|                         ..default()
 | |
|                     },
 | |
|                     border_color: BorderColor(Color::BLACK),
 | |
|                     border_radius: BorderRadius::MAX,
 | |
|                     background_color: NORMAL_BUTTON.into(),
 | |
|                     ..default()
 | |
|                 })
 | |
|                 .with_children(|parent| {
 | |
|                     parent.spawn(TextBundle::from_section(
 | |
|                         "Button",
 | |
|                         TextStyle {
 | |
|                             font: asset_server.load("fonts/FiraSans-Bold.ttf"),
 | |
|                             font_size: 40.0,
 | |
|                             color: Color::srgb(0.9, 0.9, 0.9),
 | |
|                         },
 | |
|                     ));
 | |
|                 });
 | |
|         });
 | |
| }
 |