Struct Image 

pub struct Image {
    pub width: usize,
    pub height: usize,
    /* private fields */
}

A row-major RGB image stored in memory.

Fields

width: usize

Width of the image in pixels.

height: usize

Height of the image in pixels.

Implementations

impl Image

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

Creates a new image filled with a black pixel color.

pub fn new_black(width: usize, height: usize) -> Self

Creates a new image filled with black.

pub fn new_white(width: usize, height: usize) -> Self

Creates a new image filled with white.

pub fn from_color(width: usize, height: usize, color: Pixel) -> Self

Creates an image filled with a single color.

pub fn from_pixels(width: usize, height: usize, pixels: Vec<Pixel>) -> Self

Creates an image from a flat pixel buffer.

pub fn from_pixel_fn( width: usize, height: usize, pixel_fn: impl FnMut(usize, usize) -> Pixel, ) -> Self

Builds an image by evaluating a callback for every (x, y) pixel coordinate.

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Opens an image from the given path using the binary P6 PPM format.

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

Saves the image to the given path as a binary P6 PPM file.

pub fn from_file(filename: &str) -> Result<Self>

Loads an image from a file using the file name string.

pub fn to_file(&self, filename: &str) -> Result<()>

Saves this image to a file using the file name string.

pub fn from_image(image: &Self) -> Self

Clones an image from an existing one.

pub fn pixels(&self) -> &[Pixel]

Returns the backing pixel storage.

pub fn get_pixel(&self, x: usize, y: usize) -> Option<&Pixel>

Reads a pixel from the image at (x, y).

pub fn set_pixel(&mut self, x: usize, y: usize, pixel: Pixel)

Sets a pixel in the image at (x, y).

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl Eq for Image

impl PartialEq for Image

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Image