Enum basic_frame::DynamicFrame

pub enum DynamicFrame {
    Mono8(BasicFrame<Mono8>),
    Mono32f(BasicFrame<Mono32f>),
    RGB8(BasicFrame<RGB8>),
    BayerRG8(BasicFrame<BayerRG8>),
    BayerRG32f(BasicFrame<BayerRG32f>),
    BayerGB8(BasicFrame<BayerGB8>),
    BayerGB32f(BasicFrame<BayerGB32f>),
    BayerGR8(BasicFrame<BayerGR8>),
    BayerGR32f(BasicFrame<BayerGR32f>),
    BayerBG8(BasicFrame<BayerBG8>),
    BayerBG32f(BasicFrame<BayerBG32f>),
    YUV444(BasicFrame<YUV444>),
    YUV422(BasicFrame<YUV422>),
    NV12(BasicFrame<NV12>),
}

An image whose pixel format is known only at runtime.

When reading an image from disk, for example, its pixel format is not known in advance. This enum represents the different possible formats as different variants.

Note that we do not implement ImageData<FMT> trait because the pixel format (parameterized by FMT) is not known at compile-time for DynamicFrame.

Variants

Mono8(BasicFrame<Mono8>)

Mono32f(BasicFrame<Mono32f>)

RGB8(BasicFrame<RGB8>)

BayerRG8(BasicFrame<BayerRG8>)

BayerRG32f(BasicFrame<BayerRG32f>)

BayerGB8(BasicFrame<BayerGB8>)

BayerGB32f(BasicFrame<BayerGB32f>)

BayerGR8(BasicFrame<BayerGR8>)

BayerGR32f(BasicFrame<BayerGR32f>)

BayerBG8(BasicFrame<BayerBG8>)

BayerBG32f(BasicFrame<BayerBG32f>)

YUV444(BasicFrame<YUV444>)

YUV422(BasicFrame<YUV422>)

NV12(BasicFrame<NV12>)

Implementations

impl DynamicFrame

pub fn new( width: u32, height: u32, stride: u32, extra: Box<dyn HostTimeData>, image_data: Vec<u8>, pixel_format: PixFmt ) -> DynamicFrame

pub fn copy_from<FMT: PixelFormat>(frame: &dyn ImageStrideTime<FMT>) -> Self

pub fn from<FRAME, FMT>(frame: FRAME) -> Self

where FRAME: ImageStrideTime<FMT> + Into<Vec<u8>>, FMT: PixelFormat,

impl DynamicFrame

pub fn as_basic<FMT>(self) -> Option<BasicFrame<FMT>>

where FMT: PixelFormat,

Return the image as a BasicFrame of the given pixel format.

This is done by moving the data. No copy is made.

If the image is a different pixel format than requested, None will be returned.

To convert the image data if necessary, use Self::into_pixel_format.

pub fn into_pixel_format<FMT>(self) -> Result<BasicFrame<FMT>, Error>

where FMT: PixelFormat,

Return the image as a BasicFrame converting the data to the requested pixel format as necessary.

To avoid converting the data, use Self::as_basic.

pub fn pixel_format(&self) -> PixFmt

pub fn force_pixel_format(self, pixfmt: PixFmt) -> DynamicFrame

Force the frame into a new pixel format without altering the data.

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn image_data_without_format(&self) -> &[u8]

Get a view of the image data.

Note that this discards any type information about the pixel format.

pub fn into_data_extra(self) -> (Vec<u8>, Box<dyn HostTimeData>)

Trait Implementations

impl Clone for DynamicFrame

fn clone(&self) -> DynamicFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicFrame

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

Formats the value using the given formatter.

impl ExtraTimeData for DynamicFrame

fn extra(&self) -> &dyn HostTimeData

impl From<DynamicFrame> for Vec<u8>

fn from(orig: DynamicFrame) -> Self

Converts to this type from the input type.

impl PartialEq for DynamicFrame

fn eq(&self, other: &DynamicFrame) -> 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 Stride for DynamicFrame

fn stride(&self) -> usize

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

impl StructuralPartialEq for DynamicFrame