Enum Resize

pub enum Resize {
    Fit(Option<FilterType>),
    Crop(Option<CropOptions>),
    Scale(Option<FilterType>),
}

Resize method

Variants

Fit(Option<FilterType>)

Fit to area.

If the width or height is smaller than the area, the image will be resized maintaining proportions.

The FilterType (re-exported from the image crate) defaults to FilterType::Nearest.

Crop(Option<CropOptions>)

Crop to area.

If the width or height is smaller than the area, the image will be cropped. The behaviour is the same as using Image widget with the overhead of resizing, but some terminals might misbehave when overdrawing characters over graphics. For example, the sixel branch of Alacritty never draws text over a cell that is currently being rendered by some sixel sequence, not necessarily originating from the same cell.

The CropOptions defaults to clipping the bottom and the right sides.

Scale(Option<FilterType>)

Scale the image

Same as Resize::Fit except it resizes the image even if the image is smaller than the render area

Implementations

impl Resize

pub fn needs_resize( &self, image: &ImageSource, font_size: FontSize, current: Rect, area: Rect, force: bool, ) -> Option<Rect>

Check if ImageSource’s “desired” fits into area and is different than current.

The returned Rect is the area the image needs to be resized to, depending on the resize type.

pub fn render_area( &self, image: &ImageSource, font_size: FontSize, available: Rect, ) -> Rect

Trait Implementations

impl Clone for Resize

fn clone(&self) -> Resize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Resize

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

Formats the value using the given formatter.

impl Default for Resize

fn default() -> Self

Returns the “default value” for a type.