Struct ffimage::packed::image::generic::GenericBuffer

pub struct GenericBuffer<T: Pixel> { /* fields omitted */ }

Implementations

impl<T: Pixel> GenericBuffer<T>

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

Returns an image buffer with pixel accessors

The backing memory is allocated by this struct. There is no padding added so only the minimum amount of memory is consumed. In contrast to flat image buffers, fat buffer structs own their data and can safely be moved between threads.

Arguments

• width - Width in pixels
• height - Height in pixels

Example

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

let mut buf = GenericImageBuffer::<Rgb<u8>>::new(3, 3);
let pix = Rgb::<u8>::new([255, 255, 255]);
buf.set_pixel(0, 0, &pix).unwrap();

pub fn from_raw(width: u32, height: u32, raw: Vec<T::T>) -> Option<Self>

Returns an image buffer with pixel accessors

The pixel memory is copied into an allocated buffer owned by this struct.

Arguments

• width - Width in pixels
• height - Height in pixels
• raw - Pixel memory storage owned by the instance

Example

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

let mut mem = vec![0; 3];
let mut buf = GenericImageBuffer::<Rgb<u8>>::from_raw(1, 1, mem)
    .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<T: Pixel> AccessPixel for GenericBuffer<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<T: Pixel> AccessPixelMut for GenericBuffer<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> From<&'_ GenericFlatBuffer<'a, T>> for GenericBuffer<T>

fn from(view: &GenericFlatBuffer<'a, T>) -> Self

Performs the conversion.

impl<'a, '_, T: Pixel> From<&'_ GenericView<'a, T>> for GenericBuffer<T>

fn from(view: &GenericView<'a, T>) -> Self

Performs the conversion.

impl<T: Pixel> ImageBuffer for GenericBuffer<T>

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

Sets the pixel values at the specified coordinates

impl<T: Pixel> ImageView for GenericBuffer<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<T: Pixel> Into<Vec<<T as Pixel>::T>> for GenericBuffer<T>

fn into(self) -> Vec<T::T>

Performs the conversion.

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

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = PixelIter<'a, GenericBuffer<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 GenericBuffer<T>

type Item = &'a mut T

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, SP, DP> TryConvert<GenericBuffer<DP>> for GenericView<'a, SP> where
    SP: Pixel,
    DP: Pixel,
    SP: TryConvertSlice<DP>, 

type Error = ()

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

Converts the buffer into another, possibly with a different format

impl<'a, SP, DP> TryConvert<GenericBuffer<DP>> for GenericFlatBuffer<'a, SP> where
    SP: Pixel,
    DP: Pixel,
    SP: TryConvertSlice<DP>, 

type Error = ()

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

Converts the buffer into another, possibly with a different format

impl<SP, DP> TryConvert<GenericBuffer<DP>> for GenericBuffer<SP> where
    SP: Pixel,
    DP: Pixel,
    SP: TryConvertSlice<DP>, 

type Error = ()

fn try_convert(&self, output: &mut GenericBuffer<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