Struct OImage

pub struct OImage<FMT: PixelFormat> { /* private fields */ }

An owned image buffer with strided pixel format FMT.

Implementations

impl<FMT: PixelFormat> OImage<FMT>

pub fn new(width: u32, height: u32, stride: usize, buf: Vec<u8>) -> Option<Self>

Move a Vec<u8> buffer as the backing store for an ImageStruct for image.

Returns None if the buffer is not large enough to store an image of the desired properties.

pub fn zeros(width: u32, height: u32, stride: usize) -> Option<Self>

Allocate minimum size buffer for image and fill with zeros

pub fn from_owned(orig: impl OwnedImageStride<FMT>) -> Self

impl<F: PixelFormat> OImage<F>

pub fn copy_from<FRAME: ImageStride<F>>(frame: &FRAME) -> OImage<F>

Trait Implementations

impl<FMT: Clone + PixelFormat> Clone for OImage<FMT>

fn clone(&self) -> OImage<FMT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: PixelFormat> Debug for OImage<F>

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

Formats the value using the given formatter.

impl<'a, F: PixelFormat> From<OImage<F>> for CowImage<'a, F>

fn from(frame: OImage<F>) -> CowImage<'a, F>

Creates a CowImage::Owned from an OImage.

Examples

let owned_image = OImage::<Mono8>::new(20, 15, 20, vec![128u8; 300]).unwrap();
let cow_image = CowImage::from(owned_image);

impl<F: PixelFormat> From<OImage<F>> for Vec<u8>

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

Converts to this type from the input type.

impl<FMT: PixelFormat> ImageData<FMT> for OImage<FMT>

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<'_, FMT>

Returns the image buffer specified by pixel format F.

fn buffer(self) -> ImageBuffer<FMT>

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<FMT: PixelFormat> ImageMutData<FMT> for OImage<FMT>

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

Returns the image mutable buffer specified by pixel format F.

impl<FMT: PixelFormat> Stride for OImage<FMT>

fn stride(&self) -> usize

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