Struct pix::Raster

source · [−]

pub struct Raster<P: Pixel> { /* private fields */ }

Expand description

Image arranged as a rectangular array of pixels. Rows are ordered top to bottom, and pixels within rows are left to right.

A Raster can be constructed using one of the with_ methods:

with_clear
with_color
with_raster
with_pixels
with_u8_buffer
with_u16_buffer

Working with byte buffers

To allow interoperability with other crates, images can be created from byte buffers, and converted back again.

use pix::rgb::Rgba8;
use pix::Raster;

let buf = vec![0; 200 * 200 * std::mem::size_of::<Rgba8>()];
let mut raster = Raster::<Rgba8>::with_u8_buffer(200, 200, buf);
// ... manipulate the image
let slice: Box<[u8]> = raster.into();
// A boxed slice can be turned back into Vec
let v: Vec<u8> = slice.into();

Implementations

source

impl<P: Pixel> Raster

source

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

Construct a Raster with all pixels set to the default value.

Panics

Panics if width or height is greater than std::i32::MAX.

Examples

use pix::gray::{SGray8, SGraya32};
use pix::matte::Matte8;
use pix::rgb::SRgb16;
use pix::Raster;

let r1 = Raster::<SGray8>::with_clear(20, 20);
let r2 = Raster::<Matte8>::with_clear(64, 64);
let r3 = Raster::<SRgb16>::with_clear(10, 10);
let r4 = Raster::<SGraya32>::with_clear(100, 250);

source

pub fn with_color(width: u32, height: u32, clr: P) -> Self

Construct a Raster with all pixels set to one color.

Panics

Panics if width or height is greater than std::i32::MAX.

Example

use pix::rgb::SRgb8;
use pix::Raster;

let clr = SRgb8::new(0x40, 0xAA, 0xBB);
let r = Raster::<SRgb8>::with_color(15, 15, clr);

source

pub fn with_raster<S>(src: &Raster<S>) -> Self where
S: Pixel,
P::Chan: From<S::Chan>,

Construct a Raster with another Raster.

The pixel format can be converted using this method.

S Pixel format of source Raster.

Convert from SRgb8 to Rgba16

use pix::rgb::{Rgba16, SRgb8};
use pix::Raster;

let mut r0 = Raster::<SRgb8>::with_clear(50, 50);
// load pixels into raster
let r1 = Raster::<Rgba16>::with_raster(&r0);

source

pub fn with_pixels(width: u32, height: u32, pixels: B) -> Self where
B: Into<Box<[P]>>,

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

B Owned pixed type (Vec or boxed slice).
width Width of Raster.
height Height of Raster.
pixels Pixel data.

Panics

If width or height is greater than std::i32::MAX
If pixels length is not equal to width * height

Example

use pix::ops::Src;
use pix::rgb::Rgb8;
use pix::Raster;

let p = vec![Rgb8::new(255, 0, 255); 16];  // vec of magenta pix
let mut r = Raster::with_pixels(4, 4, p);  // convert to raster
let clr = Rgb8::new(0x00, 0xFF, 0x00);     // green
r.copy_color((2, 0, 1, 3), clr);           // make stripe
let p2 = Into::<Vec<Rgb8>>::into(r);       // back to vec

source

pub fn with_u8_buffer(width: u32, height: u32, buffer: B) -> Self where
B: Into<Box<[u8 ]>>,
P: Pixel<Chan = Ch8>,

Construct a Raster from a u8 buffer.

B Owned pixed type (Vec or boxed slice).
width Width of Raster.
height Height of Raster.
buffer Buffer of pixel data.

Panics

If width or height is greater than std::i32::MAX
If buffer length is not equal to width * height * std::mem::size_of::()

source

pub fn with_u16_buffer(width: u32, height: u32, buffer: B) -> Self where
B: Into<Box<[u16 ]>>,
P: Pixel<Chan = Ch16>,

Construct a Raster from a u16 buffer.

B Owned pixed type (Vec or boxed slice).
width Width of Raster.
height Height of Raster.
buffer Buffer of pixel data (in native-endian byte order).

Panics

If width or height is greater than std::i32::MAX
If buffer length is not equal to width * height * std::mem::size_of::()

source

pub fn width(&self) -> u32

Get width of Raster.

source

pub fn height(&self) -> u32

Get height of Raster.

source

pub fn clear(&mut self)

Clear all pixels to default value.

source

pub fn pixel(&self, x: i32, y: i32) -> P

Get one pixel.

source

pub fn pixel_mut(&mut self, x: i32, y: i32) -> &mut P

Get a mutable pixel.

source

pub fn pixels(&self) -> &[P]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Get a slice of all pixels.

source

pub fn pixels_mut(&mut self) -> &mut [P]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Get a mutable slice of all pixels.

source

pub fn rows<R>(&self, reg: R) -> Rows<'_, P>ⓘNotable traits for Rows<'a, P>`impl<'a, P: Pixel> Iterator for Rows<'a, P> type Item = &'a [P];` where
R: Into<Region>,

Get an Iterator of rows within a Raster.

reg Region of the Raster to iterate.

source

pub fn rows_mut<R>(&mut self, reg: R) -> RowsMut<'_, P>ⓘNotable traits for RowsMut<'a, P>`impl<'a, P: Pixel> Iterator for RowsMut<'a, P> type Item = &'a mut [P];` where
R: Into<Region>,

Get an Iterator of mutable rows within a Raster.

reg Region of the Raster to iterate.

source

pub fn region(&self) -> Region

Get Region of entire Raster.

source

pub fn intersection<R>(&self, reg: R) -> Region where
R: Into<Region>,

Get intersection with a Region.

source

pub fn copy_color<R>(&mut self, reg: R, clr: P) where
R: Into<Region>,

Copy a color to a region of the Raster.

reg Region within self. It can be a Region struct, tuple of (x, y, width, height) or the unit type (). Using () has the same result as Raster::region().
clr Source Pixel color.

Copy a color to a rectangle region

use pix::rgb::SRgb8;
use pix::Raster;

let mut r = Raster::with_clear(100, 100);
let clr = SRgb8::new(0xDD, 0x96, 0x70);
r.copy_color((20, 40, 25, 50), clr);

source

pub fn copy_raster<R0, R1>(&mut self, to: R0, src: &Raster, from: R1) where
R0: Into<Region>,
R1: Into<Region>,

Copy from a source Raster.

to Region within self (destination).
src Source Raster.
from Region within source Raster.

to / from can be Region structs, tuples of (x, y, width, height) or the unit type (). Using () has the same result as Raster::region().

*------------+      *-------------+
|            |      |    *------+ |
| *------+   |      |    |      | |
| |      |   |      |    | from | |
| |  to  |   | <--- |    +------+ |
| +------+   |      |             |
|            |      |     src     |
|    self    |      +-------------+
+------------+

The copied Region is clamped to the smaller of to and from in both X and Y dimensions. Also, to and from are clipped to their respective Raster dimensions.

Copy part of one `Raster` to another

use pix::rgb::SRgb8;
use pix::Raster;

let mut r0 = Raster::with_clear(100, 100);
let r1 = Raster::with_color(5, 5, SRgb8::new(80, 0, 80));
// ... load image data
r0.copy_raster((40, 40, 5, 5), &r1, ());

source

pub fn as_u8_slice(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Get view of pixels as a u8 slice.

source

pub fn as_u8_slice_mut(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Get view of pixels as a mutable u8 slice.

source

impl Raster where
P: Pixel<Alpha = Premultiplied, Gamma = Linear>,

source

pub fn composite_color<R, O>(&mut self, reg: R, clr: P, op: O) where
R: Into<Region>,
O: Blend,

Composite a source color to a region of the Raster.

reg Region within self. It can be a Region struct, tuple of (x, y, width, height) or the unit type (). Using () has the same result as Raster::region().
clr Source Pixel color.
op Compositing operation.

Example

use pix::ops::SrcOver;
use pix::bgr::Bgra8p;
use pix::Raster;

let mut r = Raster::with_color(100, 100, Bgra8p::new(99, 0, 99, 255));
let clr = Bgra8p::new(200, 200, 0, 128);
r.composite_color((20, 40, 25, 50), clr, SrcOver);

source

pub fn composite_matte<R0, R1, M, O>(
 &mut self,
 to: R0,
 src: &Raster<M>,
 from: R1,
 clr: P,
 op: O
) where
 R0: Into<Region>,
 R1: Into<Region>,
 M: Pixel<Chan = P::Chan, Model = Matte, Gamma = P::Gamma>,
 O: Blend,

Composite from a matte Raster and color.

to Region within self (destination).
src Source Raster matte.
from Region within source Raster.
clr Color to apply to the matte.
op Compositing operation.

to / from can be Region structs, tuples of (x, y, width, height) or the unit type (). Using () has the same result as Raster::region().

Example

use pix::matte::Matte8;
use pix::ops::SrcOver;
use pix::rgb::Rgba8p;
use pix::Raster;

let mut r0 = Raster::with_clear(100, 100);
let r1 = Raster::with_color(10, 10, Matte8::new(37));
// ... load image data
let clr = Rgba8p::new(50, 100, 150, 200);
r0.composite_matte((30, 50, 10, 10), &r1, (), clr, SrcOver);

source

pub fn composite_raster<R0, R1, O>(
 &mut self,
 to: R0,
 src: &Raster,
 from: R1,
 op: O
) where
 R0: Into<Region>,
 R1: Into<Region>,
 O: Blend,

Composite from a source Raster.

to Region within self (destination).
src Source Raster.
from Region within source Raster.
op Compositing operation.

to / from can be Region structs, tuples of (x, y, width, height) or the unit type (). Using () has the same result as Raster::region().

*------------+      *-------------+
|            |      |    *------+ |
| *------+   |      |    |      | |
| |      |   |      |    | from | |
| |  to  |   | <--- |    +------+ |
| +------+   |      |             |
|            |      |     src     |
|    self    |      +-------------+
+------------+

The composited Region is clamped to the smaller of to and from in both X and Y dimensions. Also, to and from are clipped to their respective Raster dimensions.

Blend one `Raster` onto another

use pix::ops::SrcOver;
use pix::rgb::Rgba8p;
use pix::Raster;

let mut r0 = Raster::with_clear(100, 100);
let r1 = Raster::with_color(5, 5, Rgba8p::new(80, 0, 80, 200));
// ... load image data
r0.composite_raster((40, 40), &r1, (), SrcOver);

Trait Implementations

source

impl<P: Clone + Pixel> Clone for Raster

source

fn clone(&self) -> Raster

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<P: Pixel> From<Raster> for Box<[P]>

source

fn from(raster: Raster) -> Self

Get internal pixel data as boxed slice.

source

impl<P: Pixel> From<Raster> for Vec

source

fn from(raster: Raster) -> Self

Get internal pixel data as Vec of pixels.

source

impl From<Raster> for Box<[u8 ]> where
P: Pixel<Chan = Ch8>,

source

fn from(raster: Raster) -> Self

Get internal pixel data as boxed slice of u8.

source

impl From<Raster> for Box<[u16 ]> where
P: Pixel<Chan = Ch16>,

source

fn from(raster: Raster) -> Self

Get internal pixel data as boxed slice of u16.

Auto Trait Implementations

impl RefUnwindSafe for Raster where
P: RefUnwindSafe,

impl Send for Raster where
P: Send,

impl Sync for Raster where
P: Sync,

impl Unpin for Raster

impl UnwindSafe for Raster where
P: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct pix::Raster

Implementations

impl<P: Pixel> Raster<P>

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

pub fn with_color(width: u32, height: u32, clr: P) -> Self

pub fn with_raster<S>(src: &Raster<S>) -> Self where S: Pixel, P::Chan: From<S::Chan>,

pub fn with_pixels<B>(width: u32, height: u32, pixels: B) -> Self where B: Into<Box<[P]>>,

pub fn with_u8_buffer<B>(width: u32, height: u32, buffer: B) -> Self where B: Into<Box<[u8]>>, P: Pixel<Chan = Ch8>,

pub fn with_u16_buffer<B>(width: u32, height: u32, buffer: B) -> Self where B: Into<Box<[u16]>>, P: Pixel<Chan = Ch16>,

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn clear(&mut self)

pub fn pixel(&self, x: i32, y: i32) -> P

pub fn pixel_mut(&mut self, x: i32, y: i32) -> &mut P

pub fn pixels(&self) -> &[P]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn pixels_mut(&mut self) -> &mut [P]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn rows<R>(&self, reg: R) -> Rows<'_, P>ⓘNotable traits for Rows<'a, P>impl<'a, P: Pixel> Iterator for Rows<'a, P> type Item = &'a [P]; where R: Into<Region>,

pub fn rows_mut<R>(&mut self, reg: R) -> RowsMut<'_, P>ⓘNotable traits for RowsMut<'a, P>impl<'a, P: Pixel> Iterator for RowsMut<'a, P> type Item = &'a mut [P]; where R: Into<Region>,

pub fn region(&self) -> Region

pub fn intersection<R>(&self, reg: R) -> Region where R: Into<Region>,

pub fn copy_color<R>(&mut self, reg: R, clr: P) where R: Into<Region>,

pub fn copy_raster<R0, R1>(&mut self, to: R0, src: &Raster<P>, from: R1) where R0: Into<Region>, R1: Into<Region>,

pub fn as_u8_slice(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn as_u8_slice_mut(&mut self) -> &mut [u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

impl<P> Raster<P> where P: Pixel<Alpha = Premultiplied, Gamma = Linear>,

pub fn composite_color<R, O>(&mut self, reg: R, clr: P, op: O) where R: Into<Region>, O: Blend,

pub fn composite_matte<R0, R1, M, O>( &mut self, to: R0, src: &Raster<M>, from: R1, clr: P, op: O) where R0: Into<Region>, R1: Into<Region>, M: Pixel<Chan = P::Chan, Model = Matte, Gamma = P::Gamma>, O: Blend,

pub fn composite_raster<R0, R1, O>( &mut self, to: R0, src: &Raster<P>, from: R1, op: O) where R0: Into<Region>, R1: Into<Region>, O: Blend,

Trait Implementations

impl<P: Clone + Pixel> Clone for Raster<P>

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

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

impl<P: Pixel> From<Raster<P>> for Box<[P]>

fn from(raster: Raster<P>) -> Self

impl<P: Pixel> From<Raster<P>> for Vec<P>

fn from(raster: Raster<P>) -> Self

impl<P> From<Raster<P>> for Box<[u8]> where P: Pixel<Chan = Ch8>,

fn from(raster: Raster<P>) -> Self

impl<P> From<Raster<P>> for Box<[u16]> where P: Pixel<Chan = Ch16>,

fn from(raster: Raster<P>) -> Self

Auto Trait Implementations

impl<P> RefUnwindSafe for Raster<P> where P: RefUnwindSafe,

impl<P> Send for Raster<P> where P: Send,

impl<P> Sync for Raster<P> where P: Sync,

impl<P> Unpin for Raster<P>

impl<P> UnwindSafe for Raster<P> where P: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn with_raster<S>(src: &Raster<S>) -> Self where
S: Pixel,
P::Chan: From<S::Chan>,

pub fn with_pixels<B>(width: u32, height: u32, pixels: B) -> Self where
B: Into<Box<[P]>>,

pub fn with_u8_buffer<B>(width: u32, height: u32, buffer: B) -> Self where
B: Into<Box<[u8 ]>>,
P: Pixel<Chan = Ch8>,

pub fn with_u16_buffer<B>(width: u32, height: u32, buffer: B) -> Self where
B: Into<Box<[u16 ]>>,
P: Pixel<Chan = Ch16>,

pub fn pixels(&self) -> &[P]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

pub fn pixels_mut(&mut self) -> &mut [P]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

pub fn rows<R>(&self, reg: R) -> Rows<'_, P>ⓘNotable traits for Rows<'a, P>`impl<'a, P: Pixel> Iterator for Rows<'a, P> type Item = &'a [P];` where
R: Into<Region>,

pub fn rows_mut<R>(&mut self, reg: R) -> RowsMut<'_, P>ⓘNotable traits for RowsMut<'a, P>`impl<'a, P: Pixel> Iterator for RowsMut<'a, P> type Item = &'a mut [P];` where
R: Into<Region>,

pub fn intersection<R>(&self, reg: R) -> Region where
R: Into<Region>,

pub fn copy_color<R>(&mut self, reg: R, clr: P) where
R: Into<Region>,

pub fn copy_raster<R0, R1>(&mut self, to: R0, src: &Raster<P>, from: R1) where
R0: Into<Region>,
R1: Into<Region>,

pub fn as_u8_slice(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

pub fn as_u8_slice_mut(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

impl<P> Raster<P> where
P: Pixel<Alpha = Premultiplied, Gamma = Linear>,

pub fn composite_color<R, O>(&mut self, reg: R, clr: P, op: O) where
R: Into<Region>,
O: Blend,

pub fn composite_matte<R0, R1, M, O>(
&mut self,
to: R0,
src: &Raster<M>,
from: R1,
clr: P,
op: O
) where
R0: Into<Region>,
R1: Into<Region>,
M: Pixel<Chan = P::Chan, Model = Matte, Gamma = P::Gamma>,
O: Blend,

pub fn composite_raster<R0, R1, O>(
&mut self,
to: R0,
src: &Raster<P>,
from: R1,
op: O
) where
R0: Into<Region>,
R1: Into<Region>,
O: Blend,

impl<P> From<Raster<P>> for Box<[u8 ]> where
P: Pixel<Chan = Ch8>,

impl<P> From<Raster<P>> for Box<[u16 ]> where
P: Pixel<Chan = Ch16>,

impl<P> RefUnwindSafe for Raster<P> where
P: RefUnwindSafe,

impl<P> Send for Raster<P> where
P: Send,

impl<P> Sync for Raster<P> where
P: Sync,

impl<P> UnwindSafe for Raster<P> where
P: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,