Struct Dimensions 

pub struct Dimensions {
    pub width: u32,
    pub height: u32,
}

Width and height of an image, in pixels.

Fields

width: u32

Image width in pixels.

height: u32

Image height in pixels.

Implementations

impl Dimensions

pub fn new(width: u32, height: u32) -> Result<Dimensions, Error>

Creates dimensions, rejecting a zero width or height.

The fields stay public for ergonomic struct literals; this constructor is the validated path that buffer types (crate::ImageRef) and codecs use so an empty image is caught once, at the boundary, rather than re-checked in every encoder.

Errors

Returns Error::InvalidInput if either dimension is zero.

pub fn num_pixels(self) -> Option<usize>

The pixel count width * height, or None if it overflows usize.

pub fn sample_count(self, channels: usize) -> Option<usize>

The sample count for an interleaved buffer of channels samples per pixel (width * height * channels), or None on overflow. The length an crate::ImageRef validates against.

pub fn is_empty(self) -> bool

Whether either dimension is zero.

Trait Implementations

impl Clone for Dimensions

fn clone(&self) -> Dimensions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Dimensions

impl Debug for Dimensions

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

Formats the value using the given formatter.

impl Eq for Dimensions

impl Hash for Dimensions

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 for Dimensions

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