Docs

Author: ManevilleF

crates/bevy_sprite/src/bundle.rs

@@ -30,11 +30,14 @@ impl Default for SpriteBundle {
 }
 
 /// A Bundle of components for drawing a single sprite from a sprite sheet (also referred
-/// to as a `TextureAtlas`)
+/// to as a `TextureAtlas`) or for animated sprites.
+///
+/// Note:
+/// This bundle is identical to [`SpriteBundle`] with an additional [`SpriteSheet`] component.
 #[derive(Bundle, Clone, Default)]
 pub struct SpriteSheetBundle {
     pub sprite: Sprite,
-    /// The sprite sheet main texture
+    /// The sprite sheet base texture
     pub texture: Handle<Image>,
     /// The sprite sheet texture atlas and the section to draw
     pub sheet: SpriteSheet,

crates/bevy_sprite/src/sprite.rs

@@ -22,7 +22,15 @@ pub struct Sprite {
 }
 
 /// Component for sprite sheets containing a handle to [`TextureAtlas`] and the index of the current
-/// section of the sheet
+/// section of the sheet.
+///
+/// A texture atlas contains various *sections* or *cuts* of a given texture, allowing to have a single
+/// image file for sprite animation or various elements.
+/// You can change the [`index`](Self::index) of the sheet to animate the sprite or to pick a *section* of the texture.
+///
+/// You may check the following examples for usage:
+/// - [`animated sprite sheet example`](https://github.com/bevyengine/bevy/blob/main/examples/2d/sprite_sheet.rs)
+/// - [`texture atlas example`](https://github.com/bevyengine/bevy/blob/main/examples/2d/texture_atlas.rs)
 #[derive(Component, Default, Debug, Clone, Reflect)]
 pub struct SpriteSheet {
     /// Texture atlas handle