Struct retro_pixel::VecImage

pub struct VecImage<P> { /* fields omitted */ }

An image backed by a Vec.

Not available in no_std, obviously.

Methods

impl<P> VecImage<P>

pub fn new(width: usize, height: usize) -> Self where     P: Default + Clone,

Creates a VecImage of the given dimensions with the default value in all positions.

pub fn from_vec(width: usize, height: usize, vec: Vec<P>) -> Self

Creates a VecImage from the given vector of pixels.

Trait Implementations

impl<P: Debug> Debug for VecImage<P>

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

Formats the value using the given formatter.

impl<P: Clone> Clone for VecImage<P>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: PartialEq> PartialEq for VecImage<P>

fn eq(&self, other: &VecImage<P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &VecImage<P>) -> bool

This method tests for !=.

impl<P: Eq> Eq for VecImage<P>

impl<P: PartialOrd> PartialOrd for VecImage<P>

fn partial_cmp(&self, other: &VecImage<P>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &VecImage<P>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &VecImage<P>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &VecImage<P>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &VecImage<P>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<P: Ord> Ord for VecImage<P>

fn cmp(&self, other: &VecImage<P>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<P: Hash> Hash for VecImage<P>

fn hash<__HP: Hasher>(&self, state: &mut __HP)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl<P> Index<(usize, usize)> for VecImage<P>

type Output = P

The returned type after indexing.

fn index(&self, (x, y): (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<P> ReadableImage<P> for VecImage<P>

fn width(&self) -> usize

Can't exceed isize::MAX

fn height(&self) -> usize

Can't exceed isize::MAX

fn pitch(&self) -> isize

Offset from the start of one row to the start of the next row.

fn as_ptr(&self) -> *const P

Raw const pointer to the data.

fn get(&self, loc: (usize, usize)) -> Option<&P>

Performs an optional indexing by reference, gives None for out of bounds.

fn slice(&self, r: Range<(usize, usize)>) -> ImageSlice<P>

Grabs out a sub-slice of the data.

Important traits for ImageRefIter<'a, P>

impl<'a, P: 'a> Iterator for ImageRefIter<'a, P> type Item = (usize, usize, &'a P);

fn iter(&self) -> ImageRefIter<P>

Lets you iterate any image by reference.

fn to_vecimage(&self) -> VecImage<P> where     Self: Sized,     P: Default + Clone,

This is like to_owned, you get your own version of the data.

fn upscale(&self, scale: usize) -> VecImage<P> where     P: Copy + Default,

Scales up into a new VecImage by the given amount.

impl<P> IndexMut<(usize, usize)> for VecImage<P>

fn index_mut(&mut self, (x, y): (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<P> WritableImage<P> for VecImage<P>

fn as_mut_ptr(&mut self) -> *mut P

Raw mut pointer to the data.

fn get_mut(&mut self, loc: (usize, usize)) -> Option<&mut P>

Performs an optional indexing by mut reference, gives None for out of bounds.

fn slice_mut(&mut self, r: Range<(usize, usize)>) -> ImageMutSlice<P>

Grabs out a mutable sub-slice of the data.

Important traits for ImageMutRefIter<'a, P>

impl<'a, P: 'a> Iterator for ImageMutRefIter<'a, P> type Item = (usize, usize, &'a mut P);

fn iter_mut(&mut self) -> ImageMutRefIter<P>

Lets you mutably iterate over any writable form of image.

fn set_all(&mut self, pixel: P) where     P: Clone,

Assigns all locations to be the given pixel value.

fn direct_copy<S>(&mut self, src: &S, offset: (isize, isize)) where     S: ReadableImage<P>,     P: Copy,

Directly copies the data from the source image into this image.

fn flip_vertical(&mut self)

Flips the image vertically.

fn flip_horizontal(&mut self)

Flips the image horizontally.

fn inplace_counterclockwise90_square(&mut self) -> Option<()>

Performs a 90 degrees counter-clockwise rotation, in place.

fn blit_generic<RI, F>(&mut self, src: &RI, offset: (isize, isize), op: F) where     RI: ReadableImage<P>,     F: FnMut(P, P) -> P,     P: Copy,

Modifies this image by overlaying the source image at the offset given.

impl WritableImageU16Ext for VecImage<u16>

fn blit_rgba16<RI>(&mut self, src: &RI, offset: (isize, isize)) where     RI: ReadableImage<u16>,

This copies the data from the source into the destination any time the source's alpha bit is set.

impl WritableImageU32Ext for VecImage<u32>

fn blit_blend_rectilinear<RI>(&mut self, src: &RI, offset: (isize, isize)) where     RI: ReadableImage<u32>,

Performs a rectilinear blending blit at an integral pixel offset.