Struct pix::Raster

pub struct Raster<F: PixFmt> { /* fields omitted */ }

A 2D raster image.

Example

use pix::{Alpha, Cu8, Raster, Rgba};
let mut raster: Raster<Rgba<Cu8>> = Raster::new(10, 10);
let mut matte: Raster<Alpha<Cu8>> = Raster::new(10, 10);
let rgba = Rgba::new(128, 208, 208, 200);
matte.set_pixel(2, 4, Alpha::new(255));
matte.set_pixel(2, 5, Alpha::new(128));
raster.mask_over(&matte, 0, 0, rgba);
let p = raster.as_u8_slice();
// work with pixel data...

Methods

impl<F: PixFmt> Raster<F>

pub fn new(width: u32, height: u32) -> Raster<F>

Create a new raster image.

• F Pixel format.
• width Width in pixels.
• height Height in pixels.

pub fn with_pixels<T: Into<Box<[F]>>>(
    width: u32,
    height: u32,
    pixels: T
) -> Raster<F>

Create a new raster image with owned pixel data. You can get ownership of the pixel data back from the Raster as either a Vec<F> or a Box<[F]> by calling into().

• F Pixel format.
• width Width in pixels.
• height Height in pixels.
• pixels Pixel data.

Panics

Panics if pixels length is not equal to width * height.

pub fn width(&self) -> u32

Get raster width.

pub fn height(&self) -> u32

Get raster height.

pub fn pixel(&self, x: u32, y: u32) -> F

Get one pixel value.

pub fn set_pixel(&mut self, x: u32, y: u32, p: F)

Set one pixel value.

pub fn as_slice(&self) -> &[F]

Get the pixels as a slice.

pub fn as_slice_mut(&mut self) -> &mut [F]

Get the pixels as a mutable slice.

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

Get the pixels as a u8 slice.

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

Get the pixels as a mutable u8 slice.

pub fn clear(&mut self)

Clear all pixels.

pub fn set_rect(&mut self, x: u32, y: u32, w: u32, h: u32, clr: F)

Set a rectangle to specified color.

• x Left position of rectangle.
• y Top position of rectangle.
• w Width of rectangle.
• h Height of rectangle.
• clr Color to set.

pub fn mask_over(&mut self, mask: &Raster<Alpha<Cu8>>, x: i32, y: i32, clr: F)

Blend pixels with an alpha mask.

• mask Alpha mask for compositing.
• x Left position of alpha mask.
• y Top position of alpha mask.
• clr Color to composite.

Trait Implementations

impl<F: PixFmt> Into<Box<[F]>> for Raster<F>

fn into(self) -> Box<[F]>

Get internal pixel data as boxed slice.

impl<F: PixFmt> Into<Vec<F>> for Raster<F>

fn into(self) -> Vec<F>

Get internal pixel data as Vec of pixels.

impl<F: Clone + PixFmt> Clone for Raster<F>

fn clone(&self) -> Raster<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + PixFmt> Debug for Raster<F>

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

Formats the value using the given formatter.