Struct ffimage::packed::image::generic::GenericFlatBuffer

pub struct GenericFlatBuffer<'a, T: Pixel> { /* fields omitted */ }

Implementations

impl<'a, T: Pixel> GenericFlatBuffer<'a, T>

pub fn new(raw: &'a mut [T::T], width: u32, height: u32) -> Option<Self>

Returns a flat image buffer with pixel accessors

'Flat' means that the backing memory of the image is not allocated by the struct. Thus, this struct allows for reusing existing (mutable) buffers and still having images defined by their pixel types.

Arguments

• raw - Raw memory region
• width - Width in pixels
• height - Height in pixels

Example

use ffimage::color::rgb::*;
use ffimage::core::ImageBuffer;
use ffimage::packed::GenericImageFlatBuffer;

let mut mem = vec![0; 3];
let mut buf = GenericImageFlatBuffer::<Rgb<u8>>::new(&mut mem, 1, 1)
    .expect("Memory region too small");
let pix = Rgb::<u8>::new([255, 255, 255]);
buf.set_pixel(0, 0, &pix).unwrap();

pub fn raw(&self) -> &[T::T]

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

Trait Implementations

impl<'a, T: Pixel> AccessPixel for GenericFlatBuffer<'a, T>

type PixelType = T

fn pixel_row(&self, y: u32) -> Option<&[Self::PixelType]>

Returns the pixel row at the specified y offset

fn pixel(&self, x: u32, y: u32) -> Option<&Self::PixelType>

Returns the pixel at the specified coordinates

impl<'a, T: Pixel> AccessPixelMut for GenericFlatBuffer<'a, T>

type PixelType = T

fn pixel_row_mut(&mut self, y: u32) -> Option<&mut [Self::PixelType]>

Returns the pixel row at the specified y offset

fn pixel_mut(&mut self, x: u32, y: u32) -> Option<&mut Self::PixelType>

Returns the pixel at the specified coordinates

impl<'a, T: Pixel> CloneImage for GenericFlatBuffer<'a, T>

type Output = GenericBuffer<T>

fn clone_into(&self, output: &mut Self::Output)

Clone an image into an already existing buffer, avoiding reallocations if possible

fn clone(&self) -> Self::Output

Clone an image type (view or buffer) and return a buffer

impl<'a, SP, DP> Convert<GenericBuffer<DP>> for GenericFlatBuffer<'a, SP> where
    SP: Pixel,
    DP: Pixel,
    [SP]: TryConvertSlice<DP>, 

fn convert(&self, output: &mut GenericBuffer<DP>)

Converts the buffer into another, possibly with a different format

impl<'a, T: Pixel> ImageBuffer for GenericFlatBuffer<'a, T>

fn set_pixel(&mut self, x: u32, y: u32, pix: &Self::T) -> Result<(), ()>

Sets the pixel values at the specified coordinates

impl<'a, T: Pixel> ImageView for GenericFlatBuffer<'a, T>

type T = T

Pixel type

fn width(&self) -> u32

Width in pixels

fn height(&self) -> u32

Height in pixels

fn stride(&self) -> usize

Length of one pixel row in bytes

fn get_pixel(&self, x: u32, y: u32) -> Option<Self::T>

Returns the pixel at the specified coordinates

impl<'a, T: Pixel> IntoIterator for &'a GenericFlatBuffer<'a, T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = PixelIter<'a, GenericFlatBuffer<'a, T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: Pixel> IntoIterator for &'a mut GenericFlatBuffer<'a, T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = PixelIterMut<'a, GenericFlatBuffer<'a, T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, SP, DP> TryConvert<GenericFlatBuffer<'b, DP>> for GenericView<'a, SP> where
    SP: Pixel,
    DP: Pixel,
    [SP]: TryConvertSlice<DP>, 

type Error = ()

fn try_convert(
    &self,
    output: &mut GenericFlatBuffer<'b, DP>
) -> Result<(), Self::Error>

Converts the buffer into another, possibly with a different format

impl<'a, 'b, SP, DP> TryConvert<GenericFlatBuffer<'b, DP>> for GenericFlatBuffer<'a, SP> where
    SP: Pixel,
    DP: Pixel,
    [SP]: TryConvertSlice<DP>, 

type Error = ()

fn try_convert(
    &self,
    output: &mut GenericFlatBuffer<'b, DP>
) -> Result<(), Self::Error>

Converts the buffer into another, possibly with a different format

impl<'b, SP, DP> TryConvert<GenericFlatBuffer<'b, DP>> for GenericBuffer<SP> where
    SP: Pixel,
    DP: Pixel,
    [SP]: TryConvertSlice<DP>, 

type Error = ()

fn try_convert(
    &self,
    output: &mut GenericFlatBuffer<'b, DP>
) -> Result<(), Self::Error>

Converts the buffer into another, possibly with a different format