Struct Sprite 

pub struct Sprite {
    pub texture: Handle<Texture>,
    pub size: Option<Vec2>,
    pub color: Color,
    pub source_rect: Option<(Vec2, Vec2)>,
    pub origin: Option<Vec2>,
    pub layer: i32,
}

renderable 2D sprite component.

any entity carrying a Transform and a Sprite is drawn automatically each frame. game code spawns the entity and the engine’s render system enqueues the draw — no manual RenderQueue calls.

example

use lunar::prelude::*;

fn spawn_player(mut commands: Commands, mut assets: ResMut<AssetServer>) {
    let texture = assets.load_texture("player.png");
    commands.spawn((
        Transform::from_xy(100.0, 100.0),
        Sprite::new(texture).with_size(Vec2::new(32.0, 32.0)),
    ));
}

fields can be set directly or via the builder methods. when size is None, the sprite renders at the texture’s native pixel size if the texture is loaded; otherwise a 32×32 placeholder is used.

Fields

texture: Handle<Texture>

texture to draw

size: Option<Vec2>

rendered size in pixels. None = use the texture’s native size. the entity’s Transform::scale is applied on top of this.

color: Color

color tint multiplied with the texture (RGBA). default white = no tint.

source_rect: Option<(Vec2, Vec2)>

optional UV sub-rect for atlas sampling: (uv_min, uv_max) in 0..1 space.

origin: Option<Vec2>

pivot for rotation/scale, in pixels relative to the sprite’s top-left. None = sprite center (size / 2).

layer: i32

render layer (lower = behind, higher = in front). see layers.

Implementations

impl Sprite

pub const fn new(texture: Handle<Texture>) -> Self

create a sprite with default settings (white tint, native size, centered, GAME layer)

pub const fn with_size(self, size: Vec2) -> Self

set explicit pixel size (overrides texture’s native size)

pub const fn with_color(self, color: Color) -> Self

set color tint

pub const fn with_layer(self, layer: i32) -> Self

set the render layer

pub const fn with_source_rect(self, uv_min: Vec2, uv_max: Vec2) -> Self

set the UV sub-rect for atlas sampling

pub const fn with_origin(self, origin: Vec2) -> Self

set the origin (pivot point) in pixels relative to top-left

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for Sprite

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for Sprite

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.