Struct openpol::image13h::Image13h

pub struct Image13h { /* fields omitted */ }

Methods

impl Image13h

pub fn width(&self) -> usize

Get the width of the image

pub fn height(&self) -> usize

Get the height of the image.

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

Get a reference to a slice containing the image data. The data is stored row by row.

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

Like data, but mutable.

pub fn line(&self, line: usize) -> &[u8]

Get the image contents of a particular line as a byte slice. line is 0-based. Since the data is stored line-by-line internally it's more optimal that way. If you want to access particular pixel just index into the slice.

pub fn mut_line(&mut self, line: usize) -> &mut [u8]

Mutable variant of line().

pub fn load<T: Read>(reader: T) -> Option<Image13h>

Load an image from a reader. Extra content after the expected data is ignored.

Errors

The method will return None if there's something wrong with the contents:

• width or height equal 0
• not enough bytes when reading

pub fn empty(width: usize, height: usize) -> Image13h

Create an empty image with the specified dimensions. Empty means the image is filled with color 0.

pub fn empty_screen_sized() -> Image13h

Create an empty, screen-sized Image13h.

pub fn filled_with_color(width: usize, height: usize, color: u8) -> Image13h

Create an image filled with desired color.

pub fn save<T: Write>(&self, writer: T)

Save the image to a writer. Write errors will result in a panic.

pub fn subimage(&self, rect: &Rect) -> Image13h

Extract a rect-bound subimage from the image.

pub fn blit(&mut self, image: &Image13h, rect: &Rect)

Blit another image into a rect in this image. The width and height of image and rect need to be the same.

pub fn blit_whole(&mut self, image: &Image13h, x: usize, y: usize)

Blit whole aother image into this image. The width and height of the other image needs to be at most the width and height of this image.

pub fn fill(&mut self, color: u8)

Fill the image with a color.

Trait Implementations

impl Clone for Image13h

fn clone(&self) -> Image13h

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Image13h

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

Formats the value using the given formatter.

impl Eq for Image13h

impl PartialEq<Image13h> for Image13h

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

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

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

This method tests for !=.

impl StructuralEq for Image13h

impl StructuralPartialEq for Image13h