Struct basic_frame::BasicFrame

pub struct BasicFrame<F> {
    pub width: u32,
    pub height: u32,
    pub stride: u32,
    pub image_data: Vec<u8>,
    pub pixel_format: PhantomData<F>,
    pub extra: Box<dyn HostTimeData>,
}

Image data with a statically typed, strided pixel format.

Fields

width: u32

width in pixels

height: u32

height in pixels

stride: u32

number of bytes in an image row

image_data: Vec<u8>

raw image data

pixel_format: PhantomData<F>

pixel format

extra: Box<dyn HostTimeData>

Additional data, including timestamp information.

Implementations

impl<F> BasicFrame<F>

pub fn copy_from(frame: &dyn ImageStrideTime<F>) -> BasicFrame<F>

Trait Implementations

impl<F: Clone> Clone for BasicFrame<F>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> ExtraTimeData for BasicFrame<F>

fn extra(&self) -> &dyn HostTimeData

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

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

Converts to this type from the input type.

impl<F> ImageData<F> for BasicFrame<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 BasicFrame<F>

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

Returns the image mutable buffer specified by pixel format F.

impl<F> PartialEq for BasicFrame<F>

where F: PixelFormat,

fn eq(&self, other: &BasicFrame<F>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F> Stride for BasicFrame<F>

fn stride(&self) -> usize

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