Struct FrameFormat 

pub struct FrameFormat { /* private fields */ }

The format defining all images in a SER file.

Only one format per SER file is supported. All images must have the same width, height, bytes per pixel, etc.

Once a format is defined, SER frames may be converted to/from image::DynamicImages. Furthermore, a FrameFormat may be computed from an existing DynamicImage using TryFrom.

Implementations

impl FrameFormat

pub fn color(&self) -> &ColorId

pub fn depth(&self) -> &PixelDepth

pub fn endian(&self) -> &PixelEndian

pub fn width(&self) -> &u32

pub fn height(&self) -> &u32

impl FrameFormat

pub fn set_color(&mut self, val: ColorId) -> &mut Self

pub fn set_depth(&mut self, val: PixelDepth) -> &mut Self

pub fn set_endian(&mut self, val: PixelEndian) -> &mut Self

pub fn set_width(&mut self, val: u32) -> &mut Self

pub fn set_height(&mut self, val: u32) -> &mut Self

impl FrameFormat

pub fn new( color: ColorId, depth: PixelDepth, endian: PixelEndian, width: u32, height: u32, ) -> Self

pub fn raw_len(&self) -> usize

pub fn try_into_frame(&self, img: DynamicImage) -> Result<Frame, &'static str>

Attempt to convert a DynamicImage into a Frame that is compatible with this FrameFormat.

Trait Implementations

impl Clone for FrameFormat

fn clone(&self) -> FrameFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<FrameFormat> for Ser

fn from(value: FrameFormat) -> Self

Converts to this type from the input type.

impl PartialEq<Frame> for FrameFormat

fn eq(&self, frame: &Frame) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&DynamicImage> for FrameFormat

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &DynamicImage) -> Result<FrameFormat, Self::Error>

Performs the conversion.