Struct Sprite 

pub struct Sprite {
    pub image: ImageId,
    pub src: PxRect,
    pub dest: PxRect,
    pub clip: PxRect,
    pub layer: Layer,
    pub flip_x: bool,
    pub opacity: u8,
    pub brightness: u8,
    pub paint: Paint,
    pub base: Option<PxRect>,
}

A picture on top of the cell grid (game ADR-0038): part of an image file, scaled into a rectangle of console pixels. app draws it from a texture with nearest-pixel sampling, so whole-number scales stay sharp.

Fields

image: ImageId

Which image (ImageTable::id).

src: PxRect

The part of the image shown, in image pixels. It must lie inside the image.

dest: PxRect

Where src is stretched to, in console pixels.

clip: PxRect

The part of dest that is drawn. Clipping and cutting only ever shrink this; src and dest stay as given, so the picture never shifts or rescales.

layer: Layer

Under or over the glyphs.

flip_x: bool

Mirrored left to right within dest.

opacity: u8

255 = solid; lower lets what is under it show through.

brightness: u8

How bright its pixels are drawn: 255 = as the image and the paint have them, lower = that much darker, 0 = black where it shows. Unlike a lower opacity, a picture over another (a tile’s edge over its ground) darkens as much as one alone (GlyphBuffer::fade).

paint: Paint

How its pixels are coloured.

base: Option<PxRect>

The console pixels it stands on, for a picture that reaches above them (a unit’s head over the tile above its own): where cells replace its base up to one of the base’s edges, what it shows past that edge goes too, so a menu over a unit doesn’t leave its head showing above the menu.

Implementations

impl Sprite

pub const fn new( image: ImageId, src: PxRect, dest: PxRect, layer: Layer, ) -> Self

A solid, unflipped sprite showing all of dest.

pub const fn painted(self, paint: Paint) -> Self

This sprite coloured as paint.

pub fn clipped_src(&self) -> [f32; 4]

The part of src that maps to clip, as [x, y, w, h] in image pixels (fractions of a pixel when clip cuts through a scaled one). With flip_x, the left of clip shows the right of src.

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

impl Debug for Sprite

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

Formats the value using the given formatter.

impl Eq for Sprite

impl Hash for Sprite

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Sprite

fn eq(&self, other: &Sprite) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Sprite