[KirmesBude]

Objective

Migrate bevy_sprite Sprite to required components.
Alternative to #15489
It does not use any of the proposals from here so feel free to disregard this PR.

Solution

• Sprite renamed to SpriteProperties
• Introduce new wrapper component Sprite (contains Handle), that requires SpriteProperties, Transform, Visibility and SyncToRenderWorld
• Sprite specific usage of Handle replaced with Sprite

Previously:

commands.spawn(SpriteBundle {
    texture: textures.add(Image::default()),
    sprite: Sprite {
        color: Color::srgb(7.5, 0.0, 7.5),
       ..default()
    },
    transform: Transform::from_translation(Vec3::new(-200., 0., 0.)),
    ..default()
});

Now:

commands.spawn((
    Sprite(textures.add(Image::default())),
    SpriteProperties {
        color: Color::srgb(7.5, 0.0, 7.5),
       ..default()
    },
    Transform::from_translation(Vec3::new(-200., 0., 0.)),
});

Maybe SpriteProperties should just be part of Sprite, not sure. I am open to changing that. Having a dedicated wrapper component for an asset is nice though, e.g. for change detection.
I did not touch TextureAtlas, but I can see the motivation for that in the context of editor usability/suggestion - I just do not think required components are the right tool for that.

Testing

I ran all tests that I modified and everything seemed to work, but I did not compare to main.
bevy_sprite tests were also run and passed.

---

Migration Guide

Asset handles for sprite images must now be wrapped in the Sprite component. Raw handles as components no longer render sprites. The component previously known as Sprite is now called SpriteProperties.

As a result SpriteBundle has been deprecated. Instead, use the Sprite components directly.

commands.spawn(SpriteBundle {
    texture: textures.add(Image::default()),
    sprite: Sprite {
        color: Color::srgb(7.5, 0.0, 7.5),
       ..default()
    },
    transform: Transform::from_translation(Vec3::new(-200., 0., 0.)),
    ..default()
});

Now:

commands.spawn((
    Sprite(textures.add(Image::default())),
    SpriteProperties {
        color: Color::srgb(7.5, 0.0, 7.5),
       ..default()
    },
    Transform::from_translation(Vec3::new(-200., 0., 0.)),
});

If you have any queries for sprites using Handle make sure to change them to Sprite.

[KirmesBude]

Not sure how to handle this generically now.

[KirmesBude]

I added Handle<A>: Into<C> trait bounds. That means C needs to implement From<Handle<A>, which is true for Sprite.
May not be the best solution.

[alice-i-cecile]

I have a mild preference for this design. It's more flexible and the migration is easier. Either one is fine by me though.

[wilk10]

Thanks for working on this.

I very much prefer this implementation to the alternative PR.

I know that there's no promise of stability but at least reducing churn for users when upgrading is an important factor to consider in this case, in my opinion.

I particularly like that it keeps Sprite and TextureAtlas separate, like it was discussed at length, approved and merged with #5103 , whereas the blessed PR kinda reverts that change.

I'll try to argue my case on Discord, I guess.

Edit: Discussion on Discord

[cart]

Responded with thoughts here: #15489 (comment)
(please discuss there)

[alice-i-cecile]

Merging #15489 instead, per the discussion linked just above :)