Struct DynamicFrameOwned 

pub struct DynamicFrameOwned { /* private fields */ }

An owned version of DynamicFrame that contains its own buffer.

Implementations

impl DynamicFrameOwned

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

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

Return a new DynamicFrameOwned from a statically typed frame. This moves the input data.

pub fn from_static_ref<FMT: PixelFormat>(frame: &dyn ImageStride<FMT>) -> Self

Return a new DynamicFrameOwned from a reference to a statically typed frame. This copies the input data.

pub fn from_buf( w: u32, h: u32, stride: usize, buf: Vec<u8>, pixfmt: PixFmt, ) -> Option<Self>

Creates a new DynamicFrameOwned from raw image data.

This function moves the provided buffer into the new frame without copying. The buffer size must be appropriate for the given dimensions and pixel format.

Parameters

• w - Image width in pixels
• h - Image height in pixels
• s - Row stride in bytes (must be >= width * bytes_per_pixel)
• buf - Raw image data buffer
• pixfmt - Pixel format of the image data

Returns

• Some(DynamicFrameOwned) if the buffer is valid for the given parameters
• None if the buffer is too small.

pub fn borrow(&self) -> DynamicFrame<'_>

Return a borrowed view of this frame as a DynamicFrame.

pub fn roi( self, left: u32, top: u32, width: u32, height: u32, ) -> Option<DynamicFrameOwned>

Moves data into a new DynamicFrameOwned containing a region of interest (ROI) within the image without copying.

The ROI is defined by the specified left, top, width, and height parameters. If the specified ROI is out of bounds or the buffer is too small, this method returns None.

Parameters

• left - The left coordinate of the ROI in pixels
• top - The top coordinate of the ROI in pixels
• width - The width of the ROI in pixels
• height - The height of the ROI in pixels

Returns

• Some(DynamicFrameOwned) if the ROI is valid and the buffer is large enough
• None if the ROI is out of bounds or the buffer is too small

To create a view with a ROI, use [Self::borrow().roi()].

pub fn as_static<FMT: PixelFormat>(self) -> Option<OImage<FMT>>

Moves the DynamicFrameOwned into a static pixel format.

If the requested pixel format matches the current format, this method returns an formats::owned::OImage that owns the data without copying. Otherwise, it returns None since the data cannot be moved to a static format.

To convert to a static format when the target format may not match the current format, use Self::into_pixel_format<FMT>() (requires the convert-image feature).

Type Parameters

• FMT - The target pixel format type

Returns

• Some(OImage<FMT>) - If the target format matches the current format, returns an owned image in the specified format
• None - If the target format does not match the current format

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

where FMT: PixelFormat,

Converts the image to the specified pixel format, returning an OImage that owns the data.

If the requested pixel format matches the current format, this method moves the data without copying. Otherwise, the data is converted and a new owned image is returned. In both cases, the original image data is consumed.

To move the data to a specified pixel format while excluding the possibility of converting the format in case the requested format does not match the current format, use Self::as_static<FMT>().

Type Parameters

• FMT - The target pixel format type

Returns

• Ok(OImage<FMT>) - If conversion is successful, returns an owned image in the specified format
• Err(convert_image::Error) - If conversion fails

Examples

let data = vec![64u8; 2000];
let frame = DynamicFrameOwned::from_buf(40, 50, 40, data, PixFmt::Mono8).unwrap();

// No conversion or copying needed - returns original data
let owned_image = frame.into_pixel_format::<Mono8>().unwrap();

pub fn width(&self) -> u32

Returns the width of the image in pixels.

Examples

let data = vec![0u8; 1500];
let frame = DynamicFrame::from_buf(50, 10, 150, data, PixFmt::RGB8).unwrap();
assert_eq!(frame.width(), 50);

pub fn height(&self) -> u32

Returns the height of the image in pixels.

Examples

let data = vec![0u8; 2000];
let frame = DynamicFrame::from_buf(40, 50, 40, data, PixFmt::Mono8).unwrap();
assert_eq!(frame.height(), 50);

Trait Implementations

impl Clone for DynamicFrameOwned

fn clone(&self) -> DynamicFrameOwned

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicFrameOwned

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

Formats the value using the given formatter.

impl Stride for DynamicFrameOwned

fn stride(&self) -> usize

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