Struct Sprite 

pub struct Sprite {

    pub texture: Arc<Texture>,
    pub x: f32,
    pub y: f32,
    pub z: f32,
    pub width: f32,
    pub height: f32,
    pub src_x: f32,
    pub src_y: f32,
    pub src_w: f32,
    pub src_h: f32,
    pub tint: Color,
    pub highlight: Color,
    pub transform: Mat4,
}

Fields

texture: Arc<Texture>

x: f32

y: f32

z: f32

width: f32

height: f32

src_x: f32

src_y: f32

src_w: f32

src_h: f32

tint: Color

highlight: Color

RGBA overlay blended over the shaded sprite (mix(shaded, highlight.rgb, highlight.a)), applied on top of tint’s multiplicative recolor rather than replacing it. Alpha 0 (the default) means no highlight. Intended for editor-style hover/selection feedback; only consumed by Sprite::draw_world — screen-space Sprite::draw ignores it.

transform: Mat4

Model matrix applied to the quad in the sprite’s local space, where the origin is the quad’s anchor corner and the quad spans (0, 0)..(width, height). The transformed quad is then positioned at (x, y, z), so translation here is relative to that position.

Defaults to glam::Mat4::IDENTITY. Prefer building it up through the Transformable methods, which rotate and scale around the sprite’s center.

Implementations

impl Sprite

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

pub fn draw(&self, pass: &mut DrawPass<'_>)

Draws the sprite in screen space (pixel coordinates), ignoring the camera. Use for UI/HUD elements.

pub fn fit_within_unit_square(&mut self)

Rescales width/height (preserving aspect ratio) so the sprite fits within a 1×1 unit square in world space, without ever upscaling past its current size. Sprite::new sizes the quad to the texture’s native pixel dimensions, which is normally far too large as a world-unit size — call this right after construction when the caller has no better size of its own to apply (e.g. attaching a sprite with no explicit width/height).

pub fn draw_world(&self, pass: &mut DrawPass<'_>)

Draws the sprite as a quad in world space, transformed by the camera.

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 Transformable for Sprite

Rotations and scales pivot around the middle of the sprite’s quad, so a sprite spins in place rather than swinging around its anchor corner.

sprite.reset_transform().rotate(angle).scale_uniform(2.0);

fn transform(&self) -> Mat4

The current model matrix.

fn transform_mut(&mut self) -> &mut Mat4

Mutable access to the model matrix.

fn pivot(&self) -> Vec3

Local-space point that rotations and scales turn around. Defaults to the local origin.

fn set_transform(&mut self, transform: Mat4) -> &mut Self

where Self: Sized,

Replaces the model matrix outright, discarding any accumulated transforms.

fn reset_transform(&mut self) -> &mut Self

where Self: Sized,

Clears the model matrix back to the identity.

fn apply(&mut self, transform: Mat4) -> &mut Self

where Self: Sized,

Composes transform onto the current matrix, about the local origin.

fn apply_about_pivot(&mut self, transform: Mat4) -> &mut Self

where Self: Sized,

Composes transform onto the current matrix, about Transformable::pivot.

fn translate(&mut self, x: f32, y: f32) -> &mut Self

where Self: Sized,

Moves along the local X and Y axes.

fn translate3(&mut self, offset: Vec3) -> &mut Self

where Self: Sized,

Moves by offset in local space.

fn rotate(&mut self, radians: f32) -> &mut Self

where Self: Sized,

Rotates around the Z axis — the in-plane spin for 2D content.

fn rotate_degrees(&mut self, degrees: f32) -> &mut Self

where Self: Sized,

Transformable::rotate, taking degrees.

fn rotate_x(&mut self, radians: f32) -> &mut Self

where Self: Sized,

Rotates around the X axis.

fn rotate_y(&mut self, radians: f32) -> &mut Self

where Self: Sized,

Rotates around the Y axis.

fn rotate_z(&mut self, radians: f32) -> &mut Self

where Self: Sized,

Rotates around the Z axis.

fn rotate_quat(&mut self, rotation: Quat) -> &mut Self

where Self: Sized,

Applies an arbitrary rotation.

fn scale(&mut self, x: f32, y: f32) -> &mut Self

where Self: Sized,

Scales the X and Y axes independently.

fn scale_uniform(&mut self, factor: f32) -> &mut Self

where Self: Sized,

Scales every axis by the same factor.

fn scale3(&mut self, scale: Vec3) -> &mut Self

where Self: Sized,

Scales by scale in local space.

fn flip_x(&mut self) -> &mut Self

where Self: Sized,

Mirrors across the pivot’s vertical axis.

fn flip_y(&mut self) -> &mut Self

where Self: Sized,

Mirrors across the pivot’s horizontal axis.