Skip to main content

Image

Struct Image 

Source
pub struct Image<T> { /* private fields */ }
Expand description

A 2D image buffer with a single channel.

Implementations§

Source§

impl<T: Clone + Default> Image<T>

Source

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

Creates a new image filled with the default value.

Source

pub fn from_vec(data: Vec<T>, width: usize, height: usize) -> Result<Self>

Creates a new image from existing data.

Source§

impl<T> Image<T>

Source

pub fn width(&self) -> usize

Returns the width of the image.

Source

pub fn height(&self) -> usize

Returns the height of the image.

Source

pub fn len(&self) -> usize

Returns the total number of pixels.

Source

pub fn is_empty(&self) -> bool

Returns true if the image has no pixels.

Source

pub fn get(&self, x: usize, y: usize) -> &T

Returns a reference to the pixel at (x, y).

Source

pub fn get_mut(&mut self, x: usize, y: usize) -> &mut T

Returns a mutable reference to the pixel at (x, y).

Source

pub fn row(&self, y: usize) -> &[T]

Returns a reference to a row.

Source

pub fn row_mut(&mut self, y: usize) -> &mut [T]

Returns a mutable reference to a row.

Source

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

Returns a reference to the underlying data.

Source

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

Returns a mutable reference to the underlying data.

Source

pub fn into_vec(self) -> Vec<T>

Consumes the image and returns the underlying data.

Trait Implementations§

Source§

impl<T: Clone> Clone for Image<T>

Source§

fn clone(&self) -> Image<T>

Returns a duplicate 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<T: Debug> Debug for Image<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Image<T>

§

impl<T> RefUnwindSafe for Image<T>
where T: RefUnwindSafe,

§

impl<T> Send for Image<T>
where T: Send,

§

impl<T> Sync for Image<T>
where T: Sync,

§

impl<T> Unpin for Image<T>
where T: Unpin,

§

impl<T> UnwindSafe for Image<T>
where T: 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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

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<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.