Enum ScalingMode 

pub enum ScalingMode {
    Exact,
    Fit,
    Cover,
    Contain,
}

Variants

Exact

Scale to an exact size.

If both dimensions are given, aspect ratio is ignored. If at most a single dimension is given, aspect ratio is kept.

Example

use aspect_ratio::{Size, Bounds};
assert_eq!(
    Size::new(200, 200).scale(Bounds::exact().w(300).h(600)).unwrap(),
    Size::new(300, 600)
);

assert_eq!(
    Size::new(200, 100).scale(Bounds::exact().h(150)).unwrap(),
    Size::new(200, 150)
);

Fit

Fit to wxh while keeping aspect ratio, scaling up or down as required.

If at most one dimension is given, the larger image dimension is scaled to fit into min(w, h).

Example

use aspect_ratio::{Size, Bounds};
assert_eq!(
    Size::new(200, 200).scale(Bounds::fit().w(400).h(100)).unwrap(),
    Size::new(100, 100)
);

Cover

Fit to cover (w, h) while keeping aspect ratio.

If at most one dimension is given, the smallest dimension is scaled up to cover min(w, h).

Example

use aspect_ratio::{Size, Bounds};
assert_eq!(
    Size::new(200, 200).scale(Bounds::cover().w(400).h(100)).unwrap(),
    Size::new(400, 400)
);

Contain

Scale to be contained while keeping aspect ratio, only scaling down.

Example

use aspect_ratio::{Size, Bounds};
assert_eq!(
    Size::new(200, 200).scale(Bounds::contain().w(400).h(400)).unwrap(),
    Size::new(200, 200)
);

Implementations

impl ScalingMode

pub fn iter() -> <Self as IntoEnumIterator>::Iterator

Trait Implementations

impl Clone for ScalingMode

fn clone(&self) -> ScalingMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScalingMode

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

Formats the value using the given formatter.

impl Default for ScalingMode

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ScalingMode

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

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 IntoEnumIterator for ScalingMode

type Iterator = ScalingModeIter

fn iter() -> ScalingModeIter

impl Ord for ScalingMode

fn cmp(&self, other: &ScalingMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ScalingMode

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for ScalingMode

impl Eq for ScalingMode

impl StructuralPartialEq for ScalingMode