Uncouple DynamicTextureAtlasBuilder from assets
#13717
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Remove the dependency of `DynamicTextureAtlasBuilder::add_texture` to `bevy_asset`, by directly passing the `Image` of the atlas to mutate, instead of passing separate `Assets<Image>` and `Handle<Image>` for the function to do the lookup by itself. The lookup can be done from the caller, and this allows using the builder in contexts where the `Image` is not stored inside `Assets`. Clean-up a bit the font atlas files by introducing a `PlacedGlyph` type storing the `GlyphId` and its `SubpixelOffset`, which were otherwise always both passed as function parameters and the pair used as key in hash maps.
djeedai
added
D-Trivial
|
@brandon-reinhart I'd appreciate your opinions here. |
alice-i-cecile
added
M-Needs-Migration-Guide
rparrett
approved these changes
Jun 8, 2024
alice-i-cecile
approved these changes
Jun 8, 2024
alice-i-cecile
added
the
S-Ready-For-Final-Review
|
The |
|
I've updated the migration guide, but one or both of you may have suggestions on how to improve this. |
|
Migration guide looks good to me, thanks @alice-i-cecile! |
Merged
rparrett
added a commit
to rparrett/bevy
that referenced
this pull request
Jun 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Remove some unnecessary coupling between
DynamicTextureAtlasBuilderandbevy_asset.Solution
Remove the dependency of
DynamicTextureAtlasBuilder::add_texturetobevy_asset, by directly passing theImageof the atlas to mutate, instead of passing separateAssets<Image>andHandle<Image>for the function to do the lookup by itself. The lookup can be done from the caller, and this allows using the builder in contexts where theImageis not stored insideAssets.Clean-up a bit the font atlas files by introducing a
PlacedGlyphtype storing theGlyphIdand itsSubpixelOffset, which were otherwise always both passed as function parameters and the pair used as key in hash maps.Testing
There's no change in behavior.
Changelog
PlacedGlyphtype aggregating aGlyphIdand aSubpixelOffset. That type is now used as parameter in a few text atlas APIs, instead of passing individual values.Migration Guide
glyph_idandsubpixel_offsetof a few text atlas APIs by a singleplace_glyph: PlacedGlyphparameter trivially combining the two.DynamicTextureAtlasBuilder::add_texturenow takes a&mut Image, rather than aHandle<Image>. To access this, fetch the underlying image usingAssets<Image>::get_mut.