Open-Source Wikis

/

Bevy

/

Packages

/

bevy_sprite

bevyengine/bevy

bevy_sprite

2D sprite components. Data-only sister crate to bevy_sprite_render.

Purpose

Splitting sprite data from the renderer follows the same pattern as bevy_camera / bevy_render. The data crate hosts:

  • Sprite — color, custom size, slice, tile rect, anchor, flip flags.
  • Anchor — sprite pivot point.
  • TextureAtlas — atlas-driven sprites.
  • Slice / nine-patch support.

Directory layout

crates/bevy_sprite/src/
├── lib.rs              # SpritePlugin
├── sprite.rs           # Sprite component
├── texture_slice.rs    # Slice / tile / nine-patch
├── slice.rs            # SliceImage helpers
├── prelude.rs
└── …

Key abstractions

Type File Description
Sprite crates/bevy_sprite/src/sprite.rs Component: image handle, color, custom size, anchor, flip.
Anchor crates/bevy_sprite/src/sprite.rs Pivot point (Center, TopLeft, etc.).
TextureAtlas crates/bevy_sprite/src/sprite.rs Component pairing a sprite with an atlas index.
ImageScaleMode crates/bevy_sprite/src/texture_slice.rs Stretched / sliced / tiled.

Integration points

  • Depends on: bevy_app, bevy_ecs, bevy_math, bevy_color, bevy_image, bevy_camera, bevy_transform, bevy_picking (optional).
  • Depended on by: bevy_sprite_render, bevy_ui (uses the same image-slice machinery).

Entry points for modification

  • New sprite property: add a field to Sprite. Update extraction in bevy_sprite_render.
  • Custom anchor: anchor is an enum; add a variant.
  • Slice algorithm changes: texture_slice.rs.

See also

Built by Factory AutoWiki from public repository content. It is a generated preview for codebase exploration, not source-maintained documentation.

bevy_sprite – Bevy wiki | Factory