Enum SizeHint

pub enum SizeHint {
    Scale(OrderedFloat<f32>),
    Width(u32),
    Height(u32),
    Size {
        width: u32,
        height: u32,
        maintain_aspect_ratio: bool,
    },
}

Given as a hint for image loading requests.

Used mostly for rendering SVG:s to a good size. The SizeHint determines at what resolution the image should be rasterized.

Variants

Scale(OrderedFloat<f32>)

Scale original size by some factor, keeping the original aspect ratio.

The original size of the image is usually its texel resolution, but for an SVG it’s the point size of the SVG.

For instance, setting Scale(2.0) will rasterize SVG:s to twice their original size, which is useful for high-DPI displays.

Width(u32)

Scale to exactly this pixel width, keeping the original aspect ratio.

Height(u32)

Scale to exactly this pixel height, keeping the original aspect ratio.

Size

Scale to this pixel size.

Fields

width: u32

height: u32

maintain_aspect_ratio: bool

If true, the image will be as large as possible while still fitting within the given width/height.

Implementations

impl SizeHint

pub fn scale_by(self, factor: f32) -> Self

Multiply size hint by a factor.

Trait Implementations

impl Clone for SizeHint

fn clone(&self) -> SizeHint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SizeHint

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

Formats the value using the given formatter.

impl Default for SizeHint

fn default() -> Self

Returns the “default value” for a type.

impl Hash for SizeHint

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 Ord for SizeHint

fn cmp(&self, other: &SizeHint) -> 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 SizeHint

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

fn partial_cmp(&self, other: &SizeHint) -> 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 SizeHint

impl Eq for SizeHint

impl StructuralPartialEq for SizeHint