Struct simple_frame::SimpleFrame

pub struct SimpleFrame<F> {
    pub width: u32,
    pub height: u32,
    pub stride: u32,
    pub fmt: PhantomData<F>,
    /* private fields */
}

Fields

width: u32

width in pixels

height: u32

height in pixels

stride: u32

number of bytes in an image row

fmt: PhantomData<F>

format of the data

Implementations

impl<F> SimpleFrame<F>

where F: PixelFormat,

pub fn new( width: u32, height: u32, stride: u32, image_data: Vec<u8> ) -> Option<Self>

Move a Vec<u8> buffer as the backing store for a SimpleFrame for image.

Returns None if the buffer is not large enough to store an image of the desired properties.

pub fn zeros(width: u32, height: u32, stride: u32) -> Option<Self>

Allocate minimium size buffer for image and fill with zeros

impl<F> SimpleFrame<F>

pub fn copy_from<FRAME: ImageStride<F>>(frame: &FRAME) -> SimpleFrame<F>

Trait Implementations

impl<F: Clone> Clone for SimpleFrame<F>

fn clone(&self) -> SimpleFrame<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Debug for SimpleFrame<F>

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

Formats the value using the given formatter.

impl<FRAME, FMT> From<Box<FRAME>> for SimpleFrame<FMT>

where FRAME: OwnedImageStride<FMT>, Vec<u8>: From<Box<FRAME>>,

fn from(frame: Box<FRAME>) -> SimpleFrame<FMT>

Converts to this type from the input type.

impl<F> From<SimpleFrame<F>> for Vec<u8>

fn from(orig: SimpleFrame<F>) -> Vec<u8>

Converts to this type from the input type.

impl<F> ImageData<F> for SimpleFrame<F>

fn width(&self) -> u32

Number of pixel columns in the image. Note: this is not the stride.

fn height(&self) -> u32

Number of pixel rows in the image.

fn buffer_ref(&self) -> ImageBufferRef<'_, F>

Returns the image buffer specified by pixel format F.

fn buffer(self) -> ImageBuffer<F>

Returns the image buffer specified by pixel format F.

fn image_data(&self) -> &[u8]

Returns the raw image data as specified by pixel format F.

impl<F> ImageMutData<F> for SimpleFrame<F>

fn buffer_mut_ref(&mut self) -> ImageBufferMutRef<'_, F>

Returns the image mutable buffer specified by pixel format F.

impl<F> Stride for SimpleFrame<F>

fn stride(&self) -> usize

the width (in bytes) of each row of image data