Feat/UI texture atlas #5070

ManevilleF · 2022-06-22T09:58:18Z

Objective

Add support for texture sheets in bevy_ui. (Previous attempt: #3792).

Texture sheet support can enable:

Animated buttons (or any UI element)
Global texture mapping for UI

Closes #1169

Solution

I applied the exact same logic as #5103.
To use texture atlases for UI, adding a TextureAtlas component is enough to make it work.

Note

This MR is now based on #5103 I will rebase this branch on main once the base MR is merged

crates/bevy_ui/src/ui_node.rs

alice-i-cecile

Interesting. From an ergonomics perspective I really like the enum approach. Especially once you migrate the index into the enum's data.

I actually think we should use this same strategy for 2D unless there are serious performance regressions; it makes the mental model and API much better. If we go that route, this should be done as two PRs:

Migrate 2D sprites to this enum-ful approach.
Add texture atlas support for UI.

@cart, do you have strong opinions here?

crates/bevy_ui/src/entity.rs

crates/bevy_ui/src/render/mod.rs

ManevilleF · 2022-06-22T13:03:50Z

So everything seems to be working, I had some issues with the Rect computation on the extraction stage but it's all good now.

@alice-i-cecile About bevy_sprite and ergonomics overall I agree. I think this approach is cleaner and applying it to sprites would bring improvements like:

No need for SpriteSheetBundle
No need for TextureAtlasSprite which is very redundant with the Sprite component

If this approach is accepted I can open a different MR to bring these changes to bevy_sprite

crates/bevy_ui/src/entity.rs

alice-i-cecile

Very nice. I'm happy with this now, and would love to see the rest of 2D unified under this approach. Adding this to Cart's Attention Board.

EDIT: actually, adding the sibling and blocking this PR on #5072.

ManevilleF · 2022-06-22T13:41:38Z

Very nice. I'm happy with this now, and would love to see the rest of 2D unified under this approach. Adding this to Cart's Attention Board.

Thanks, I opened a second PR for sprites here: #5072

alice-i-cecile · 2022-06-27T16:59:07Z

Blocking on #5103; we should use that approach here too :)

ManevilleF · 2022-06-28T08:08:07Z

I rebased this MR upon #5103 in order to use the same logic and components, I will rebase it on main once #5103 is merged and only keep the UI related changes

alice-i-cecile · 2022-09-30T15:00:53Z

Third party impl: bevyengine/bevy-assets#253

rparrett · 2023-01-31T14:00:31Z

Could you mark this as closing #1169?

lewiszlw · 2023-02-28T02:03:53Z

Really useful feature, hope users can use it asap.

Co-authored-by: Alice Cecile <[email protected]>

Co-authored-by: François <[email protected]>

Co-authored-by: Alice Cecile <[email protected]>

nicoburns · 2023-06-19T18:43:40Z

When using an image as a UI node, the image's intrinsic size is used as part of layout (if/when the layout engine requests that node's content-based size). TextureAtlas also seem to have an intrinsic size (actually two: the size in the atlas and an optional override size). Would it make sense to use those sizes for layout when TextureAtlas is used on a UI node?

(my intuition is that it would, but it probably doesn't need to block this PR and could be added later).

alice-i-cecile · 2023-06-19T21:16:47Z

Closing in favor of #8822, which isn't blocked on a refactor.

@ManevilleF

# Objective This adds support for using texture atlas sprites in UI. From discussions today in the ui-dev discord it seems this is a much wanted feature. This was previously attempted in #5070 by @ManevilleF however that was blocked #5103. This work can be easily modified to support #5103 changes after that merges. ## Solution I created a new UI bundle that reuses the existing texture atlas infrastructure. I create a new atlas image component to prevent it from being drawn by the existing non-UI systems and to remove unused parameters. In extract I added new system to calculate the required values for the texture atlas image, this extracts into the same resource as the existing UI Image and Text components. This should have minimal performance impact because if texture atlas is not present then the exact same code path is followed. Also there should be no unintended behavior changes because without the new components the existing systems write the extract same resulting data. I also added an example showing the sprite working and a system to advance the animation on space bar presses. Naming is hard and I would accept any feedback on the bundle name! --- ## Changelog > Added TextureAtlasImageBundle --------- Co-authored-by: ickshonpe <[email protected]>

@mockersf

# Objective > Old MR: #5072 > ~~Associated UI MR: #5070~~ > Adresses #1618 Unify sprite management ## Solution - Remove the `Handle<Image>` field in `TextureAtlas` which is the main cause for all the boilerplate - Remove the redundant `TextureAtlasSprite` component - Renamed `TextureAtlas` asset to `TextureAtlasLayout` ([suggestion](#5103 (comment))) - Add a `TextureAtlas` component, containing the atlas layout handle and the section index The difference between this solution and #5072 is that instead of the `enum` approach is that we can more easily manipulate texture sheets without any breaking changes for classic `SpriteBundle`s (@mockersf [comment](#5072 (comment))) Also, this approach is more *data oriented* extracting the `Handle<Image>` and avoiding complex texture atlas manipulations to retrieve the texture in both applicative and engine code. With this method, the only difference between a `SpriteBundle` and a `SpriteSheetBundle` is an **additional** component storing the atlas handle and the index. ~~This solution can be applied to `bevy_ui` as well (see #5070).~~ EDIT: I also applied this solution to Bevy UI ## Changelog - (**BREAKING**) Removed `TextureAtlasSprite` - (**BREAKING**) Renamed `TextureAtlas` to `TextureAtlasLayout` - (**BREAKING**) `SpriteSheetBundle`: - Uses a `Sprite` instead of a `TextureAtlasSprite` component - Has a `texture` field containing a `Handle<Image>` like the `SpriteBundle` - Has a new `TextureAtlas` component instead of a `Handle<TextureAtlasLayout>` - (**BREAKING**) `DynamicTextureAtlasBuilder::add_texture` takes an additional `&Handle<Image>` parameter - (**BREAKING**) `TextureAtlasLayout::from_grid` no longer takes a `Handle<Image>` parameter - (**BREAKING**) `TextureAtlasBuilder::finish` now returns a `Result<(TextureAtlasLayout, Handle<Image>), _>` - `bevy_text`: - `GlyphAtlasInfo` stores the texture `Handle<Image>` - `FontAtlas` stores the texture `Handle<Image>` - `bevy_ui`: - (**BREAKING**) Removed `UiAtlasImage` , the atlas bundle is now identical to the `ImageBundle` with an additional `TextureAtlas` ## Migration Guide * Sprites ```diff fn my_system( mut images: ResMut<Assets<Image>>, - mut atlases: ResMut<Assets<TextureAtlas>>, + mut atlases: ResMut<Assets<TextureAtlasLayout>>, asset_server: Res<AssetServer> ) { let texture_handle: asset_server.load("my_texture.png"); - let layout = TextureAtlas::from_grid(texture_handle, Vec2::new(25.0, 25.0), 5, 5, None, None); + let layout = TextureAtlasLayout::from_grid(Vec2::new(25.0, 25.0), 5, 5, None, None); let layout_handle = atlases.add(layout); commands.spawn(SpriteSheetBundle { - sprite: TextureAtlasSprite::new(0), - texture_atlas: atlas_handle, + atlas: TextureAtlas { + layout: layout_handle, + index: 0 + }, + texture: texture_handle, ..Default::default() }); } ``` * UI ```diff fn my_system( mut images: ResMut<Assets<Image>>, - mut atlases: ResMut<Assets<TextureAtlas>>, + mut atlases: ResMut<Assets<TextureAtlasLayout>>, asset_server: Res<AssetServer> ) { let texture_handle: asset_server.load("my_texture.png"); - let layout = TextureAtlas::from_grid(texture_handle, Vec2::new(25.0, 25.0), 5, 5, None, None); + let layout = TextureAtlasLayout::from_grid(Vec2::new(25.0, 25.0), 5, 5, None, None); let layout_handle = atlases.add(layout); commands.spawn(AtlasImageBundle { - texture_atlas_image: UiTextureAtlasImage { - index: 0, - flip_x: false, - flip_y: false, - }, - texture_atlas: atlas_handle, + atlas: TextureAtlas { + layout: layout_handle, + index: 0 + }, + image: UiImage { + texture: texture_handle, + flip_x: false, + flip_y: false, + }, ..Default::default() }); } ``` --------- Co-authored-by: Alice Cecile <[email protected]> Co-authored-by: François <[email protected]> Co-authored-by: IceSentry <[email protected]>

ManevilleF mentioned this pull request Jun 22, 2022

UI Texture Atlas support #3792

Closed

mockersf reviewed Jun 22, 2022

View reviewed changes

crates/bevy_ui/src/ui_node.rs Outdated Show resolved Hide resolved

alice-i-cecile added C-Feature A new feature, making something new possible A-UI Graphical user interfaces, styles, layouts, and widgets labels Jun 22, 2022

alice-i-cecile reviewed Jun 22, 2022

View reviewed changes

crates/bevy_ui/src/entity.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Jun 22, 2022

View reviewed changes

crates/bevy_ui/src/render/mod.rs Outdated Show resolved Hide resolved

alice-i-cecile added the X-Controversial There is active debate or serious implications around merging this PR label Jun 22, 2022

ManevilleF marked this pull request as ready for review June 22, 2022 12:57

alice-i-cecile reviewed Jun 22, 2022

View reviewed changes

crates/bevy_ui/src/entity.rs Outdated Show resolved Hide resolved

ManevilleF mentioned this pull request Jun 22, 2022

Unify sprites and sprite sheets #5072

Closed

5 tasks

alice-i-cecile approved these changes Jun 22, 2022

View reviewed changes

ManevilleF force-pushed the feat/ui_texture_atlas branch from a1145d9 to 29b8a7e Compare June 24, 2022 13:28

ManevilleF mentioned this pull request Jun 26, 2022

Texture Atlas rework #5103

Merged

alice-i-cecile added the S-Blocked This cannot move forward until something else changes label Jun 27, 2022

ManevilleF force-pushed the feat/ui_texture_atlas branch from 29b8a7e to ab4e049 Compare June 28, 2022 08:04

ManevilleF force-pushed the feat/ui_texture_atlas branch from ab4e049 to 2aafef4 Compare June 28, 2022 10:17

ManevilleF marked this pull request as draft June 28, 2022 18:21

ManevilleF force-pushed the feat/ui_texture_atlas branch from 2aafef4 to 3dd87a5 Compare July 4, 2022 14:00

ManevilleF mentioned this pull request Jul 5, 2022

Sprite slice scaling and tiling #5213

Closed

11 tasks

ManevilleF force-pushed the feat/ui_texture_atlas branch 3 times, most recently from 5820644 to a97e8d0 Compare July 14, 2022 09:12

afonsolage mentioned this pull request Aug 9, 2022

Add UiImage offset property #5629

Closed

ManevilleF force-pushed the feat/ui_texture_atlas branch from a97e8d0 to 830ac83 Compare August 9, 2022 17:07

ManevilleF force-pushed the feat/ui_texture_atlas branch 2 times, most recently from 6650529 to 8ff7fa9 Compare December 12, 2022 15:01

alice-i-cecile removed this from the 0.10 milestone Feb 13, 2023

hymm modified the milestone: 0.11 Feb 13, 2023

alice-i-cecile added this to the 0.11 milestone Feb 28, 2023

ManevilleF force-pushed the feat/ui_texture_atlas branch 2 times, most recently from 75d8fd0 to 3253eca Compare March 12, 2023 15:14

ManevilleF force-pushed the feat/ui_texture_atlas branch 2 times, most recently from 531d1b4 to 6a780c0 Compare March 25, 2023 11:00

ManevilleF and others added 9 commits May 13, 2023 11:17

Texture Atlas rework

163fb78

Unify SpriteBundle and SpriteSheetBundle

c18c9e4

Co-authored-by: Alice Cecile <[email protected]>

Apply suggestions from code review

3a6fa5a

Co-authored-by: François <[email protected]>

Docs improvements

214d10d

Rebased on main

dc918ec

texture atlas layout in the texture atlas module

92b84ef

Rebase on main

bfcd2fa

Apply suggestions from code review

1b0969d

Co-authored-by: Alice Cecile <[email protected]>

Ui texture Atlas

c8763f6

ManevilleF force-pushed the feat/ui_texture_atlas branch from 6a780c0 to c8763f6 Compare May 13, 2023 09:47

pkupper mentioned this pull request Jun 16, 2023

UI texture atlas support #8822

Merged

alice-i-cecile added the A-Rendering Drawing game state to the screen label Jun 19, 2023

alice-i-cecile closed this Jun 19, 2023

s-puig mentioned this pull request Oct 12, 2023

Texture atlas rework #10099

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/UI texture atlas #5070

Feat/UI texture atlas #5070

ManevilleF commented Jun 22, 2022 •

edited

Loading

alice-i-cecile left a comment

ManevilleF commented Jun 22, 2022 •

edited

Loading

alice-i-cecile left a comment •

edited

Loading

ManevilleF commented Jun 22, 2022

alice-i-cecile commented Jun 27, 2022

ManevilleF commented Jun 28, 2022

alice-i-cecile commented Sep 30, 2022

rparrett commented Jan 31, 2023

lewiszlw commented Feb 28, 2023

nicoburns commented Jun 19, 2023

alice-i-cecile commented Jun 19, 2023

Feat/UI texture atlas #5070

Feat/UI texture atlas #5070

Conversation

ManevilleF commented Jun 22, 2022 • edited Loading

Objective

Solution

Note

alice-i-cecile left a comment

Choose a reason for hiding this comment

ManevilleF commented Jun 22, 2022 • edited Loading

alice-i-cecile left a comment • edited Loading

Choose a reason for hiding this comment

ManevilleF commented Jun 22, 2022

alice-i-cecile commented Jun 27, 2022

ManevilleF commented Jun 28, 2022

alice-i-cecile commented Sep 30, 2022

rparrett commented Jan 31, 2023

lewiszlw commented Feb 28, 2023

nicoburns commented Jun 19, 2023

alice-i-cecile commented Jun 19, 2023

ManevilleF commented Jun 22, 2022 •

edited

Loading

ManevilleF commented Jun 22, 2022 •

edited

Loading

alice-i-cecile left a comment •

edited

Loading