Struct ImageSource

pub struct ImageSource {
    pub image: DynamicImage,
    pub desired: Rect,
    pub hash: u64,
    pub background_color: Rgba<u8>,
}

Image source for crate::protocol::StatefulProtocols

A [StatefulProtocol] needs to resize the ImageSource to its state when the available area changes. A [Protocol] only needs it once.

Examples

use image::{DynamicImage, ImageBuffer, Rgb};
use ratatui_image::ImageSource;

let image: ImageBuffer::from_pixel(300, 200, Rgb::<u8>([255, 0, 0])).into();
let source = ImageSource::new(image, "filename.png", (7, 14));
assert_eq!((43, 14), (source.rect.width, source.rect.height));

Fields

image: DynamicImage

The original image without resizing.

desired: Rect

The area that the ImageSource::image covers, but not necessarily fills.

hash: u64

TODO: document this; when image changes but it doesn’t need a resize, force a render.

background_color: Rgba<u8>

The background color that should be used for padding or background when resizing.

Implementations

impl ImageSource

pub fn new( image: DynamicImage, font_size: FontSize, background_color: Rgba<u8>, ) -> ImageSource

Create a new image source

pub fn round_pixel_size_to_cells( img_width: u32, img_height: u32, (char_width, char_height): FontSize, ) -> Rect

Round an image pixel size to the nearest matching cell size, given a font size.

Trait Implementations

impl Clone for ImageSource

fn clone(&self) -> ImageSource

Returns a copy of the value.

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

Performs copy-assignment from source.