Struct pix_engine::image::Image

pub struct Image { /* fields omitted */ }

An Image representing a buffer of pixel color values.

Implementations

impl Image

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

Constructs an empty RGBA Image with given width and height. Alias for Image::with_rgba.

pub fn with_rgba(width: u32, height: u32) -> Self

Constructs an empty RGBA Image with given width and height.

pub fn with_rgb(width: u32, height: u32) -> Self

Constructs an empty RGB Image with given width and height.

pub fn from_bytes<B: AsRef<[u8]>>(
    width: u32,
    height: u32,
    bytes: B,
    format: PixelFormat
) -> Result<Self>

Constructs an Image from a u8 slice representing RGB/A values.

pub fn from_pixels<P: AsRef<[Color]>>(
    width: u32,
    height: u32,
    pixels: P,
    format: PixelFormat
) -> Result<Self>

Constructs an Image from a Color slice representing RGBA values.

pub fn from_vec(
    width: u32,
    height: u32,
    data: Vec<u8>,
    format: PixelFormat
) -> Self

Constructs an Image from a Vec representing RGB/A values.

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Constructs an Image from a png file.

pub fn width(&self) -> u32

Returns the Image width.

pub fn height(&self) -> u32

Returns the Image height.

pub fn dimensions(&self) -> (u32, u32)

Returns the Image dimensions as (width, height).

pub fn center(&self) -> PointI2

Returns the center position as Point.

pub fn bytes(&self) -> Bytes<'_>

Returns the Image pixel data as an iterator of u8.

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

Returns the Image pixel data as a u8 slice.

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

Returns the Image pixel data as a mutable u8 slice.

pub fn into_bytes(self) -> Vec<u8>

Returns the Image pixel data as a Vec<u8>.

This consumes the Image, so we do not need to copy its contents.

pub fn pixels(&self) -> Pixels<'_>

Returns the Image pixel data as an iterator of Colors.

pub fn into_pixels(self) -> Vec<Color>

Returns the Image pixel data as a Vec<Color>.

pub fn get_pixel(&self, x: u32, y: u32) -> Color

Returns the color value at the given (x, y) position.

pub fn set_pixel<C: Into<Color>>(&mut self, x: u32, y: u32, color: C)

Sets the color value at the given (x, y) position.

pub fn update_bytes<B: AsRef<[u8]>>(&mut self, bytes: B)

Update the Image with a u8 slice representing RGB/A values.

pub fn format(&self) -> PixelFormat

Returns the Image pixel format.

pub fn save<P>(&self, path: P) -> PixResult<()> where
    P: AsRef<Path>, 

Save the Image to a png file.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy 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 Default for Image

fn default() -> Image

Returns the “default value” for a type.