Struct elma_lgr::Lgr

pub struct Lgr {
    pub images: BTreeMap<String, Image>,
    pub palette: Vec<u8>,
}

Content of an LGR file.

Fields

images: BTreeMap<String, Image>

All images contained in this LGR. Names include .pcx extension.

palette: Vec<u8>

Palette contains 256-colors, format is R0, G0, B0, R1, G1, B1, ...

Methods

impl Lgr

fn get_palette_color(&self, i: u8) -> (u8, u8, u8)

Get color from LGR palette. There are 256 colors in the palette.

Returns triple (R, G, B).

fn load_from_file<P: AsRef<Path>>(
    path: P,
    load_pixels: bool,
    load_raw_pcx: bool
) -> Result<Self>

Read LGR from file.

Arguments:

• load_pixels - load pixels from PCX images and store them into Image::pixels.
• load_raw_pcx - load raw byte content of PCX images into Image::pcx.

If you are going to use LGR for rendering then set load_pixels to true and load_raw_pcx to false. If you wat to extract files from LGR then set load_pixels to false and load_raw_pcx to true.

fn load_from_stream<R: Read>(
    stream: &mut R,
    load_pixels: bool,
    load_raw_pcx: bool
) -> Result<Self>

Read LGR from stream.

See description of load_from_file for more info.

Trait Implementations

impl Debug for Lgr

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

Formats the value using the given formatter.

impl Clone for Lgr

fn clone(&self) -> Lgr

Returns a copy of the value.

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

Performs copy-assignment from source.