Struct rltk::XpFile

pub struct XpFile {
    pub version: i32,
    pub layers: Vec<XpLayer>,
}

Structure representing a REXPaint image file which is a stack of layers

Fields

version: i32

Version number from header

layers: Vec<XpLayer>

Layers of the image

Methods

impl XpFile

pub fn new(width: usize, height: usize) -> XpFile

Construct a new XpFile with one layer of width by height. The contents will be empty (black foreground and background, character 0).

pub fn from_resource(path: &str) -> Result<XpFile, Error>

Helper to read from an BTerm resource

pub fn read<R>(f: &mut R) -> Result<XpFile, Error> where
    R: Read, 

Read a xp image from a stream

pub fn write<W>(&self, f: &mut W) -> Result<(), Error> where
    W: Write, 

Write a xp image to a stream

Trait Implementations

impl Clone for XpFile

fn clone(&self) -> XpFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XpFile

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

Formats the value using the given formatter.

impl PartialEq<XpFile> for XpFile

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for XpFile