Struct cpclib::ga::Palette

pub struct Palette { /* fields omitted */ }

The palette maps one Ink for each Pen

Methods

impl Palette

pub fn new() -> Palette

Create a new palette. All pens are black.

pub fn empty() -> Palette

Create an empty Palette. An empty palette does not contains all the inks and must make crash most of the code that has been previously written !

pub fn contains_pen(&self, pen: &Pen) -> bool

Verifies if the palette contains the required pen

pub fn contains_border(&self) -> bool

pub fn next_unused_pen(&self) -> Option<Pen>

Provides the next unused pen if there is one

pub fn to_gate_array(&self) -> [u8; 17]

pub fn add_novel_inks_except_in_border(
    &mut self,
    inks: &[Ink]
) -> (usize, usize)

Add the inks if not present in empty slots of the palette as soon as it is possible. Returns the number of inks added a,d the number of inks impossible to add because of the lack of space.

pub fn inks_with_border(&self) -> Vec<Ink>

Returns the list of inks contained in the palette with the border

pub fn inks(&self) -> Vec<Ink>

Returns the list of inks contained in the palette without taking into account the border

pub fn pens_with_border(&self) -> Vec<Pen>

Returns all the set pens (without the border)

pub fn pens(&self) -> Vec<Pen>

Returns all the set pens (without the border)

pub fn get(&self, pen: &Pen) -> &Ink

Get the ink of the requested pen. Pen MUST be present

pub fn get_border(&self) -> &Ink

pub fn set(&mut self, pen: &Pen, ink: Ink)

Change the ink of the specified pen

pub fn set_border(&mut self, ink: Ink)

pub fn get_pen_for_ink(&self, expected: &Ink) -> Option<Pen>

Get the pen that corresponds to the required ink. Ink 16 (border) is never tested

pub fn contains_ink(&self, expected: &Ink) -> bool

Returns true if the palette contains the inks in one of its pens (except border)

pub fn to_mode3_mixed_with_mode0(&self) -> Palette

Replicate the firsts 4 pens in order to manage special texture that contains both mode 0 and mode 3 patterns

Trait Implementations

impl Default for Palette

fn default() -> Palette

Create a new palette. Pens ink are the same than Amsdos ones.

impl Clone for Palette

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> From<Vec<T>> for Palette where
    Ink: From<T>,
    T: Copy, 

fn from(items: Vec<T>) -> Self

Performs the conversion.

impl<'_> Into<Vec<u8>> for &'_ Palette

fn into(self) -> Vec<u8>

Performs the conversion.

impl Into<Vec<u8>> for Palette

fn into(self) -> Vec<u8>

Performs the conversion.

impl Debug for Palette

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

Formats the value using the given formatter.

impl Serialize for Palette

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Palette

fn deserialize<D: Deserializer<'de>>(
    deserializer: D
) -> Result<Palette, D::Error>

Deserialize this value from the given Serde deserializer.