Struct nokhwa::buffer::Buffer

pub struct Buffer { /* private fields */ }

A buffer returned by a camera to accommodate custom decoding. Contains information of Resolution, the buffer’s FrameFormat, and the buffer.

Note that decoding on the main thread will decrease your performance and lead to dropped frames.

Implementations

impl Buffer

pub fn new( res: Resolution, buf: &[u8], source_frame_format: FrameFormat ) -> Buffer

Creates a new buffer with a [&[u8]].

pub fn resolution(&self) -> Resolution

Get the Resolution of this buffer.

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

Get the data of this buffer.

pub fn buffer_bytes(&self) -> Bytes

Get a owned version of this buffer.

pub fn source_frame_format(&self) -> FrameFormat

Get the FrameFormat of this buffer.

pub fn decode_image<F>( &self ) -> Result<ImageBuffer<<F as FormatDecoder>::Output, Vec<u8, Global>>, NokhwaError>where F: FormatDecoder,

Decodes a image with allocation using the provided FormatDecoder.

Errors

Will error when the decoding fails.

pub fn decode_image_to_buffer<F>( &self, buffer: &mut [u8] ) -> Result<(), NokhwaError>where F: FormatDecoder,

Decodes a image with allocation using the provided FormatDecoder into a buffer.

Errors

Will error when the decoding fails, or the provided buffer is too small.

pub fn decode_opencv_mat<F>(&mut self) -> Result<Mat, NokhwaError>where F: FormatDecoder,

Available on crate feature opencv-mat only.

Decodes a image with allocation using the provided FormatDecoder into a Mat.

Note that this does a clone when creating the buffer, to decouple the lifetime of the internal data to the temporary Buffer. If you want to avoid this, please see decode_opencv_mat.

Errors

Will error when the decoding fails, or OpenCV failed to create/copy the Mat.

Safety

This function uses unsafe in order to create the Mat. Please see Mat::new_rows_cols_with_data for more.

Most notably, the data must stay in scope for the duration of the Mat or bad, bad things happen.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Hash for Buffer

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Buffer> for Buffer

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

fn partial_cmp(&self, other: &Buffer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Buffer

impl StructuralEq for Buffer

impl StructuralPartialEq for Buffer