Struct cpclib::image::Sprite

pub struct Sprite { /* private fields */ }

A Sprite corresponds to a set of bytes encoded to the right CPC pixel format for a given palette. TODO Check why mode nad palette are optionnals. Force them if it is not mandatory to have htem optionnal

Implementations

impl Sprite

pub fn to_color_matrix(&self) -> Option<ColorMatrix>

TODO Use TryFrom once in standard rust The conversion can only work if a palette and a mode is provided

pub fn to_linear_vec(&self) -> Vec<u8>

Produce a linearized version of the sprite.

pub fn palette(&self) -> Option<Palette>

Get the palette of the sprite

pub fn set_palette(&mut self, palette: Palette)

pub fn bytes(&self) -> &Vec<Vec<u8>>

pub fn mode(&self) -> Option<Mode>

Get hte sprite Mode Cannot manage multimode sprites of course

pub fn height(&self) -> u32

Get the height (in pixels) of the image TODO Use a trait for that

pub fn byte_width(&self) -> u32

Get the width (in bytes) of the image TODO Use a trait for that

pub fn pixel_width(&self) -> u32

Get the width in pixels of the image. The mode must be specified

pub fn get_byte(&self, x: usize, y: usize) -> u8

Returns the byte at the right position and crash if it does not exists

pub fn get_byte_safe(&self, x: usize, y: usize) -> Option<u8>

Returns the byte at the right position if exists

pub fn get_line(&self, y: usize) -> &Vec<u8>

Returns the line of interest

pub fn convert(
    img: &ImageBuffer<Rgb<u8>, Vec<u8>>,
    mode: Mode,
    conversion: ConversionRule,
    palette: Option<Palette>
) -> Sprite

Convert an RGB image to a sprite that code the pixels XXX Since 2018-06-16, most of code is delagated to ColorMatrix => maybe some bugs has been added

pub fn convert_from_fname(
    fname: &str,
    mode: Mode,
    conversion: ConversionRule,
    palette: Option<Palette>
) -> Result<Sprite, ImageError>

pub fn horizontal_transform<F>(&mut self, f: F)where
    F: Fn(&Vec<u8>) -> Vec<u8>,

Apply a transformation function on each line It can change there size