Struct frenderer::sprites::SheetRegion

#[repr(C)]
pub struct SheetRegion {
    pub sheet: u16,
    pub depth: u16,
    pub x: u16,
    pub y: u16,
    pub w: i16,
    pub h: i16,
    pub colormod: [u8; 4],
}

A SheetRegion defines the visual appearance of a sprite: which spritesheet (of an array of spritesheets), its pixel region within the spritesheet, and its visual depth (larger meaning further away).

Fields

sheet: u16

Which array texture layer to use

depth: u16

How deep into the Z axis this sprite should be drawn; the range 0..u16::MAX will be mapped onto 0.0..1.0.

x: u16

The x coordinate in pixels of the top left corner of this sprite within the spritesheet texture.

y: u16

The y coordinate in pixels of the top left corner of this sprite within the spritesheet texture.

w: i16

The width in pixels of this sprite within the spritesheet texture. May be negative.

h: i16

The height in pixels of this sprite within the spritesheet texture. May be negative.

colormod: [u8; 4]

RGBA bytes where alpha indicates intensity of color modulation

Implementations

impl SheetRegion

pub const ZERO: Self = _

pub const fn new(sheet: u16, x: u16, y: u16, depth: u16, w: i16, h: i16) -> Self

Create a new SheetRegion with the given parameters.

pub const fn rect(x: u16, y: u16, w: i16, h: i16) -> Self

Create a simple SheetRegion with just the rectangle coordinates (SheetRegion::sheet and SheetRegion::depth will be set to 0).

pub const fn with_sheet(self, which: u16) -> Self

Produce a new SheetRegion on a different spritesheet layer.

pub const fn with_depth(self, depth: u16) -> Self

Produce a new SheetRegion drawn at a different depth level.

pub const fn flip_horizontal(self) -> Self

Flips the texture horizontally by moving its position and inverting its width

pub const fn flip_vertical(self) -> Self

Flips the texture vertically by moving its position and inverting its height

pub const fn with_colormod(self, colormod: [u8; 4]) -> Self

Changes the color modulation of the sheet region

Trait Implementations

impl Clone for SheetRegion

fn clone(&self) -> SheetRegion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SheetRegion

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

Formats the value using the given formatter.

impl Default for SheetRegion

fn default() -> SheetRegion

Returns the “default value” for a type.

impl Zeroable for SheetRegion

fn zeroed() -> Self

Calls zeroed.

impl Copy for SheetRegion

impl Pod for SheetRegion