Struct FrameDimensions

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

The dimensions of a frame.

Fields

width: u32

The width of the frame.

height: u32

The height of the frame.

Implementations

impl FrameDimensions

Extensions to FrameDimensions for computing thumbnail dimensions.

pub fn thumbnail_max_dimensions(scale_factor: i32) -> Self

Get the maximum dimensions for a thumbnail with the given scale factor.

fn with_texture(texture: &Texture) -> Option<Self>

Construct a FrameDimensions for the given texture.

pub(super) fn needs_thumbnail( self, thumbnail_dimensions: FrameDimensions, ) -> bool

Whether we should generate or request a thumbnail for these dimensions, given the wanted thumbnail dimensions.

pub(super) fn downscale_for( self, max_dimensions: FrameDimensions, ) -> Option<Self>

Downscale these dimensions to fit into the given maximum dimensions while preserving the aspect ratio.

Returns None if these dimensions are smaller than the maximum dimensions.

fn to_image_loader_request(self, requested: Self) -> FrameRequest

Convert these dimensions to a request for the image loader with the requested dimensions.

impl FrameDimensions

pub(crate) fn from_options( width: Option<UInt>, height: Option<UInt>, ) -> Option<Self>

Construct a FrameDimensions from the given optional dimensions.

pub(crate) fn dimension_for_orientation(self, orientation: Orientation) -> u32

Get the dimension for the given orientation.

pub(crate) fn dimension_for_other_orientation( self, orientation: Orientation, ) -> u32

Get the dimension for the other orientation than the given one.

pub(crate) fn ge(self, other: Self) -> bool

Whether these dimensions are greater than or equal to the given dimensions.

Returns true if either width or height is bigger than or equal to the one in the other dimensions.

pub(crate) const fn increase_by(self, value: u32) -> Self

Increase both of these dimensions by the given value.

pub(crate) const fn scale(self, factor: u32) -> Self

Scale these dimensions with the given factor.

pub(crate) fn scale_to_fit( self, requested: Self, content_fit: ContentFit, ) -> Self

Scale these dimensions to fit into the requested dimensions while preserving the aspect ratio and respecting the given content fit.

Trait Implementations

impl Clone for FrameDimensions

fn clone(&self) -> FrameDimensions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameDimensions

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

Formats the value using the given formatter.

impl PartialEq for FrameDimensions

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

impl Eq for FrameDimensions

impl StructuralPartialEq for FrameDimensions