Struct Painted 

#[non_exhaustive]
pub struct Painted { /* private fields */ }

A picture a skin paints at run time (ADR-0078). Its fields keep their sizes, so they are read and written through methods; the ones that write move its revision.

Implementations

impl Painted

pub fn rgba(width: u16, height: u16) -> Self

An RGBA picture width × height, every pixel clear.

pub fn indexed(width: u16, height: u16, palette: &[Rgb]) -> Self

An indexed picture width × height, every pixel index 0, its palette the first PALETTE_LEN colours of palette and black for the rest.

pub fn one_bit(width: u16, height: u16) -> Self

A one-bit picture width × height, every pixel black, without a mask (every pixel drawn).

pub fn with_mask(self) -> Self

The same one-bit picture with a mask, every pixel drawn; any other picture as it is.

pub const fn size(&self) -> (u16, u16)

Its width and height in pixels.

pub const fn kind(&self) -> PaintedKind

What its bytes are.

pub const fn stride(&self) -> usize

Bytes per row of its pixels (and mask).

pub const fn revision(&self) -> u32

How many times its pixels, palette or mask were borrowed for writing, wrapping: a picture whose revision didn’t move since a frame is that frame’s.

pub fn pixels(&self) -> &[u8]

Its bytes, as its kind says.

pub fn pixels_mut(&mut self) -> &mut [u8]

Its bytes to write; moves the revision.

pub fn palette(&self) -> &[Rgb]

An indexed picture’s PALETTE_LEN colours; none for another.

pub fn palette_mut(&mut self) -> &mut [Rgb]

An indexed picture’s colours to write (none for another); moves the revision.

pub fn mask(&self) -> Option<&[u8]>

A one-bit picture’s mask, a set bit drawn, if it has one.

pub fn mask_mut(&mut self) -> Option<&mut [u8]>

The mask to write, if it has one; then moves the revision.

pub fn rgba_at(&self, x: u16, y: u16) -> [u8; 4]

Pixel (x, y), which must lie in the picture, as RGBA8: an indexed one’s colour, opaque; a one-bit one white or black, clear where the mask leaves it out.

pub fn rgba_into(&self, out: &mut Vec<u8>)

Writes the whole picture as RGBA8, row after row, into out (its old bytes gone): each pixel as rgba_at has it. What a painter that draws RGBA uploads.

pub fn fingerprint(&self) -> u64

The FNV hash (shuyi_assets::fnv) of its size, kind, pixels, palette and mask, not its revision: what a snapshot shows of it.

Trait Implementations

impl Clone for Painted

fn clone(&self) -> Painted

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Painted

Its size, kind, revision and fingerprint: its pixels would bury a failed test’s message.

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

Formats the value using the given formatter.

impl Eq for Painted

impl PartialEq for Painted

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Painted