Skip to main content

Frame

Struct Frame 

Source
pub struct Frame<'a> {
    pub geometry: Geometry,
    pub timestamp: Micros,
    pub sequence: u32,
    pub planes: Planes<'a>,
}
Expand description

A borrowed frame: geometry, capture timestamp, sequence and pixel views.

Fields§

§geometry: Geometry

Width, height, format.

§timestamp: Micros

Capture instant on the device’s monotonic clock.

§sequence: u32

Wrapping capture counter from the source; gaps mean drops.

§planes: Planes<'a>

The pixels.

Implementations§

Source§

impl<'a> Frame<'a>

Source

pub fn packed( geometry: Geometry, timestamp: Micros, sequence: u32, data: &'a [u8], ) -> Result<Frame<'a>, Error>

A packed or coded frame over data.

For uncompressed formats data must hold at least Geometry::byte_len bytes. For JPEG it must be non-empty and start with the SOI marker FF D8.

Source

pub fn yuv420p( geometry: Geometry, timestamp: Micros, sequence: u32, y: (&'a [u8], usize), u: (&'a [u8], usize), v: (&'a [u8], usize), ) -> Result<Frame<'a>, Error>

A planar 4:2:0 frame over three caller-owned planes.

Source

pub fn coded(&self) -> Option<&'a [u8]>

The coded bytes of a compressed frame, or None for raw pixels.

Source

pub fn byte_len(&self) -> usize

Total bytes referenced by this frame’s views.

Trait Implementations§

Source§

impl<'a> Clone for Frame<'a>

Source§

fn clone(&self) -> Frame<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for Frame<'a>

Source§

impl<'a> Debug for Frame<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Frame<'a>

§

impl<'a> RefUnwindSafe for Frame<'a>

§

impl<'a> Send for Frame<'a>

§

impl<'a> Sync for Frame<'a>

§

impl<'a> Unpin for Frame<'a>

§

impl<'a> UnsafeUnpin for Frame<'a>

§

impl<'a> UnwindSafe for Frame<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.