mirror of
https://github.com/bevyengine/bevy
synced 2024-09-20 14:32:06 +00:00
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. |
||
|---|---|---|
| .. | ||
| borders.rs | ||
| button.rs | ||
| display_and_visibility.rs | ||
| flex_layout.rs | ||
| font_atlas_debug.rs | ||
| grid.rs | ||
| overflow.rs | ||
| overflow_debug.rs | ||
| relative_cursor_position.rs | ||
| render_ui_to_texture.rs | ||
| rounded_borders.rs | ||
| size_constraints.rs | ||
| text.rs | ||
| text_debug.rs | ||
| text_wrap_debug.rs | ||
| transparency_ui.rs | ||
| ui.rs | ||
| ui_material.rs | ||
| ui_scaling.rs | ||
| ui_texture_atlas.rs | ||
| ui_texture_atlas_slice.rs | ||
| ui_texture_slice.rs | ||
| viewport_debug.rs | ||
| window_fallthrough.rs | ||
| z_index.rs | ||